reversePath

previous: iMesh::retrieveNamedObstacleByIndex()

next: iMesh::saveBackgroundUnobstructedSpaceFor()

Contents, API Reference, Interfaces, iMesh, reversePath

iMesh::reversePath()

Description

Creates a reversed copy of a path.

Syntax

std::unique_ptr<iPath> reversePath(iPath* path) const

Parameters

path

The path to reverse. This path must not include off-mesh connection segments.

Return Value

A newly created Interface iPath object, with positions in reverse order to the path passed in.

Remarks

Note that path objects cache some state internally for the purposes of smooth position interpolation in advance along path methods, which is not included in the reversed path.

For convenience, you can pass a nullptr for the path argument (representing failure to reach a pathfinding destination), and in this case this method will then also return a nullptr (with no action).

C# Mapping

Path reversePath(Path path);

Java Mapping

Path reversePath(Path path);