You are here: Start » FIL.NET » Function Reference » Path » Path Metrics » FIL.PathToLineDistance

FIL.PathToLineDistance

Computes the smallest distance between a path and a line.

Namespace:FilNet
Assembly:FIL.NET.dll

Syntax

C++
C#
 
public static void PathToLineDistance
(
	FilNet.Path inPath,
	FilNet.Line2D inLine,
	float inResolution,
	out float outDistance,
	NullableValue<FilNet.Segment2D> outConnectingSegment
)

Parameters

Name Type Range Default Description
inPathFilNet.PathInput path.
inLineFilNet.Line2DInput line.
inResolutionfloat<0.0f, INF>1.0fNumber of real-world units per one pixel. Default value: 1.0f.
outDistancefloatMinimal distance between input path and input line.
outConnectingSegmentFilNet.NullableValue<FilNet.Segment2D>Segment connecting input path and input line having minimal length. Can be null to skip this parameter calculation.

Errors

List of possible exceptions:

Error type Description
DomainError Empty path on input in PathToLineDistance.
DomainError Indefinite line on input in PathToLineDistance.

Function Overrides

See also