OGRE  2.0
Object-Oriented Graphics Rendering Engine
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Ogre::Volume::ChunkHandler Class Reference

Handles the WorkQueue management of the chunks. More...

#include <OgreVolumeChunkHandler.h>

+ Inheritance diagram for Ogre::Volume::ChunkHandler:
+ Collaboration diagram for Ogre::Volume::ChunkHandler:

Public Member Functions

 ChunkHandler (void)
 Constructor. More...
 
virtual ~ChunkHandler (void)
 Destructor. More...
 
void addRequest (const ChunkRequest &req)
 Adds a new ChunkRequest to be loaded to the WorkQueue. More...
 
virtual bool canHandleRequest (const Request *req, const WorkQueue *srcQ)
 Return whether this handler can process a given request. More...
 
virtual bool canHandleResponse (const Response *res, const WorkQueue *srcQ)
 Return whether this handler can process a given response. More...
 
WorkQueue::ResponsehandleRequest (const WorkQueue::Request *req, const WorkQueue *srcQ)
 Implementation for WorkQueue::RequestHandler. More...
 
void handleResponse (const WorkQueue::Response *res, const WorkQueue *srcQ)
 Implementation for WorkQueue::ResponseHandler. More...
 
void processWorkQueue (void)
 Calls the process-update of the WorkQueue so it doesn't block. More...
 

Protected Member Functions

void init (void)
 Initializes the WorkQueue (once). More...
 

Protected Attributes

uint16 mWorkQueueChannel
 The workqueue channel. More...
 
WorkQueuemWQ
 The workqueue. More...
 

Static Protected Attributes

static const uint16 WORKQUEUE_LOAD_REQUEST
 The workqueue load request. More...
 

Detailed Description

Handles the WorkQueue management of the chunks.

Definition at line 89 of file OgreVolumeChunkHandler.h.

Constructor & Destructor Documentation

Ogre::Volume::ChunkHandler::ChunkHandler ( void  )

Constructor.

virtual Ogre::Volume::ChunkHandler::~ChunkHandler ( void  )
virtual

Destructor.

Member Function Documentation

void Ogre::Volume::ChunkHandler::addRequest ( const ChunkRequest req)

Adds a new ChunkRequest to be loaded to the WorkQueue.

Parameters
reqThe ChunkRequest.
virtual bool Ogre::WorkQueue::RequestHandler::canHandleRequest ( const Request req,
const WorkQueue srcQ 
)
inlinevirtualinherited

Return whether this handler can process a given request.

Remarks
Defaults to true, but if you wish to add several handlers each of which deal with different types of request, you can override this method.

Reimplemented in Ogre::Terrain, Ogre::TerrainGroup, Ogre::ResourceBackgroundQueue, Ogre::Page, and Ogre::TerrainLodManager.

Definition at line 174 of file OgreWorkQueue.h.

References Ogre::WorkQueue::Request::getAborted().

virtual bool Ogre::WorkQueue::ResponseHandler::canHandleResponse ( const Response res,
const WorkQueue srcQ 
)
inlinevirtualinherited

Return whether this handler can process a given response.

Remarks
Defaults to true, but if you wish to add several handlers each of which deal with different types of response, you can override this method.

Reimplemented in Ogre::Terrain, Ogre::TerrainGroup, Ogre::ResourceBackgroundQueue, Ogre::Page, and Ogre::TerrainLodManager.

Definition at line 209 of file OgreWorkQueue.h.

References Ogre::WorkQueue::Request::getAborted(), and Ogre::WorkQueue::Response::getRequest().

WorkQueue::Response* Ogre::Volume::ChunkHandler::handleRequest ( const WorkQueue::Request req,
const WorkQueue srcQ 
)
virtual
void Ogre::Volume::ChunkHandler::handleResponse ( const WorkQueue::Response res,
const WorkQueue srcQ 
)
virtual
void Ogre::Volume::ChunkHandler::init ( void  )
protected

Initializes the WorkQueue (once).

void Ogre::Volume::ChunkHandler::processWorkQueue ( void  )

Calls the process-update of the WorkQueue so it doesn't block.

Member Data Documentation

uint16 Ogre::Volume::ChunkHandler::mWorkQueueChannel
protected

The workqueue channel.

Definition at line 100 of file OgreVolumeChunkHandler.h.

WorkQueue* Ogre::Volume::ChunkHandler::mWQ
protected

The workqueue.

Definition at line 97 of file OgreVolumeChunkHandler.h.

const uint16 Ogre::Volume::ChunkHandler::WORKQUEUE_LOAD_REQUEST
staticprotected

The workqueue load request.

Definition at line 94 of file OgreVolumeChunkHandler.h.


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