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

CircleToPlaneDistance3D

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

Syntax

void avl::CircleToPlaneDistance3D
(
	const avl::Circle3D& inCircle3D,
	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
	inCircle3D	const Circle3D&
	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