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

SegmentToPlaneDistance3D

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

Syntax

void fil::SegmentToPlaneDistance3D
(
	const fil::Segment3D& inSegment3D,
	const fil::Plane3D& inPlane,
	float inResolution,
	float& outDistance,
	ftl::Optional<fil::Segment3D&> outConnectingSegment3D = ftl::NIL,
	ftl::Optional<float&> outSignedDistance = ftl::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 ftl::NIL to these parameters: outConnectingSegment3D, outSignedDistance.

Read more about Optional Outputs.

Errors