Back to Aurora Vision Library website

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

PointToCircleDistance


Header: AVL.h
Namespace: avl
Module: FoundationLite

Measures the distance between a point and a circle.

Syntax

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

Parameters

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

Optional Outputs

The computation of following outputs can be switched off by passing value atl::NIL to these parameters: outConnectingSegment.

Read more about Optional Outputs.

Examples

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