Back to FabImage Library Lite websiteYou are here:
Start »
Path »
Path Basics »
GetPointOnPath
| Header: |
FIL.h
|
| Namespace: |
fil |
Returns a path point of desired distance (measured along path) from the first point of the path.
Syntax
void fil::GetPointOnPath
(
const fil::Path& inPath,
const float inDistanceAlongPath,
fil::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& |
|
|
|
Description
Returns a path point of desired distance (measured along path) from the first point of the path.
Examples
Point with a distance of 5 from path origin.
Errors
List of possible exceptions:
| Error type |
Description |
| DomainError |
Desired distance along path exceeds the path length in GetPointOnPath. |
