You are here: Start » AVL.NET » AVL.CreateRingRegion Method

AVL.CreateRingRegion Method

Creates a ring-shaped region with given parameters.

Namespace:AvlNet
Assembly:AVL.NET.dll

Syntax

public static void CreateRingRegion(
	AvlNet.Circle2D inCircle,
	float inRingWidth,
	AvlNet.BorderPosition inBorderPosition,
	int inFrameWidth,
	int inFrameHeight,
	out AvlNet.Region outRegion
)

Parameters

Name Type Range Default Description
inCircleAvlNet.Circle2DInput circle.
inRingWidthfloat<0.0f, INF>1.0fDefault value: 1.0f.
inBorderPositionAvlNet.BorderPositionCenteredDefault value: Centered.
inFrameWidthint<0, INF>Width of the created region's frame.
inFrameHeightint<0, INF>Height of the created region's frame.
outRegionAvlNet.RegionOutput region.

Errors

Error type Description
DomainError Incorrect BorderPosition in CreateRingRegion.

See also