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

FIL.PathBoundingRectangle

Computes the smallest rectangle containing a path.

Namespace:FilNet
Assembly:FIL.NET.dll

Syntax

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

Parameters

Name Type Range Default Description
inPathFilNet.PathInput path.
inBoundingRectangleFeatureFilNet.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.
inRectangleOrientationFilNet.RectangleOrientationHorizontalOrientation of the output rectangle. Default value: Horizontal.
outBoundingRectangleFilNet.Rectangle2DThe smallest bounding rectangle of the input path.
outCenterFilNet.NullableValue<FilNet.Point2D>Center of the bounding rectangle. Can be null to skip this parameter calculation.
outLongSideFilNet.NullableValue<float>Length of the bounding rectangle long side. Can be null to skip this parameter calculation.
outShortSideFilNet.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 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