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

PointsDiameter

Finds the longest segment connecting two points from a given array.

Header:	AVL.h

Syntax

void avl::PointsDiameter
(
	const atl::Array<avl::Point2D>& inPoints,
	atl::Optional<avl::Segment2D&> outDiameter = atl::NIL,
	atl::Optional<float&> outDiameterLength = atl::NIL
)

void PointsDiameter
(
	Point2D[] inPoints,
	out Segment2D? outDiameter,
	out float? outDiameterLength
)

Parameters

Name	Type	Default	Description
inPoints	const Array<Point2D>&		Input array of points
outDiameter	Optional<Segment2D&>	NIL	Longest segment found
outDiameterLength	Optional<float&>	NIL	Length of longest segment found

Examples

PointsDiameter performed on an array of input points. The orange line is the result.

Errors

Error type	Description
DomainError	Empty array of points on input in PointsDiameter.