Vortex Studio SDK Classes Documentation
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
VxTerrain::VxPagedTerrainInterface Class Referenceabstract

Abstract base class for the paged terrain producer interface. More...

#include <VxTerrain/VxPagedTerrainInterface.h>

Inherited by VxTerrain::VxPagedTerrainBasicImplementation.

Public Member Functions

 VxPagedTerrainInterface ()
 Constructor.
 
virtual ~VxPagedTerrainInterface ()
 Destructor.
 
virtual void produce (const std::vector< VxTerrainRequest > &, VxPagedTerrainProducer *)=0
 Triggers the generation of terrain. More...
 
virtual void step (VxPagedTerrainProducer *)=0
 Provides the terrain source time to call into the VxPagedTerrainProducer for previous requests once terrain is available. More...
 
virtual void update (const std::vector< VxTerrainRequest > &, VxPagedTerrainProducer *)=0
 Called when the priority of a queued request changes to a higher priority. More...
 

Friends

class VxPagedTerrainInterfaceFactory
 

Detailed Description

Abstract base class for the paged terrain producer interface.

Member Function Documentation

virtual void VxTerrain::VxPagedTerrainInterface::produce ( const std::vector< VxTerrainRequest > &  ,
VxPagedTerrainProducer  
)
pure virtual

Triggers the generation of terrain.

Called by the terrain producer with an array of terrain requests.

virtual void VxTerrain::VxPagedTerrainInterface::step ( VxPagedTerrainProducer )
pure virtual

Provides the terrain source time to call into the VxPagedTerrainProducer for previous requests once terrain is available.

An asynchronous client can check during this call the status of any overlapped operation or background process and send terrain to the terrain producer.

virtual void VxTerrain::VxPagedTerrainInterface::update ( const std::vector< VxTerrainRequest > &  ,
VxPagedTerrainProducer  
)
pure virtual

Called when the priority of a queued request changes to a higher priority.

If the priority drops to 0, the Terrain Source must provide the terrain before returning from this call.