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

PathToLineDistance

Computes the smallest distance between a path and a line.

Syntax

void fil::PathToLineDistance
(
	const fil::Path& inPath,
	const fil::Line2D& inLine,
	float inResolution,
	float& outDistance,
	ftl::Optional<fil::Segment2D&> outConnectingSegment = ftl::NIL
)

Parameters

	Name	Type	Range	Default	Description
	inPath	const Path&			Input path
	inLine	const Line2D&			Input line
	inResolution	float	0.0 -	1.0f	Number of real-world units per one pixel
	outDistance	float&			Minimal distance between input path and input line
	outConnectingSegment	Optional<Segment2D&>		NIL	Segment connecting input path and input line having minimal length

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