Back to Aurora Vision Library website
You are here: Start » Function Reference » Path » Path Features » PathBoundingParallelogram
PathBoundingParallelogram
Header: | AVL.h |
---|---|
Namespace: | avl |
Module: | FoundationPro |
Computes the smallest parallelogram containing a path.
Syntax
C++
C#
void avl::PathBoundingParallelogram ( const avl::Path& inPath, avl::BoundingRectangleFeature::Type inBoundingParallelogramFeature, avl::Path& outBoundingParallelogram, atl::Optional<avl::Point2D&> outCenter = atl::NIL, atl::Optional<float&> outLongSide = atl::NIL, atl::Optional<float&> outShortSide = atl::NIL, atl::Optional<float&> outAngle = atl::NIL )
Parameters
Name | Type | Default | Description | |
---|---|---|---|---|
inPath | const Path& | Input path | ||
inBoundingParallelogramFeature | BoundingRectangleFeature::Type | MinimalArea | Determines what kind of bounding parallelogram will be computed | |
outBoundingParallelogram | Path& | Smallest bounding parallelogram of the input points | ||
outCenter | Optional<Point2D&> | NIL | Center of the bounding parallelogram | |
outLongSide | Optional<float&> | NIL | Length of the bounding parallelogram long side | |
outShortSide | Optional<float&> | NIL | Length of the bounding parallelogram short side | |
outAngle | Optional<float&> | NIL | Angle of the bounding parallelogram |
Optional Outputs
The computation of following outputs can be switched off by passing value atl::NIL
to these parameters: outCenter, outLongSide, outShortSide, outAngle.
Read more about Optional Outputs.
Errors
List of possible exceptions:
Error type | Description |
---|---|
DomainError | Empty path on input in PathBoundingParallelogram. |