Back to Aurora Vision Library website

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

RectangleCharacteristicPoints


Header: AVL.h
Namespace: avl
Module: FoundationLite

Computes rectangle's characteristic points.

Syntax

C++
C#
 
void avl::RectangleCharacteristicPoints
(
	const avl::Rectangle2D& inRectangle,
	atl::Optional<avl::Point2D&> outTopLeft = atl::NIL,
	atl::Optional<avl::Point2D&> outTopCenter = atl::NIL,
	atl::Optional<avl::Point2D&> outTopRight = atl::NIL,
	atl::Optional<avl::Point2D&> outMiddleLeft = atl::NIL,
	atl::Optional<avl::Point2D&> outMiddleCenter = atl::NIL,
	atl::Optional<avl::Point2D&> outMiddleRight = atl::NIL,
	atl::Optional<avl::Point2D&> outBottomLeft = atl::NIL,
	atl::Optional<avl::Point2D&> outBottomCenter = atl::NIL,
	atl::Optional<avl::Point2D&> outBottomRight = atl::NIL,
	atl::Optional<atl::Array<avl::Point2D>&> outCorners = atl::NIL
)

Parameters

Name Type Default Description
Input value inRectangle const Rectangle2D&
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 atl::NIL to these parameters: outTopLeft, outTopCenter, outTopRight, outMiddleLeft, outMiddleCenter, outMiddleRight, outBottomLeft, outBottomCenter, outBottomRight, outCorners.

Read more about Optional Outputs.