Back to FabImage Library website

You are here: Start » Function Reference » Path » Path Features » PathBoundingParallelogram

PathBoundingParallelogram


Header: FIL.h
Namespace: fil
Module: FoundationPro

Computes the smallest parallelogram containing a path.

Syntax

C++
C#
 
void fil::PathBoundingParallelogram
(
	const fil::Path& inPath,
	fil::BoundingRectangleFeature::Type inBoundingParallelogramFeature,
	fil::Path& outBoundingParallelogram,
	ftl::Optional<fil::Point2D&> outCenter = ftl::NIL,
	ftl::Optional<float&> outLongSide = ftl::NIL,
	ftl::Optional<float&> outShortSide = ftl::NIL,
	ftl::Optional<float&> outAngle = ftl::NIL
)

Parameters

Name Type Default Description
Input value inPath const Path& Input path
Input value inBoundingParallelogramFeature BoundingRectangleFeature::Type MinimalArea Determines what kind of bounding parallelogram will be computed
Output value outBoundingParallelogram Path& Smallest bounding parallelogram of the input points
Output value outCenter Optional<Point2D&> NIL Center of the bounding parallelogram
Output value outLongSide Optional<float&> NIL Length of the bounding parallelogram long side
Output value outShortSide Optional<float&> NIL Length of the bounding parallelogram short side
Output value outAngle Optional<float&> NIL Angle of the bounding parallelogram

Optional Outputs

The computation of following outputs can be switched off by passing value ftl::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.