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

PointToCircleDistance3D

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

Syntax

void fil::PointToCircleDistance3D
(
	const fil::Point3D& inPoint3D,
	const fil::Circle3D& inCircle3D,
	float inResolution,
	float& outDistance,
	ftl::Optional<fil::Segment3D&> outConnectingSegment3D = ftl::NIL
)

Parameters

	Name	Type	Range	Default	Description
	inPoint3D	const Point3D&
	inCircle3D	const Circle3D&
	inResolution	float	0.0 -	1.0f	Number of real-world units per one pixel
	outDistance	float&
	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