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

AVL.PointsBoundingRectangle

Computes the smallest rectangle containing an array of points.

Namespace:AvlNet
Assembly:AVL.NET.dll

Syntax

C++
C#
 
public static void PointsBoundingRectangle
(
	IList<AvlNet.Point2D> inPoints,
	AvlNet.BoundingRectangleFeature inBoundingRectangleFeature,
	float inReferenceAngle,
	AvlNet.RectangleOrientation inRectangleOrientation,
	out AvlNet.Rectangle2D outBoundingRectangle,
	NullableValue<AvlNet.Point2D> outCenter,
	NullableValue<float> outLongSide,
	NullableValue<float> outShortSide
)

Parameters

Name Type Range Default Description
inPointsSystem.Collections.Generic.IList<AvlNet.Point2D>Input array of points.
inBoundingRectangleFeatureAvlNet.BoundingRectangleFeatureMinimalAreaDetermines what kind of bounding rectangle will be computed. Default value: MinimalArea.
inReferenceAnglefloat0.0fThe middle angle of the valid range of the output rectangle's angle. Default value: 0.0f.
inRectangleOrientationAvlNet.RectangleOrientationHorizontalOrientation of the output rectangle. Default value: Horizontal.
outBoundingRectangleAvlNet.Rectangle2DSmallest bounding rectangle of the input points.
outCenterAvlNet.NullableValue<AvlNet.Point2D>Center of the bounding rectangle. Can be null to skip this parameter calculation.
outLongSideAvlNet.NullableValue<float>Length of the bounding rectangle long side. Can be null to skip this parameter calculation.
outShortSideAvlNet.NullableValue<float>Length of the bounding rectangle short side. Can be null to skip this parameter calculation.

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

List of possible exceptions:

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

Function Overrides

See also