You are here: Start » Function Reference » Geometry 2D Features » PointsBoundingRectangle_Deprecated

PointsBoundingRectangle_Deprecated

Header:	AVL.h
Namespace:	avl

Computes the smallest rectangle containing an array of points.

Syntax

void avl::PointsBoundingRectangle_Deprecated
(
	const atl::Array<avl::Point2D>& inPoints,
	atl::Optional<float> inRectangleOrientation,
	avl::BoundingRectangleFeature::Type inBoundingRectangleFeature,
	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
inPoints	const Array<Point2D>&		Input array of points
inRectangleOrientation	Optional<float>	NIL	Expected orientation of the resulting rectangle
inBoundingRectangleFeature	BoundingRectangleFeature::Type	MinimalArea	Determines what kind of bounding rectangle will be computed
outBoundingRectangle	Rectangle2D&		Smallest bounding rectangle of the input points
outCenter	Optional<Point2D&>	NIL	Center of the bounding rectangle
outLongSide	Optional<float&>	NIL	Length of the bounding rectangle long side
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.

Errors

List of possible exceptions:

Error type	Description
DomainError	Incorrect BoundingRectangleFeature in PointsBoundingRectangle.
DomainError	No points on input in PointsBoundingRectangle.