You are here: Start » Function Reference » Region Basics » CreateRingRegion

CreateRingRegion

Header:	FIL.h
Namespace:	fil

Creates a ring-shaped region with given parameters.

Syntax

void fil::CreateRingRegion
(
	const fil::Circle2D& inCircle,
	ftl::Optional<const fil::CoordinateSystem2D&> inCircleAlignment,
	float inRingWidth,
	fil::BorderPosition::Type inBorderPosition,
	int inFrameWidth,
	int inFrameHeight,
	fil::Region& outRegion,
	ftl::Optional<fil::Circle2D&> outAlignedCircle = ftl::NIL
)

Parameters

Name	Type	Range	Default	Description
inCircle	const Circle2D&			Input circle
inCircleAlignment	Optional<const CoordinateSystem2D&>		NIL	Adjusts the circle to the position of the inspected object
inRingWidth	float	0.0 -	1.0f
inBorderPosition	BorderPosition::Type		Centered
inFrameWidth	int	0 - 65535		Width of the created region's frame
inFrameHeight	int	0 - 65535		Height of the created region's frame
outRegion	Region&			Output region
outAlignedCircle	Optional<Circle2D&>		NIL	The input circle transformed to the absolute coordinate system

Optional Outputs

The computation of following outputs can be switched off by passing value ftl::NIL to these parameters: outAlignedCircle.

Errors

List of possible exceptions:

Error type	Description
DomainError	Incorrect BorderPosition in CreateRingRegion.