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

FIL.CreateRingRegion

Creates a ring-shaped region with given parameters.

Namespace:FilNet
Assembly:FIL.NET.dll

Syntax

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

Parameters

Name Type Range Default Description
inCircleFilNet.Circle2DInput circle.
inCircleAlignmentFilNet.CoordinateSystem2D?Adjusts the circle to the position of the inspected object. Default value: ftl::NIL.
inRingWidthfloat<0.0f, INF>1.0fDefault value: 1.0f.
inBorderPositionFilNet.BorderPositionCenteredDefault value: Centered.
inFrameWidthint<0, 65535>Width of the created region's frame.
inFrameHeightint<0, 65535>Height of the created region's frame.
outRegionFilNet.RegionOutput region.
outAlignedCircleFilNet.NullableValue<FilNet.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