VoxelFarm::CStaticWaterLayer Class Reference
Inheritance diagram for VoxelFarm::CStaticWaterLayer:
VoxelFarm::IVoxelLayer

Classes

struct  CThreadContext
 

Public Member Functions

 CStaticWaterLayer (IStaticWaterMap *waterMap, MaterialId waterMaterial)
 
virtual void getContourData (CellId cell, ContourVoxelData *data, bool &empty, void *threadContext) override
 Returns voxel data for the specified cell (IVoxelLayer) More...
 
virtual int getStatsContourId () override
 Returns the stats ID to be used for measuring performance of the getContourData() method.
 
virtual void * createThreadContext ()
 The voxel layer can use this method to return a structure that will be unique for each calling thread. This allows to have lock-free work buffers assigned to each worker thread.
 
virtual void disposeThreadContext (void *threadContext)
 Destroys the specified thread context.
 
- Public Member Functions inherited from VoxelFarm::IVoxelLayer
virtual void planJobs (Scene *scene)
 This is called when a new scene is discovered. It can be used to create objects that will be later returned in voxel form.
 
virtual void runJobs ()
 Execute any additional generation task.
 
virtual int getStatsPlanJobsId ()
 Returns the stats ID to be used for measuring performance of the planJobs() method.
 
virtual int getStatsRunJobsId ()
 Returns the stats ID to be used for measuring performance of the runJobs() method.
 
virtual bool isCacheable ()
 Returns true if the layer's output can be cached. Return true if the output for a cell will always be the same.
 

Public Attributes

IStaticWaterMapwaterMap
 
MaterialId waterMaterial
 

Static Public Attributes

static const int WATER_PAGE_SIZE = BLOCK_SIZE
 

Detailed Description

Definition at line 344 of file HydroTile.h.

Member Function Documentation

virtual void VoxelFarm::CStaticWaterLayer::getContourData ( CellId  cell,
ContourVoxelData data,
bool &  empty,
void *  threadContext 
)
overridevirtual

Returns voxel data for the specified cell (IVoxelLayer)

Parameters
cellID of the cell
dataA buffer where the voxel data will be copied.
emptyA flag notifying the entire cell is empty and could be discarded by the caller

Implements VoxelFarm::IVoxelLayer.


The documentation for this class was generated from the following file: