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

PointToLineDistance_Oriented

Header:	FIL.h
Namespace:	fil
Module:	FoundationLite

Measures the signed distance between a point and a line with direction.

Syntax

void fil::PointToLineDistance_Oriented
(
	const fil::Point2D& inPoint,
	const fil::Segment2D& inLineSection,
	float inResolution,
	float& outDistance,
	ftl::Optional<fil::Segment2D&> outConnectingSegment = ftl::NIL
)

Parameters

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

Optional Outputs

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