You are here: Start » AVL.NET » Function Reference » Path » Path Basics » AVL.GetPointOnPath
AVL.GetPointOnPath
Returns a path point of desired distance (measured along path) from the first point of the path.
| Namespace: | AvlNet |
|---|---|
| Assembly: | AVL.NET.dll |
Syntax
C++
C#
public static void GetPointOnPath ( AvlNet.Path inPath, float inDistanceAlongPath, out AvlNet.Point2D outPoint )
Parameters
| Name | Type | Range | Default | Description | |
|---|---|---|---|---|---|
 | inPath | AvlNet.Path | Input path. | ||
| inDistanceAlongPath | float | <0.0f, INF> | Distance along path from the first characteristic point to the desired point. | |
 | outPoint | AvlNet.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. |
