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

PointToPointDistance

Header:	FIL.h
Namespace:	fil

Measures the distance between two points.

Syntax

void fil::PointToPointDistance
(
	const fil::Point2D& inPoint1,
	const fil::Point2D& inPoint2,
	float inResolution,
	float& outDistance,
	ftl::Optional<fil::Segment2D&> outConnectingSegment = ftl::NIL
)

Parameters

Name	Type	Range	Default	Description
inPoint1	const Point2D&
inPoint2	const Point2D&
inResolution	float	0.0 -	1.0f	Number of real-world units per one pixel
outDistance	float&
outConnectingSegment	Optional<Segment2D&>		NIL

Optional Outputs

The computation of following outputs can be switched off by passing value ftl::NIL to these parameters: outDistance, outConnectingSegment.

Examples

PointToPointDistance performed on two sample points. The green segment is the value of outConnectingSegment output.