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

PointSequenceDistances

Header:	FIL.h
Namespace:	fil
Module:	FoundationLite

Measures the distances between consecutive points of a point sequence.

Syntax

void fil::PointSequenceDistances
(
	const ftl::Array<fil::Point2D>& inPoints,
	const bool inCyclic,
	float inResolution,
	ftl::Array<float>& outDistances,
	ftl::Optional<float&> outDistanceSum = ftl::NIL,
	ftl::Optional<ftl::Array<fil::Segment2D>&> outConnectingSegments = ftl::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 ftl::NIL to these parameters: outDistanceSum, outConnectingSegments.