CreateRingRegion


Creates a ring-shaped region with given parameters.

Syntax

C++
Python
 
def CreateRingRegion(
	inCircle: Circle2D,
	inRingWidth: float,
	inBorderPosition: BorderPosition,
	inFrameWidth: int,
	inFrameHeight: int,
	outRegion: Region,
	/,
	*,
	inCircleAlignment: CoordinateSystem2D | None = None,
	outAlignedCircle: Circle2D | None = None
)
-> None

Parameters

Name Type Range Default Description
Input value inCircle Circle2D Input circle
Input value inCircleAlignment CoordinateSystem2D | None None Adjusts the circle to the position of the inspected object
Input value inRingWidth float 0.0 -
Input value inBorderPosition BorderPosition
Input value inFrameWidth int 0 - 65535 Width of the created region's frame
Input value inFrameHeight int 0 - 65535 Height of the created region's frame
Output value outRegion Region Output region
Output value outAlignedCircle Circle2D | None None The input circle transformed to the absolute coordinate system