Back to Aurora Vision Library website

You are here: Start » Function Reference » Path » Path Features » PathBoundingRectangle_FixedAngle

PathBoundingRectangle_FixedAngle


Header: AVL.h
Namespace: avl
Module: FoundationBasic

Computes the smallest rectangle with the given orientation angle containing a path.

Syntax

C++
C#
 
void avl::PathBoundingRectangle_FixedAngle
(
	const avl::Path& inPath,
	float inAngle,
	avl::Rectangle2D& outBoundingRectangle,
	atl::Optional<avl::Point2D&> outCenter = atl::NIL,
	atl::Optional<float&> outLongSide = atl::NIL,
	atl::Optional<float&> outShortSide = atl::NIL
)

Parameters

Name Type Default Description
Input value inPath const Path& Input path
Input value inAngle float Expected angle of the resulting rectangle
Output value outBoundingRectangle Rectangle2D& Smallest bounding rectangle of the input path
Output value outCenter Optional<Point2D&> NIL Center of the bounding rectangle
Output value outLongSide Optional<float&> NIL Length of the bounding rectangle long side
Output value outShortSide Optional<float&> NIL Length of the bounding rectangle short side

Optional Outputs

The computation of following outputs can be switched off by passing value atl::NIL to these parameters: outCenter, outLongSide, outShortSide.

Read more about Optional Outputs.

Errors

List of possible exceptions:

Error type Description
DomainError Empty path on input in PathBoundingRectangle_FixedAngle.