You are here: Start » FIL.NET » Function Reference » Path » Path Metrics » FIL.PathToPointDistance
Computes the smallest distance between a path and a point.
Namespace: | FilNet |
---|---|
Assembly: | FIL.NET.dll |
Syntax
C++
C#
public static void PathToPointDistance ( FilNet.Point2D inPoint, FilNet.Path inPath, float inResolution, out float outDistance )
Parameters
Name | Type | Range | Default | Description | |
---|---|---|---|---|---|
![]() | inPoint | FilNet.Point2D | Input point. | ||
![]() | inPath | FilNet.Path | Input path. | ||
![]() | inResolution | float | <0.0f, INF> | 1.0f | Default value: 1.0f. |
![]() | outDistance | float | Minimal distance between input path and input point. |
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
List of possible exceptions:
Error type | Description |
---|---|
DomainError | Empty path on input in PathToPointDistance. |
Function Overrides
- PathToPointDistance(Point2D, Path, Single, Single, Segment2D)
- PathToPointDistance(Point2D, Path, Single, Single, NullableValue<Segment2D>)