You are here: Start » AVL.NET » AVS.CreateRingRegion Method
AVS.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, AvlNet.Region outRegion, NullableValue<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. | ||
![]() | inRingWidth | float | <0.0f, INF> | 1.0f | Default value: 1.0f. |
![]() | inBorderPosition | AvlNet.BorderPosition | Centered | Default value: Centered. | |
![]() | inFrameWidth | int | <0, 65535> | Width of the created region's frame. | |
![]() | inFrameHeight | int | <0, 65535> | Height of the created region's frame. | |
![]() | outRegion | AvlNet.Region | Output region. | ||
![]() | outAlignedCircle | AvlNet.NullableValue<AvlNet.Circle2D> | The input circle transformed to the absolute coordinate system. Can be null to skip this parameter calculation. |
Function Overrides
- CreateRingRegion(Circle2D, Single, BorderPosition, Int32, Int32, Region)
- CreateRingRegion(Circle2D, Nullable<CoordinateSystem2D>, Single, BorderPosition, Int32, Int32, Region)
- CreateRingRegion(Circle2D, Nullable<CoordinateSystem2D>, Single, BorderPosition, Int32, Int32, Region, Circle2D)