Back to FabImage Library website

You are here: Start » Function Reference » Basic » Box » BoxCharacteristicPoints

BoxCharacteristicPoints


Header: FIL.h
Namespace: fil
Module: FoundationLite

Computes the characteristic points of the box.

Syntax

C++
C#
 
void fil::BoxCharacteristicPoints
(
	const fil::Box& inBox,
	ftl::Optional<fil::Point2D&> outTopLeft = ftl::NIL,
	ftl::Optional<fil::Point2D&> outTopCenter = ftl::NIL,
	ftl::Optional<fil::Point2D&> outTopRight = ftl::NIL,
	ftl::Optional<fil::Point2D&> outMiddleLeft = ftl::NIL,
	ftl::Optional<fil::Point2D&> outMiddleCenter = ftl::NIL,
	ftl::Optional<fil::Point2D&> outMiddleRight = ftl::NIL,
	ftl::Optional<fil::Point2D&> outBottomLeft = ftl::NIL,
	ftl::Optional<fil::Point2D&> outBottomCenter = ftl::NIL,
	ftl::Optional<fil::Point2D&> outBottomRight = ftl::NIL,
	ftl::Optional<ftl::Array<fil::Point2D>&> outCorners = ftl::NIL
)

Parameters

Name Type Default Description
Input value inBox const Box&
Output value outTopLeft Optional<Point2D&> NIL
Output value outTopCenter Optional<Point2D&> NIL
Output value outTopRight Optional<Point2D&> NIL
Output value outMiddleLeft Optional<Point2D&> NIL
Output value outMiddleCenter Optional<Point2D&> NIL
Output value outMiddleRight Optional<Point2D&> NIL
Output value outBottomLeft Optional<Point2D&> NIL
Output value outBottomCenter Optional<Point2D&> NIL
Output value outBottomRight Optional<Point2D&> NIL
Output value outCorners Optional<Array<Point2D>&> NIL

Optional Outputs

The computation of following outputs can be switched off by passing value ftl::NIL to these parameters: outTopLeft, outTopCenter, outTopRight, outMiddleLeft, outMiddleCenter, outMiddleRight, outBottomLeft, outBottomCenter, outBottomRight, outCorners.

Read more about Optional Outputs.