Start » Filter Reference » Region » Region Basics » CreateCircleRegion

CreateCircleRegion

Basic

Module: FoundationLite

Creates a circular region corresponding to a given circle.

Name Type Range Description
Input value
 inCircle Circle2D
Input value
 inCircleAlignment CoordinateSystem2D* Adjusts the circle to the position of the inspected object
Input value
 inFrameWidth Integer 0 - 65535 Width of the created region's frame (not to be confused with the size of the circle!)
Input value
 inFrameHeight Integer 0 - 65535 Height of the created region's frame (not to be confused with the size of the circle!)
Output value
 outRegion Region Output region
Output value
 outAlignedCircle Circle2D The input circle transformed to the absolute coordinate system

Description

The operation creates a region containing pixels lying inside the given circle.

The inFrameWidth and inFrameHeight parameters most often should be set equal to the dimensions of the image this region will be used with. If the input circle exceeds these dimensions, the output region will be cropped.

Hints

  • Remember to set inFrameWidth and inFrameHeight inputs to specify the region frame.

Examples

Description of usage of this filter can be found in examples and tutorial: Brick destroy (Game).

CreateCircleRegion run with inCircle = Circle2D(150,150,100).

Complexity Level

This filter is available on Basic Complexity Level.

See Also