PathEngine home previous: iPath::getLength()next: iPath::hasRefs()
Contents, API Reference, Interfaces, iPath, getMesh

iPath::getMesh()

Description

A helper function to access the mesh on which this path was created.

Syntax

std::unique_ptr<iMesh> getMesh() const

Return Value

The mesh on which this path was created.

Remarks

Note that this method gives you an API object reference to the mesh, with the API object reference count for the returned mesh incremented accordingly. You need to ensure that delete is called for the returned mesh pointer (or it's release() method), when it is no longer required. (In C++ when obtaining an API ref wrapped in a unique_ptr, the unique_ptr handles this for you.)

If you want to access the mesh object temporarily, without incrementing the API object reference count, use iPath::refMesh().

C# Mapping

Mesh getMesh();

Java Mapping

Mesh getMesh();

Documentation for PathEngine release 6.04 - Copyright © 2002-2024 PathEnginenext: iPath::hasRefs()