You are here: Start » AVL.NET » Function Reference » Path » Path Features » AVL.PathBoundingRectangle

AVL.PathBoundingRectangle

Computes the smallest rectangle containing a path.

Namespace:AvlNet
Assembly:AVL.NET.dll

Syntax

C++
C#
 
public static void PathBoundingRectangle
(
	AvlNet.Path inPath,
	AvlNet.BoundingRectangleFeature inBoundingRectangleFeature,
	float inReferenceAngle,
	AvlNet.RectangleOrientation inRectangleOrientation,
	out AvlNet.Rectangle2D outBoundingRectangle,
	out AvlNet.Point2D outCenter,
	out float outLongSide,
	out float outShortSide
)

Parameters

Name Type Range Default Description
inPathAvlNet.PathInput path.
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.Rectangle2DThe smallest bounding rectangle of the input path.
outCenterAvlNet.Point2DCenter of the bounding rectangle.
outLongSidefloatLength of the bounding rectangle long side.
outShortSidefloatLength of the bounding rectangle short side.

Description

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

Errors

List of possible exceptions:

Error type Description
DomainError Empty path on input in PathBoundingRectangle.

Function Overrides

See also