PathEngine home previous: iOutputStream::put()next: iTerrainCallBack::getHeightAt()
Contents, API Reference, Interfaces, iTerrainCallBack

Interface iTerrainCallBack

Description

The client application creates objects deriving from this interface to enable PathEngine to work with a client side representation of surface detail such as a height field for terrain.

Defined in SDKRoot/code/externalAPI/i_pathengine.h.

class iTerrainCallBack
{
public:
    virtual ~iTerrainCallBack() {};
    virtual float getHeightAt(int32_t x, int32_t y)=0;
};
        

The virtual destructor is included just for good general programming practice.
Destruction remains the responsibility of the client application - PathEngine will not call this virtual destructor.

Methods:

getHeightAt

This method is called by PathEngine to obtain the height of the terrain layer corresponding to this callback at specified x and y coordinates.

getHeightAtWithPrecision

An alternative version of the height query taking extra float parameters for precision components of position.

Refer to Working with Terrain for an explanation of the terrain callback system.


Documentation for PathEngine release 6.00 - Copyright © 2002-2016 PathEnginenext: iTerrainCallBack::getHeightAt()