You are here: Start » AVL.NET » AVL.PathToPointDistance Method

AVL.PathToPointDistance Method

Computes the smallest distance between a path and a point.

Namespace:AvlNet
Assembly:AVL.NET.dll

Syntax

public static void PathToPointDistance(
	AvlNet.Point2D inPoint,
	AvlNet.Path inPath,
	float inResolution,
	out float outDistance,
	out AvlNet.Segment2D outConnectingSegment
)

Parameters

Name Type Range Default Description
inPointAvlNet.Point2DInput point.
inPathAvlNet.PathInput path.
inResolutionfloat<0.0f, INF>1.0fDefault value: 1.0f.
outDistancefloatMinimal distance between input path and input point.
outConnectingSegmentAvlNet.Segment2DSegment connecting input path and input point having minimal length

Description

The operation computes the minimal distance between the inPoint and inPath and, additionally, the outConnectingSegment segment corresponding to the result.

Examples

The PathToPointDistance run on the sample data produces outDistance = 75.373.

Errors

Error type Description
DomainError Empty path on input in PathToPointDistance.

See also