PathEngine home previous: iMesh::getFederationTileIndex()next: iMesh::getNumberOf3DFaces()
Contents, API Reference, Interfaces, iMesh, getGround

iMesh::getGround()

Description

A helper function to access the ground surface object for a mesh.

Syntax

std::unique_ptr<const iGround> getGround() const

Return Value

The ground surface for this mesh.

Remarks

Note that this method gives you an API object reference to the ground, with the API object reference count for the returned mesh incremented accordingly. You need to ensure that delete is called for the returned ground 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 ground object temporarily, without incrementing the API object reference count, use iMesh::refGround().

C# Mapping

Ground getGround();

Java Mapping

Ground getGround();

Documentation for PathEngine release 6.03 - Copyright © 2002-2021 PathEnginenext: iMesh::getNumberOf3DFaces()