Back to Aurora Vision Library Lite website

You are here: Start » Geometry 2D » Geometry 2D Constructions » ProjectPointsOnLine

ProjectPointsOnLine


Header: AVL.h
Namespace: avl

Projects points onto a line.

Syntax

void avl::ProjectPointsOnLine
(
	const atl::Array<avl::Point2D>& inPoints,
	const avl::Line2D& inLine,
	atl::Array<avl::Point2D>& outProjectionPoints,
	atl::Optional<atl::Conditional<avl::Segment2D>&> outProjectionSegment = atl::NIL,
	float& outMeanDistance = atl::Dummy<float>()
)

Parameters

Name Type Default Description
Input value inPoints const Array<Point2D>&
Input value inLine const Line2D&
Output value outProjectionPoints Array<Point2D>&
Output value outProjectionSegment Optional<Conditional<Segment2D>&> NIL
Output value outMeanDistance float& Dummy<float>()

Optional Outputs

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

Read more about Optional Outputs.

Description

The orientation of the resulting outProjectionSegment is always between 0 and 180 degrees.

Examples

ProjectPointsOnLine performed on points and line.

Errors

List of possible exceptions:

Error type Description
DomainError Indefinite line on input in ProjectPointsOnLine.