Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Related Pages  

Ogre::RenderQueueGroup Class Reference

A grouping level underneath RenderQueue which groups renderables to be issued at coarsely the same time to the renderer. More...

#include <OgreRenderQueueSortingGrouping.h>

List of all members.

Public Types

typedef std::map< ushort,
RenderPriorityGroup *, std::less<
ushort > > 
PriorityMap
typedef MapIterator< PriorityMapPriorityMapIterator

Public Methods

 RenderQueueGroup ()
 ~RenderQueueGroup ()
PriorityMapIterator getIterator (void)
 Get an iterator for browsing through child contents.

void addRenderable (Renderable *pRend, ushort priority)
 Add a renderable to this group, with the given priority.

void clear (void)
 Clears this group of renderables.


Protected Attributes

PriorityMap mPriorityGroups


Detailed Description

A grouping level underneath RenderQueue which groups renderables to be issued at coarsely the same time to the renderer.

Remarks:
Each instance of this class itself hold RenderPriorityGroup instances, which are the groupings of renderables by priority for fine control of ordering (not required for most instances).

This is an internal OGRE class, not intended for apps to use.

Definition at line 249 of file OgreRenderQueueSortingGrouping.h.


Member Typedef Documentation

typedef std::map<ushort, RenderPriorityGroup*, std::less<ushort> > Ogre::RenderQueueGroup::PriorityMap
 

Definition at line 252 of file OgreRenderQueueSortingGrouping.h.

typedef MapIterator<PriorityMap> Ogre::RenderQueueGroup::PriorityMapIterator
 

Definition at line 253 of file OgreRenderQueueSortingGrouping.h.

Referenced by getIterator().


Constructor & Destructor Documentation

Ogre::RenderQueueGroup::RenderQueueGroup  
 

Definition at line 260 of file OgreRenderQueueSortingGrouping.h.

Ogre::RenderQueueGroup::~RenderQueueGroup  
 

Definition at line 262 of file OgreRenderQueueSortingGrouping.h.

References mPriorityGroups.


Member Function Documentation

void Ogre::RenderQueueGroup::addRenderable Renderable   pRend,
ushort    priority
 

Add a renderable to this group, with the given priority.

Definition at line 278 of file OgreRenderQueueSortingGrouping.h.

References Ogre::RenderPriorityGroup::addRenderable(), mPriorityGroups, and Ogre::ushort.

Referenced by Ogre::RenderQueue::addRenderable().

void Ogre::RenderQueueGroup::clear void   
 

Clears this group of renderables.

Remarks:
Doesn't delete any priority groups, just empties them. Saves on memory deallocations since the chances are rougly the same kinds of renderables are going to be sent to the queue again next time.

Definition at line 305 of file OgreRenderQueueSortingGrouping.h.

References mPriorityGroups.

PriorityMapIterator Ogre::RenderQueueGroup::getIterator void   
 

Get an iterator for browsing through child contents.

Definition at line 272 of file OgreRenderQueueSortingGrouping.h.

References mPriorityGroups, and PriorityMapIterator.

Referenced by Ogre::SceneManager::_renderVisibleObjects().


Member Data Documentation

PriorityMap Ogre::RenderQueueGroup::mPriorityGroups [protected]
 

Definition at line 256 of file OgreRenderQueueSortingGrouping.h.

Referenced by addRenderable(), clear(), getIterator(), and ~RenderQueueGroup().


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

Copyright © 2002-2003 by The OGRE Team
Last modified Wed Jan 21 00:19:27 2004