Back to FabImage Library website

You are here: Start » Function Reference » Geometry 2D » Geometry 2D Features » CircleBoundingRectangle

CircleBoundingRectangle


Header: FIL.h
Namespace: fil
Module: FoundationLite

Computes the smallest rectangle containing a circle.

Syntax

C++
C#
 
void fil::CircleBoundingRectangle
(
	const fil::Circle2D& inCircle,
	ftl::Optional<float> inAngle,
	fil::Rectangle2D& outBoundingRectangle,
	ftl::Optional<fil::Point2D&> outCenter = ftl::NIL,
	ftl::Optional<float&> outLongSide = ftl::NIL,
	ftl::Optional<float&> outShortSide = ftl::NIL
)

Parameters

Name Type Default Description
Input value inCircle const Circle2D& Input circle
Input value inAngle Optional<float> NIL Expected angle of the resulting rectangle
Output value outBoundingRectangle Rectangle2D& Smallest bounding rectangle of the input circle
Output value outCenter Optional<Point2D&> NIL Center of the bounding rectangle
Output value outLongSide Optional<float&> NIL Length of the bounding rectangle long side
Output value outShortSide Optional<float&> NIL Length of the bounding rectangle short side

Optional Outputs

The computation of following outputs can be switched off by passing value ftl::NIL to these parameters: outCenter, outLongSide, outShortSide.

Read more about Optional Outputs.

Examples

CircleBoundingRectangle performed on a sample circle.