You are here: Start » FIL.NET » Function Reference » Geometry 2D » Geometry 2D Distance Metrics » FIL.PointToLineDistance
Measures the distance between a point and a line.
Namespace: | FilNet |
---|---|
Assembly: | FIL.NET.dll |
Syntax
C++
C#
public static void PointToLineDistance ( FilNet.Point2D inPoint, FilNet.Line2D inLine, float inResolution, out float outDistance, out FilNet.Segment2D outConnectingSegment, out float outSignedDistance )
Parameters
Name | Type | Range | Default | Description | |
---|---|---|---|---|---|
![]() | inPoint | FilNet.Point2D | |||
![]() | inLine | FilNet.Line2D | |||
![]() | inResolution | float | <0.0f, INF> | 1.0f | Number of real-world units per one pixel. Default value: 1.0f. |
![]() | outDistance | float | |||
![]() | outConnectingSegment | FilNet.Segment2D | |||
![]() | outSignedDistance | float |
Examples
![]() |
![]() |
PointToLineDistance performed on a sample point and a sample line. The green segment is the value of outConnectingSegment output.
Errors
List of possible exceptions:
Error type | Description |
---|---|
DomainError | Indefinite line on input in PointToLineDistance. |
Function Overrides
- PointToLineDistance(Point2D, Line2D, Single, Single)
- PointToLineDistance(Point2D, Line2D, Single, Single, NullableValue<Segment2D>, NullableValue<Single>)