You are here: Start » AVL.NET » AVL.PathToPointDistance
Computes the smallest distance between a path and a point.
Namespace: | AvlNet |
---|---|
Assembly: | AVL.NET.dll |
Syntax
C++
C#
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 | |
---|---|---|---|---|---|
inPoint | AvlNet.Point2D | Input point. | |||
inPath | AvlNet.Path | Input path. | |||
inResolution | float | <0.0f, INF> | 1.0f | Default value: 1.0f. | |
outDistance | float | Minimal distance between input path and input point. | |||
outConnectingSegment | AvlNet.Segment2D | Segment 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
Errors
List of possible exceptions:
Error type | Description |
---|---|
DomainError | Empty path on input in PathToPointDistance. |