Back to Adaptive Vision Library website
You are here: Start » Function Reference » Path Basics » GetPointOnPath
GetPointOnPath
Returns a path point of desired distance (measured along path) from the first point of the path.
Syntax
C++
C#
void avl::GetPointOnPath ( const avl::Path& inPath, const float inDistanceAlongPath, avl::Point2D& outPoint )
Parameters
Name | Type | Range | Default | Description | |
---|---|---|---|---|---|
inPath | const Path& | Input path | |||
inDistanceAlongPath | const float | 0.0 - | Distance along path from the first characteristic point to the desired point | ||
outPoint | Point2D& |
Errors
Error type | Description |
---|---|
DomainError | Desired distance along path exceeds the path length in GetPointOnPath. |