Back to FabImage Library website

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

GetPointOnPath


Header: FIL.h
Namespace: fil
Module: FoundationLite

Returns a path point of desired distance (measured along path) from the first point of the path.

Syntax

C++
C#
 
void fil::GetPointOnPath
(
	const fil::Path& inPath,
	const float inDistanceAlongPath,
	fil::Point2D& outPoint
)

Parameters

Name Type Range Default Description
Input value inPath const Path& Input path
Input value inDistanceAlongPath const float 0.0 - Distance along path from the first characteristic point to the desired point
Output value 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.