You are here: Start » Function Reference » Path » Path Metrics » PathToPointDistance

PathToPointDistance

Header:	FIL.h
Namespace:	fil
Module:	FoundationBasic

Computes the smallest distance between a path and a point.

Syntax

void fil::PathToPointDistance
(
	const fil::Point2D& inPoint,
	const fil::Path& inPath,
	float inResolution,
	float& outDistance,
	ftl::Optional<fil::Segment2D&> outConnectingSegment = ftl::NIL
)

Parameters

Name	Type	Range	Default	Description
inPoint	const Point2D&			Input point
inPath	const Path&			Input path
inResolution	float	0.0 -	1.0f
outDistance	float&			Minimal distance between input path and input point
outConnectingSegment	Optional<Segment2D&>		NIL	Segment connecting input path and input point having minimal length

Optional Outputs

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

Description

The operation computes the minimal distance between the inPoint and inPath and, additionally, the outConnectingSegment segment corresponding to the result.

Examples

The PathToPointDistance run on the sample data produces outDistance = 75.373.

Errors

List of possible exceptions:

Error type	Description
DomainError	Empty path on input in PathToPointDistance.