Ogre::Volume::ChunkHandler Class Reference

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

#include <OgreVolumeChunkHandler.h>

Inheritance diagram for Ogre::Volume::ChunkHandler:

List of all members.

Public Member Functions
	ChunkHandler (void)
	Constructor.
virtual	~ChunkHandler (void)
	Destructor.
void	addRequest (const ChunkRequest &req)
	Adds a new ChunkRequest to be loaded to the WorkQueue.
virtual bool	canHandleRequest (const Request *req, const WorkQueue *srcQ)
	Return whether this handler can process a given request.
virtual bool	canHandleResponse (const Response *res, const WorkQueue *srcQ)
	Return whether this handler can process a given response.
WorkQueue::Response *	handleRequest (const WorkQueue::Request *req, const WorkQueue *srcQ)
	Implementation for WorkQueue::RequestHandler.
void	handleResponse (const WorkQueue::Response *res, const WorkQueue *srcQ)
	Implementation for WorkQueue::ResponseHandler.
void	processWorkQueue (void)
	Calls the process-update of the WorkQueue so it doesn't block.
Protected Member Functions
void	init (void)
	Initializes the WorkQueue (once).
Protected Attributes
uint16	mWorkQueueChannel
	The workqueue channel.
WorkQueue *	mWQ
	The workqueue.
Static Protected Attributes
static const uint16	WORKQUEUE_LOAD_REQUEST
	The workqueue load request.

---

Detailed Description

Handles the WorkQueue management of the chunks.

Definition at line 90 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:

req	The ChunkRequest.

virtual bool Ogre::WorkQueue::RequestHandler::canHandleRequest	(	const Request *	req,
		const WorkQueue *	srcQ
	)		[virtual, inherited]

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 173 of file OgreWorkQueue.h.

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

virtual bool Ogre::WorkQueue::ResponseHandler::canHandleResponse	(	const Response *	res,
		const WorkQueue *	srcQ
	)		[virtual, inherited]

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 208 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]

Implementation for WorkQueue::RequestHandler.

Implements Ogre::WorkQueue::RequestHandler.

void Ogre::Volume::ChunkHandler::handleResponse	(	const WorkQueue::Response *	res,
		const WorkQueue *	srcQ
	)		[virtual]

Implementation for WorkQueue::ResponseHandler.

Implements Ogre::WorkQueue::ResponseHandler.

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 101 of file OgreVolumeChunkHandler.h.

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

The workqueue.

Definition at line 98 of file OgreVolumeChunkHandler.h.

const uint16 Ogre::Volume::ChunkHandler::WORKQUEUE_LOAD_REQUEST [static, protected]

The workqueue load request.

Definition at line 95 of file OgreVolumeChunkHandler.h.

---

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

• OgreVolumeChunkHandler.h