PathEngine home previous: iMesh::constructPath()next: iMesh::findClosestUnobstructedPosition()
Contents, API Reference, Interfaces, iMesh, copyPath

iMesh::copyPath()

Description

Creates a copy of a path object.

Syntax

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

Parameters

path The path object to copy.

Return Value

A newly created Interface iPath object.

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 copied 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).

See Also

iMesh::constructPath(), iMesh::reversePath()

C# Mapping

Path copyPath(Path path);

Java Mapping

Path copyPath(Path path);

Documentation for PathEngine release 6.04 - Copyright © 2002-2024 PathEnginenext: iMesh::findClosestUnobstructedPosition()