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

PathToPathMaximumDistance

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

Syntax

void avl::PathToPathMaximumDistance
(
	const avl::Path& inPath1,
	const avl::Path& inPath2,
	avl::PathDistanceMode::Type inPathDistanceMode,
	float inResolution,
	float& outDistance,
	atl::Optional<avl::Segment2D&> outConnectingSegment = atl::NIL
)

void PathToPathMaximumDistance
(
	Path inPath1,
	Path inPath2,
	PathDistanceMode inPathDistanceMode,
	float inResolution,
	out float outDistance,
	out Segment2D? outConnectingSegment
)

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

Errors

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