Back to Aurora Vision Library website

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

CreateRingRegion


Header: AVL.h
Namespace: avl
Module: FoundationLite

Creates a ring-shaped region with given parameters.

Syntax

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

Parameters

Name Type Range Default Description
Input value inCircle const Circle2D& Input circle
Input value inCircleAlignment Optional<const CoordinateSystem2D&> NIL Adjusts the circle to the position of the inspected object
Input value inRingWidth float 0.0 - 1.0f
Input value inBorderPosition BorderPosition::Type Centered
Input value inFrameWidth int 0 - 65535 Width of the created region's frame
Input value inFrameHeight int 0 - 65535 Height of the created region's frame
Output value outRegion Region& Output region
Output value 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 atl::NIL to these parameters: outAlignedCircle.

Read more about Optional Outputs.

Errors

List of possible exceptions:

Error type Description
DomainError Incorrect BorderPosition in CreateRingRegion.