iAgent::getMesh()

Description

A helper function to access the mesh on which this agent is placed.

Syntax

std::unique_ptr<iMesh> getMesh() const

Return Value

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.

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

See Also

C# Mapping

Mesh getMesh();

Java Mapping

Mesh getMesh();