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

RegionBoundingRectangle_Deprecated

Header:	FIL.h
Namespace:	fil

Computes the smallest rectangle containing a region.

Syntax

void fil::RegionBoundingRectangle_Deprecated
(
	const fil::Region& inRegion,
	ftl::Optional<float> inRectangleOrientation,
	fil::BoundingRectangleFeature::Type inBoundingRectangleFeature,
	fil::Rectangle2D& outBoundingRectangle,
	ftl::Optional<fil::Point2D&> outCenter = ftl::NIL,
	ftl::Optional<float&> outLongSide = ftl::NIL,
	ftl::Optional<float&> outShortSide = ftl::NIL
)

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

Optional Outputs

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

Errors

List of possible exceptions:

Error type	Description
DomainError	Empty region on input in RegionBoundingRectangle_Deprecated.