Ogre::Volume::ChunkHandler Class Reference

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

`#include <OgreVolumeChunkHandler.h>`

Inheritance diagram for Ogre::Volume::ChunkHandler:
[legend]

## 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::Response * | handleRequest (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...
WorkQueue * | mWQ
| 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 90 of file OgreVolumeChunkHandler.h.

## Constructor & Destructor Documentation

## ChunkHandler()

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

Constructor.

## ~ChunkHandler()

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

virtual

Destructor.

## Member Function Documentation

## addRequest()

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

Adds a new ChunkRequest to be loaded to the WorkQueue.

Parameters

  req | The ChunkRequest.

## canHandleRequest()

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().

## canHandleResponse()

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().

## handleRequest()

WorkQueue::Response* Ogre::Volume::ChunkHandler::handleRequest | ( | const WorkQueue::Request * | req,
|  | const WorkQueue * | srcQ
| ) |  |

virtual

Implementation for WorkQueue::RequestHandler.

Implements Ogre::WorkQueue::RequestHandler.

## handleResponse()

void Ogre::Volume::ChunkHandler::handleResponse | ( | const WorkQueue::Response * | res,
|  | const WorkQueue * | srcQ
| ) |  |

virtual

Implementation for WorkQueue::ResponseHandler.

Implements Ogre::WorkQueue::ResponseHandler.

## init()

void Ogre::Volume::ChunkHandler::init | ( | void |  | ) |

protected

Initializes the WorkQueue (once).

## processWorkQueue()

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

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

## Member Data Documentation

## mWorkQueueChannel

uint16 Ogre::Volume::ChunkHandler::mWorkQueueChannel

protected

The workqueue channel.

Definition at line 101 of file OgreVolumeChunkHandler.h.

## mWQ

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

protected

The workqueue.

Definition at line 98 of file OgreVolumeChunkHandler.h.

## WORKQUEUE_LOAD_REQUEST

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

Copyright © 2012 Torus Knot Software Ltd
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.