Back to Aurora Vision Library website
You are here: Start » Function Reference » Geometry 3D » Geometry 3D Distance Metrics » SegmentToPlaneDistance3D
SegmentToPlaneDistance3D
Header: | AVL.h |
---|---|
Namespace: | avl |
Module: | Vision3DLite |
Measures the distance between a segment in 3D and a plane.
Syntax
C++
C#
void avl::SegmentToPlaneDistance3D ( const avl::Segment3D& inSegment3D, const avl::Plane3D& inPlane, float inResolution, float& outDistance, atl::Optional<avl::Segment3D&> outConnectingSegment3D = atl::NIL, atl::Optional<float&> outSignedDistance = atl::NIL )
Parameters
Name | Type | Range | Default | Description | |
---|---|---|---|---|---|
inSegment3D | const Segment3D& | ||||
inPlane | const Plane3D& | ||||
inResolution | float | 0.0 - | 1.0f | Number of real-world units per one pixel | |
outDistance | float& | ||||
outConnectingSegment3D | Optional<Segment3D&> | NIL | |||
outSignedDistance | Optional<float&> | NIL |
Optional Outputs
The computation of following outputs can be switched off by passing value atl::NIL
to these parameters: outConnectingSegment3D, outSignedDistance.
Read more about Optional Outputs.
Errors
List of possible exceptions:
Error type | Description |
---|---|
DomainError | Indefinite plane on input in SegmentToPlaneDistance3D. |