Back to FabImage Library website

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

PathBoundingRectangle_OrNil


Header: FIL.h
Namespace: fil
Module: FoundationBasic

Computes the smallest rectangle containing a path; returns NIL when the path is empty.

Syntax

C++
C#
 
void fil::PathBoundingRectangle_OrNil
(
	const fil::Path& inPath,
	fil::BoundingRectangleFeature::Type inBoundingRectangleFeature,
	float inReferenceAngle,
	fil::RectangleOrientation::Type inRectangleOrientation,
	ftl::Conditional<fil::Rectangle2D>& outBoundingRectangle,
	ftl::Conditional<fil::Point2D>& outCenter,
	ftl::Conditional<float>& outLongSide,
	ftl::Conditional<float>& outShortSide
)

Parameters

Name Type Default Description
Input value
 inPath const Path& Input path
Input value
 inBoundingRectangleFeature BoundingRectangleFeature::Type MinimalArea Determines what kind of bounding rectangle will be computed
Input value
 inReferenceAngle float 0.0f The middle angle of the valid range of the output rectangle's angle
Input value
 inRectangleOrientation RectangleOrientation::Type Horizontal Orientation of the output rectangle
Output value
 outBoundingRectangle Conditional<Rectangle2D>& Smallest bounding rectangle of the input path
Output value
 outCenter Conditional<Point2D>& Center of the bounding rectangle
Output value
 outLongSide Conditional<float>& Length of the bounding rectangle long side
Output value
 outShortSide Conditional<float>& Length of the bounding rectangle short side