Back to Aurora Vision Library website

You are here: Start » Function Reference » Path » Path Basics » GetPathCharacteristicPoint

GetPathCharacteristicPoint


Header: AVL.h
Namespace: avl
Module: FoundationLite

Returns the selected characteristic point of a path.

Syntax

C++
C#
 
void avl::GetPathCharacteristicPoint
(
	const avl::Path& inPath,
	int inIndex,
	const bool inInverse,
	avl::Point2D& outPoint
)

Parameters

Name Type Range Default Description
Input value inPath const Path& Input path
Input value inIndex int 0 - Index of a point of the input path
Input value inInverse const bool Reversed order of points
Output value outPoint Point2D&

Errors

List of possible exceptions:

Error type Description
DomainError Index out of range in GetPathCharacteristicPoint.