You are here: Start » Function Reference » Geometry 2D Distance Metrics » PointToCircleDistance

PointToCircleDistance

Measures the distance between a point and a circle.

Syntax

void avl::PointToCircleDistance
(
	const avl::Point2D& inPoint,
	const avl::Circle2D& inCircle,
	float inResolution,
	float& outDistance,
	atl::Optional<avl::Segment2D&> outConnectingSegment = atl::NIL
)

void PointToCircleDistance
(
	Point2D inPoint,
	Circle2D inCircle,
	float inResolution,
	out float outDistance,
	out Segment2D? outConnectingSegment
)

Parameters

Name	Type	Range	Default	Description
inPoint	const Point2D&
inCircle	const Circle2D&
inResolution	float	0.0 -	1.0f	Number of real-world units per one pixel
outDistance	float&
outConnectingSegment	Optional<Segment2D&>		NIL

Examples

PointToCircleDistance performed on a sample point and a sample circle. The green segment is the value of outConnectingSegment output.