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

PointsBoundingRectangle

Computes the smallest rectangle containing an array of points.

Syntax

void avl::PointsBoundingRectangle
(
	const atl::Array<avl::Point2D>& inPoints,
	avl::BoundingRectangleFeature::Type inBoundingRectangleFeature,
	float inReferenceAngle,
	avl::RectangleOrientation::Type inRectangleOrientation,
	avl::Rectangle2D& outBoundingRectangle,
	atl::Optional<avl::Point2D&> outCenter = atl::NIL,
	atl::Optional<float&> outLongSide = atl::NIL,
	atl::Optional<float&> outShortSide = atl::NIL
)

void PointsBoundingRectangle
(
	Point2D[] inPoints,
	BoundingRectangleFeature inBoundingRectangleFeature,
	float inReferenceAngle,
	RectangleOrientation inRectangleOrientation,
	out Rectangle2D outBoundingRectangle,
	out Point2D? outCenter,
	out float? outLongSide,
	out float? outShortSide
)

Parameters

Name	Type	Default	Description
inPoints	const Array<Point2D>&		Input array of points
inBoundingRectangleFeature	BoundingRectangleFeature::Type	MinimalArea	Determines what kind of bounding rectangle will be computed
inReferenceAngle	float	0.0f	The middle angle of the valid range of the output rectangle's angle
inRectangleOrientation	RectangleOrientation::Type	Horizontal	Orientation of the output rectangle
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

Description

The filter computes a rectangle with the smallest possible selected feature that contains all given points. The angle of the resulting rectangle is then normalized as in the NormalizeRectangleOrientation filter.

Examples

The resulting outBoundingRectangle drawn with the input points and with inRectangleOrientation set on Horizontal

Errors