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

PathToPathMaximumDistance

Computes the distance between the farthest point of the input path from the other path.

Syntax

void fil::PathToPathMaximumDistance
(
	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&			Distance between farthest point of the input path the other input path
	outConnectingSegment	Optional<Segment2D&>		NIL	Segment connecting input paths having such distance

Optional Outputs

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

Read more about Optional Outputs.

Errors