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

PointToSegmentDistance

Measures the distance between a point and a segment.

Syntax

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

void PointToSegmentDistance
(
	Point2D inPoint,
	Segment2D inSegment,
	float inResolution,
	out float outDistance,
	out Segment2D? outConnectingSegment
)

Parameters

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

Examples

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