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

PathToPathDistance

Header:	FIL.h
Namespace:	fil
Module:	FoundationPro

Computes the minimum distance between two paths.

Syntax

void fil::PathToPathDistance
(
	const fil::Path& inPath1,
	const fil::Path& inPath2,
	fil::PathDistanceMode::Type inPathDistanceMode,
	float inResolution,
	float& outDistance,
	ftl::Optional<fil::Segment2D&> outConnectingSegment = ftl::NIL
)

Parameters

Name	Type	Range	Default	Description
inPath1	const Path&			First input path
inPath2	const Path&			Second input path
inPathDistanceMode	PathDistanceMode::Type			Distance measuring method
inResolution	float	0.0 -	1.0f
outDistance	float&			Minimal distance between input paths
outConnectingSegment	Optional<Segment2D&>		NIL	Segment connecting input paths 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 finds the minimal distance between a characteristic point of inPath1 and path inPath2. The distance between a point and a path is computed as follows, depending on the value of inPathDistanceMode:

The distance to nearest characteristic point of inPath2, if inPathDistanceMode is set to PointToPoint.
The minimal distance to inPath2 segments adjacent to the nearest characteristic point of inPath2 (which is much more precise), if inPathDistanceMode is set to PointToSegment.

The operation computes the outDistance distance and, additionally, the outConnectingSegment line segment corresponding to the result.

Examples

The PathToPathDistance run on the sample paths produces outDistance = 9.509.

The resulting outConnectingSegment drawn onto the input paths.

Errors

List of possible exceptions:

Error type	Description
DomainError	One or both input paths are empty in PathToPathDistance.