You are here: Start » AVL.NET » Function Reference » Region » Region Basics » AVL.CreateRingRegion

AVL.CreateRingRegion

Creates a ring-shaped region with given parameters.

Namespace:AvlNet
Assembly:AVL.NET.dll

Syntax

C++
C#
 
public static void CreateRingRegion
(
	AvlNet.Circle2D inCircle,
	AvlNet.CoordinateSystem2D? inCircleAlignment,
	float inRingWidth,
	AvlNet.BorderPosition inBorderPosition,
	int inFrameWidth,
	int inFrameHeight,
	AvlNet.Region outRegion,
	NullableValue<AvlNet.Circle2D> outAlignedCircle
)

Parameters

Name Type Range Default Description
inCircleAvlNet.Circle2DInput circle.
inCircleAlignmentAvlNet.CoordinateSystem2D?Adjusts the circle to the position of the inspected object. Default value: atl::NIL.
inRingWidthfloat<0.0f, INF>1.0fDefault value: 1.0f.
inBorderPositionAvlNet.BorderPositionCenteredDefault value: Centered.
inFrameWidthint<0, 65535>Width of the created region's frame.
inFrameHeightint<0, 65535>Height of the created region's frame.
outRegionAvlNet.RegionOutput region.
outAlignedCircleAvlNet.NullableValue<AvlNet.Circle2D>The input circle transformed to the absolute coordinate system. Can be null to skip this parameter calculation.

Errors

List of possible exceptions:

Error type Description
DomainError Incorrect BorderPosition in CreateRingRegion.

Function Overrides

See also