Back to Aurora Vision Library website

You are here: Start » Function Reference » Geometry 3D » Geometry 3D Distance Metrics » PointToSegmentDistance3D

PointToSegmentDistance3D


Header: AVL.h
Namespace: avl
Module: Vision3DLite

Measures the distance between a 3D point and a segment in 3D.

Syntax

C++
C#
 
void avl::PointToSegmentDistance3D
(
	const avl::Point3D& inPoint3D,
	const avl::Segment3D& inSegment3D,
	float inResolution,
	float& outDistance,
	atl::Optional<avl::Segment3D&> outConnectingSegment3D = atl::NIL
)

Parameters

Name Type Range Default Description
Input value inPoint3D const Point3D&
Input value inSegment3D const Segment3D&
Input value inResolution float 0.0 - 1.0f Number of real-world units per one pixel
Output value outDistance float&
Output value outConnectingSegment3D Optional<Segment3D&> NIL

Optional Outputs

The computation of following outputs can be switched off by passing value atl::NIL to these parameters: outConnectingSegment3D.

Read more about Optional Outputs.