Class to manage the scene object rendering queue. More...
#include <OgreRenderQueue.h>
Classes | |
class | RenderableListener |
Class to listen in on items being added to the render queue. More... | |
Public Types | |
typedef ConstMapIterator < RenderQueueGroupMap > | ConstQueueGroupIterator |
typedef MapIterator < RenderQueueGroupMap > | QueueGroupIterator |
Iterator over queue groups. More... | |
typedef map< uint8, RenderQueueGroup * >::type | RenderQueueGroupMap |
Public Member Functions | |
RenderQueue () | |
virtual | ~RenderQueue () |
QueueGroupIterator | _getQueueGroupIterator (void) |
Internal method, returns an iterator for the queue groups. More... | |
ConstQueueGroupIterator | _getQueueGroupIterator (void) const |
void | addRenderable (Renderable *pRend, uint8 groupID, ushort priority) |
Add a renderable object to the queue. More... | |
void | addRenderable (Renderable *pRend, uint8 groupId) |
Add a renderable object to the queue. More... | |
void | addRenderable (Renderable *pRend) |
Add a renderable object to the queue. More... | |
void | clear (bool destroyPassMaps=false) |
Empty the queue - should only be called by SceneManagers. More... | |
uint8 | getDefaultQueueGroup (void) const |
Gets the current default queue group, which will be used for all renderable which do not specify which group they wish to be on. More... | |
ushort | getDefaultRenderablePriority (void) const |
Gets the current default renderable priority, which will be used for all renderables which do not specify which priority they wish to use. More... | |
RenderQueueGroup * | getQueueGroup (uint8 qid) |
Get a render queue group. More... | |
RenderableListener * | getRenderableListener (void) const |
bool | getShadowCastersCannotBeReceivers (void) const |
Gets whether or not objects which cast shadows should be treated as never receiving shadows. More... | |
bool | getSplitNoShadowPasses (void) const |
Gets whether or not the queue will split passes which have shadow receive turned off (in their parent material), which is needed when certain shadow techniques are used. More... | |
bool | getSplitPassesByLightingType (void) const |
Gets whether or not the queue will split passes by their lighting type, ie ambient, per-light and decal. More... | |
void | merge (const RenderQueue *rhs) |
Merge render queue. More... | |
void | operator delete (void *ptr) |
void | operator delete (void *ptr, void *) |
void | operator delete (void *ptr, const char *, int, const char *) |
void | operator delete[] (void *ptr) |
void | operator delete[] (void *ptr, const char *, int, const char *) |
void * | operator new (size_t sz, const char *file, int line, const char *func) |
operator new, with debug line info More... | |
void * | operator new (size_t sz) |
void * | operator new (size_t sz, void *ptr) |
placement operator new More... | |
void * | operator new[] (size_t sz, const char *file, int line, const char *func) |
array operator new, with debug line info More... | |
void * | operator new[] (size_t sz) |
void | processVisibleObject (MovableObject *mo, Camera *cam, bool onlyShadowCasters, VisibleObjectsBoundsInfo *visibleBounds) |
Utility method to perform the standard actions associated with getting a visible object to add itself to the queue. More... | |
void | setDefaultQueueGroup (uint8 grp) |
Sets the current default queue group, which will be used for all renderable which do not specify which group they wish to be on. More... | |
void | setDefaultRenderablePriority (ushort priority) |
Sets the current default renderable priority, which will be used for all renderables which do not specify which priority they wish to use. More... | |
void | setRenderableListener (RenderableListener *listener) |
Set a renderable listener on the queue. More... | |
void | setShadowCastersCannotBeReceivers (bool ind) |
Sets whether or not objects which cast shadows should be treated as never receiving shadows. More... | |
void | setSplitNoShadowPasses (bool split) |
Sets whether or not the queue will split passes which have shadow receive turned off (in their parent material), which is needed when certain shadow techniques are used. More... | |
void | setSplitPassesByLightingType (bool split) |
Sets whether or not the queue will split passes by their lighting type, ie ambient, per-light and decal. More... | |
Protected Attributes | |
uint8 | mDefaultQueueGroup |
The current default queue group. More... | |
ushort | mDefaultRenderablePriority |
The default priority. More... | |
RenderQueueGroupMap | mGroups |
RenderableListener * | mRenderableListener |
bool | mShadowCastersCannotBeReceivers |
bool | mSplitNoShadowPasses |
bool | mSplitPassesByLightingType |
Class to manage the scene object rendering queue.
Definition at line 92 of file OgreRenderQueue.h.
Definition at line 99 of file OgreRenderQueue.h.
Iterator over queue groups.
Definition at line 98 of file OgreRenderQueue.h.
typedef map< uint8, RenderQueueGroup* >::type Ogre::RenderQueue::RenderQueueGroupMap |
Definition at line 96 of file OgreRenderQueue.h.
Ogre::RenderQueue::RenderQueue | ( | ) |
|
virtual |
QueueGroupIterator Ogre::RenderQueue::_getQueueGroupIterator | ( | void | ) |
Internal method, returns an iterator for the queue groups.
ConstQueueGroupIterator Ogre::RenderQueue::_getQueueGroupIterator | ( | void | ) | const |
void Ogre::RenderQueue::addRenderable | ( | Renderable * | pRend, |
uint8 | groupID, | ||
ushort | priority | ||
) |
Add a renderable object to the queue.
pRend | Pointer to the Renderable to be added to the queue |
groupID | The group the renderable is to be added to. This can be used to schedule renderable objects in separate groups such that the SceneManager respects the divisions between the groupings and does not reorder them outside these boundaries. This can be handy for overlays where no matter what you want the overlay to be rendered last. |
priority | Controls the priority of the renderable within the queue group. If this number is raised, the renderable will be rendered later in the group compared to it's peers. Don't use this unless you really need to, manually ordering renderables prevents OGRE from sorting them for best efficiency. However this could be useful for ordering 2D elements manually for example. |
void Ogre::RenderQueue::addRenderable | ( | Renderable * | pRend, |
uint8 | groupId | ||
) |
Add a renderable object to the queue.
pRend | Pointer to the Renderable to be added to the queue |
groupId | The group the renderable is to be added to. This can be used to schedule renderable objects in separate groups such that the SceneManager respects the divisions between the groupings and does not reorder them outside these boundaries. This can be handy for overlays where no matter what you want the overlay to be rendered last. |
void Ogre::RenderQueue::addRenderable | ( | Renderable * | pRend | ) |
Add a renderable object to the queue.
pRend | Pointer to the Renderable to be added to the queue |
void Ogre::RenderQueue::clear | ( | bool | destroyPassMaps = false | ) |
Empty the queue - should only be called by SceneManagers.
destroyPassMaps | Set to true to destroy all pass maps so that the queue is completely clean (useful when switching scene managers) |
uint8 Ogre::RenderQueue::getDefaultQueueGroup | ( | void | ) | const |
Gets the current default queue group, which will be used for all renderable which do not specify which group they wish to be on.
ushort Ogre::RenderQueue::getDefaultRenderablePriority | ( | void | ) | const |
Gets the current default renderable priority, which will be used for all renderables which do not specify which priority they wish to use.
RenderQueueGroup* Ogre::RenderQueue::getQueueGroup | ( | uint8 | qid | ) |
Get a render queue group.
|
inline |
Definition at line 286 of file OgreRenderQueue.h.
bool Ogre::RenderQueue::getShadowCastersCannotBeReceivers | ( | void | ) | const |
Gets whether or not objects which cast shadows should be treated as never receiving shadows.
bool Ogre::RenderQueue::getSplitNoShadowPasses | ( | void | ) | const |
Gets whether or not the queue will split passes which have shadow receive turned off (in their parent material), which is needed when certain shadow techniques are used.
bool Ogre::RenderQueue::getSplitPassesByLightingType | ( | void | ) | const |
Gets whether or not the queue will split passes by their lighting type, ie ambient, per-light and decal.
void Ogre::RenderQueue::merge | ( | const RenderQueue * | rhs | ) |
Merge render queue.
|
inlineinherited |
Definition at line 96 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 102 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 108 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 113 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 119 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
operator new, with debug line info
Definition at line 68 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 73 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
placement operator new
Definition at line 79 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
array operator new, with debug line info
Definition at line 86 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 91 of file OgreMemoryAllocatedObject.h.
void Ogre::RenderQueue::processVisibleObject | ( | MovableObject * | mo, |
Camera * | cam, | ||
bool | onlyShadowCasters, | ||
VisibleObjectsBoundsInfo * | visibleBounds | ||
) |
Utility method to perform the standard actions associated with getting a visible object to add itself to the queue.
This is a replacement for SceneManager implementations of the associated tasks related to calling MovableObject::_updateRenderQueue.
void Ogre::RenderQueue::setDefaultQueueGroup | ( | uint8 | grp | ) |
Sets the current default queue group, which will be used for all renderable which do not specify which group they wish to be on.
See the enum RenderQueueGroupID for what kind of values can be used here.
void Ogre::RenderQueue::setDefaultRenderablePriority | ( | ushort | priority | ) |
Sets the current default renderable priority, which will be used for all renderables which do not specify which priority they wish to use.
|
inline |
Set a renderable listener on the queue.
Definition at line 283 of file OgreRenderQueue.h.
void Ogre::RenderQueue::setShadowCastersCannotBeReceivers | ( | bool | ind | ) |
Sets whether or not objects which cast shadows should be treated as never receiving shadows.
void Ogre::RenderQueue::setSplitNoShadowPasses | ( | bool | split | ) |
Sets whether or not the queue will split passes which have shadow receive turned off (in their parent material), which is needed when certain shadow techniques are used.
void Ogre::RenderQueue::setSplitPassesByLightingType | ( | bool | split | ) |
Sets whether or not the queue will split passes by their lighting type, ie ambient, per-light and decal.
|
protected |
The current default queue group.
Definition at line 137 of file OgreRenderQueue.h.
|
protected |
The default priority.
Definition at line 139 of file OgreRenderQueue.h.
|
protected |
Definition at line 135 of file OgreRenderQueue.h.
|
protected |
Definition at line 145 of file OgreRenderQueue.h.
|
protected |
Definition at line 143 of file OgreRenderQueue.h.
|
protected |
Definition at line 142 of file OgreRenderQueue.h.
|
protected |
Definition at line 141 of file OgreRenderQueue.h.