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 | |
---|---|---|---|---|---|
inCircle | AvlNet.Circle2D | Input circle. | |||
inRingWidth | float | <0.0f, INF> | 1.0f | Default value: 1.0f. | |
inBorderPosition | AvlNet.BorderPosition | Centered | Default value: Centered. | ||
inFrameWidth | int | <0, INF> | Width of the created region's frame. | ||
inFrameHeight | int | <0, INF> | Height of the created region's frame. | ||
outRegion | AvlNet.Region | Output region. |
Errors
Error type | Description |
---|---|
DomainError | Incorrect BorderPosition in CreateRingRegion. |