You are here: Start » Function Reference » Geometry 2D » Geometry 2D Distance Metrics » PointSequenceDistances

PointSequenceDistances

Header:	AVL.h
Namespace:	avl
Module:	FoundationLite

Measures the distances between consecutive points of a point sequence.

Syntax

void avl::PointSequenceDistances
(
	const atl::Array<avl::Point2D>& inPoints,
	const bool inCyclic,
	float inResolution,
	atl::Array<float>& outDistances,
	atl::Optional<float&> outDistanceSum = atl::NIL,
	atl::Optional<atl::Array<avl::Segment2D>&> outConnectingSegments = atl::NIL
)

Parameters

Name	Type	Range	Default	Description
inPoints	const Array<Point2D>&
inCyclic	const bool
inResolution	float	0.0 -	1.0f	Number of real-world units per one pixel
outDistances	Array<float>&
outDistanceSum	Optional<float&>		NIL
outConnectingSegments	Optional<Array<Segment2D>&>		NIL

Optional Outputs

The computation of following outputs can be switched off by passing value atl::NIL to these parameters: outDistanceSum, outConnectingSegments.