Back to FabImage Library website

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

GetPathSegment


Header: FIL.h
Namespace: fil
Module: FoundationLite

Returns the selected segment of a path.

Syntax

C++
C#
 
void fil::GetPathSegment
(
	const fil::Path& inPath,
	int inIndex,
	const bool inInverse,
	fil::Segment2D& outSegment
)

Parameters

Name Type Range Default Description
Input value
 inPath const Path& Input path
Input value
 inIndex int 0 -
Input value
 inInverse const bool Reversed order of segments
Output value
 outSegment Segment2D&

Errors

List of possible exceptions:

Error type Description
DomainError Empty path in GetPathSegment.
DomainError Incorrect segment index in GetPathSegment.