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,
AvlNet.CoordinateSystem2D? inCircleAlignment,
float inRingWidth,
AvlNet.BorderPosition inBorderPosition,
int inFrameWidth,
int inFrameHeight,
out AvlNet.Region outRegion,
out AvlNet.Circle2D outAlignedCircle
)
Parameters
|
Name |
Type |
Range |
Default |
Description |
 | inCircle | AvlNet.Circle2D | | | Input circle. |
| inCircleAlignment | AvlNet.CoordinateSystem2D? | | | Adjusts the circle to the position of the inspected object. Default value: atl::NIL, or null. |
| 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. |
| outAlignedCircle | AvlNet.Circle2D | | | The input circle transformed to the absolute coordinate system |
Errors
| Error type |
Description |
| DomainError |
Incorrect BorderPosition in CreateRingRegion. |
See also
