Back to Adaptive Vision Library website

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

PathBoundingRectangle_OrNil


Header: AVL.h
Namespace: avl
Module: FoundationBasic

Computes the smallest rectangle containing a path; returns NIL when the path is empty.

Syntax

C++
C#
 
void avl::PathBoundingRectangle_OrNil
(
	const avl::Path& inPath,
	avl::BoundingRectangleFeature::Type inBoundingRectangleFeature,
	float inReferenceAngle,
	avl::RectangleOrientation::Type inRectangleOrientation,
	atl::Conditional<avl::Rectangle2D>& outBoundingRectangle,
	atl::Conditional<avl::Point2D>& outCenter,
	atl::Conditional<float>& outLongSide,
	atl::Conditional<float>& outShortSide
)

Parameters

Name Type Default Description
Input value
inPath const Path& Input path
Input value
inBoundingRectangleFeature BoundingRectangleFeature::Type MinimalArea Determines what kind of bounding rectangle will be computed
Input value
inReferenceAngle float 0.0f The middle angle of the valid range of the output rectangle's angle
Input value
inRectangleOrientation RectangleOrientation::Type Horizontal Orientation of the output rectangle
Output value
outBoundingRectangle Conditional<Rectangle2D>& Smallest bounding rectangle of the input path
Output value
outCenter Conditional<Point2D>& Center of the bounding rectangle
Output value
outLongSide Conditional<float>& Length of the bounding rectangle long side
Output value
outShortSide Conditional<float>& Length of the bounding rectangle short side