You are here: Start » AVL.NET » Function Reference » Geometry 3D » Geometry 3D Distance Metrics » AVL.SegmentToPlaneDistance3D
Measures the distance between a segment in 3D and a plane.
Namespace: | AvlNet |
---|---|
Assembly: | AVL.NET.dll |
Syntax
C++
C#
public static void SegmentToPlaneDistance3D ( AvlNet.Segment3D inSegment3D, AvlNet.Plane3D inPlane, float inResolution, out float outDistance, INullable<AvlNet.Segment3D> outConnectingSegment3D, NullableValue<float> outSignedDistance )
Parameters
Name | Type | Range | Default | Description | |
---|---|---|---|---|---|
inSegment3D | AvlNet.Segment3D | ||||
inPlane | AvlNet.Plane3D | ||||
inResolution | float | <0.0f, INF> | 1.0f | Number of real-world units per one pixel. Default value: 1.0f. | |
outDistance | float | ||||
outConnectingSegment3D | AvlNet.INullable<AvlNet.Segment3D> | Can be null to skip this parameter calculation. | |||
outSignedDistance | AvlNet.NullableValue<float> | Can be null to skip this parameter calculation. |
Errors
List of possible exceptions:
Error type | Description |
---|---|
DomainError | Indefinite plane on input in SegmentToPlaneDistance3D. |
Function Overrides
- SegmentToPlaneDistance3D(Segment3D, Plane3D, Single, Single)
- SegmentToPlaneDistance3D(Segment3D, Plane3D, Single, Single, Segment3D, Single)