You are here: Start » Function Reference » Region Features » RegionBoundingRectangle_Deprecated

RegionBoundingRectangle_Deprecated

Computes the smallest rectangle containing a region.

Syntax

void avl::RegionBoundingRectangle_Deprecated
(
	const avl::Region& inRegion,
	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
)

void RegionBoundingRectangle_Deprecated
(
	Region inRegion,
	float? inRectangleOrientation,
	BoundingRectangleFeature inBoundingRectangleFeature,
	out Rectangle2D outBoundingRectangle,
	out Point2D? outCenter,
	out float? outLongSide,
	out float? outShortSide
)

Parameters

Name	Type	Default	Description
inRegion	const Region&		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&		The smallest bounding rectangle of the input region
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

Errors

Error type	Description
DomainError	Empty region on input in RegionBoundingRectangle.