Back to Aurora Vision Library Lite website

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

GetPathSegment


Header: AVL.h
Namespace: avl

Returns the selected segment of a path.

Syntax

void avl::GetPathSegment
(
	const avl::Path& inPath,
	int inIndex,
	const bool inInverse,
	avl::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.