Back to FabImage Library website

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

LineToLineDistance3D


Header: FIL.h
Namespace: fil
Module: Vision3DLite

Measures the distance between two lines in 3D.

Syntax

C++
C#
 
void fil::LineToLineDistance3D
(
	const fil::Line3D& inLine1,
	const fil::Line3D& inLine2,
	float inResolution,
	float& outDistance,
	ftl::Optional<fil::Segment3D&> outConnectingSegment3D = ftl::NIL
)

Parameters

Name Type Range Default Description
Input value
 inLine1 const Line3D&
Input value
 inLine2 const Line3D&
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 ftl::NIL to these parameters: outConnectingSegment3D.

Read more about Optional Outputs.

Errors

List of possible exceptions:

Error type Description
DomainError Indefinite line on input in LineToLineDistance3D.