You are here: Start » FIL.NET » Function Reference » Geometry 2D » Geometry 2D Features » FIL.PointsBoundingRectangle
Computes the smallest rectangle containing an array of points.
Namespace: | FilNet |
---|---|
Assembly: | FIL.NET.dll |
Syntax
C++
C#
public static void PointsBoundingRectangle ( IList<FilNet.Point2D> inPoints, 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 | |
---|---|---|---|---|---|
![]() | inPoints | System.Collections.Generic.IList<FilNet.Point2D> | Input array of points. | ||
![]() | inBoundingRectangleFeature | FilNet.BoundingRectangleFeature | MinimalArea | Determines what kind of bounding rectangle will be computed. Default value: MinimalArea. | |
![]() | inReferenceAngle | float | 0.0f | The middle angle of the valid range of the output rectangle's angle. Default value: 0.0f. | |
![]() | inRectangleOrientation | FilNet.RectangleOrientation | Horizontal | Orientation of the output rectangle. Default value: Horizontal. | |
![]() | outBoundingRectangle | FilNet.Rectangle2D | Smallest bounding rectangle of the input points. | ||
![]() | outCenter | FilNet.NullableValue<FilNet.Point2D> | Center of the bounding rectangle. Can be null to skip this parameter calculation. | ||
![]() | outLongSide | FilNet.NullableValue<float> | Length of the bounding rectangle long side. Can be null to skip this parameter calculation. | ||
![]() | outShortSide | FilNet.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
- PointsBoundingRectangle(IList<Point2D>, BoundingRectangleFeature, Single, RectangleOrientation, Rectangle2D)
- PointsBoundingRectangle(IList<Point2D>, BoundingRectangleFeature, Single, RectangleOrientation, Rectangle2D, Point2D, Single, Single)