<html>
<head>
<title>Ogre::RenderQueueGroup class Reference - OGRE Documentation</title> <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<link type="text/css" rel="stylesheet" href="style.css">
</head>
<body>
<!-- Generated by Doxygen 1.2.16 -->
<center>
<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="namespaces.html">Namespace List</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="namespacemembers.html">Namespace Members</a> <a class="qindex" href="functions.html">Compound Members</a> <a class="qindex" href="globals.html">File Members</a> <a class="qindex" href="pages.html">Related Pages</a> </center>
<hr><h1>Ogre::RenderQueueGroup Class Reference</h1>A grouping level underneath <a class="el" href="classOgre_1_1RenderQueue.html">RenderQueue</a> which groups renderables to be issued at coarsely the same time to the renderer.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="OgreRenderQueueSortingGrouping_8h-source.html">OgreRenderQueueSortingGrouping.h</a>></code>
<p>
<a href="classOgre_1_1RenderQueueGroup-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
<tr><td colspan=2><br><h2>Public Types</h2></td></tr>
<tr><td nowrap align=right valign=top>typedef std::map< <a class="el" href="namespaceOgre.html#a351">ushort</a>,<br>
<a class="el" href="classOgre_1_1RenderPriorityGroup.html">RenderPriorityGroup</a> *, std::less<<br>
<a class="el" href="namespaceOgre.html#a351">ushort</a> > > </td><td valign=bottom><a class="el" href="classOgre_1_1RenderQueueGroup.html#Ogre_1_1RenderQueueGroups0">PriorityMap</a></td></tr>
<tr><td nowrap align=right valign=top>typedef <a class="el" href="classOgre_1_1MapIterator.html">MapIterator</a>< <a class="el" href="classOgre_1_1RenderQueueGroup.html#Ogre_1_1RenderQueueGroups0">PriorityMap</a> > </td><td valign=bottom><a class="el" href="classOgre_1_1RenderQueueGroup.html#Ogre_1_1RenderQueueGroups1">PriorityMapIterator</a></td></tr>
<tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classOgre_1_1RenderQueueGroup.html#Ogre_1_1RenderQueueGroupa0">RenderQueueGroup</a> ()</td></tr>
<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classOgre_1_1RenderQueueGroup.html#Ogre_1_1RenderQueueGroupa1">~RenderQueueGroup</a> ()</td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="classOgre_1_1RenderQueueGroup.html#Ogre_1_1RenderQueueGroups1">PriorityMapIterator</a> </td><td valign=bottom><a class="el" href="classOgre_1_1RenderQueueGroup.html#Ogre_1_1RenderQueueGroupa2">getIterator</a> (void)</td></tr>
<tr><td> </td><td><font size=-1><em>Get an iterator for browsing through child contents.</em> <a href="#Ogre_1_1RenderQueueGroupa2"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classOgre_1_1RenderQueueGroup.html#Ogre_1_1RenderQueueGroupa3">addRenderable</a> (<a class="el" href="classOgre_1_1Renderable.html">Renderable</a> *pRend, <a class="el" href="namespaceOgre.html#a351">ushort</a> priority)</td></tr>
<tr><td> </td><td><font size=-1><em>Add a renderable to this group, with the given priority.</em> <a href="#Ogre_1_1RenderQueueGroupa3"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classOgre_1_1RenderQueueGroup.html#Ogre_1_1RenderQueueGroupa4">clear</a> (void)</td></tr>
<tr><td> </td><td><font size=-1><em>Clears this group of renderables.</em> <a href="#Ogre_1_1RenderQueueGroupa4"></a><em></em></font><br><br></td></tr>
<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="classOgre_1_1RenderQueueGroup.html#Ogre_1_1RenderQueueGroups0">PriorityMap</a> </td><td valign=bottom><a class="el" href="classOgre_1_1RenderQueueGroup.html#Ogre_1_1RenderQueueGroupn0">mPriorityGroups</a></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A grouping level underneath <a class="el" href="classOgre_1_1RenderQueue.html">RenderQueue</a> which groups renderables to be issued at coarsely the same time to the renderer.
<p>
<dl compact><dt><b>
Remarks: </b><dd>
Each instance of this class itself hold <a class="el" href="classOgre_1_1RenderPriorityGroup.html">RenderPriorityGroup</a> instances, which are the groupings of renderables by priority for fine control of ordering (not required for most instances).
<p>
This is an internal OGRE class, not intended for apps to use. </dl>
<p>
<p>
Definition at line <a class="el" href="OgreRenderQueueSortingGrouping_8h-source.html#l00249">249</a> of file <a class="el" href="OgreRenderQueueSortingGrouping_8h-source.html">OgreRenderQueueSortingGrouping.h</a>.<hr><h2>Member Typedef Documentation</h2>
<a name="Ogre_1_1RenderQueueGroups0" doxytag="Ogre::RenderQueueGroup::PriorityMap"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> typedef std::map<<a class="el" href="namespaceOgre.html#a351">ushort</a>, <a class="el" href="classOgre_1_1RenderPriorityGroup.html">RenderPriorityGroup</a>*, std::less<<a class="el" href="namespaceOgre.html#a351">ushort</a>> > Ogre::RenderQueueGroup::PriorityMap
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<p>
Definition at line <a class="el" href="OgreRenderQueueSortingGrouping_8h-source.html#l00252">252</a> of file <a class="el" href="OgreRenderQueueSortingGrouping_8h-source.html">OgreRenderQueueSortingGrouping.h</a>. </td>
</tr>
</table>
<a name="Ogre_1_1RenderQueueGroups1" doxytag="Ogre::RenderQueueGroup::PriorityMapIterator"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> typedef <a class="el" href="classOgre_1_1MapIterator.html">MapIterator</a><<a class="el" href="classOgre_1_1RenderQueueGroup.html#Ogre_1_1RenderQueueGroups0">PriorityMap</a>> Ogre::RenderQueueGroup::PriorityMapIterator
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<p>
Definition at line <a class="el" href="OgreRenderQueueSortingGrouping_8h-source.html#l00253">253</a> of file <a class="el" href="OgreRenderQueueSortingGrouping_8h-source.html">OgreRenderQueueSortingGrouping.h</a>.
<p>
Referenced by <a class="el" href="OgreRenderQueueSortingGrouping_8h-source.html#l00272">getIterator</a>(). </td>
</tr>
</table>
<hr><h2>Constructor & Destructor Documentation</h2>
<a name="Ogre_1_1RenderQueueGroupa0" doxytag="Ogre::RenderQueueGroup::RenderQueueGroup"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> Ogre::RenderQueueGroup::RenderQueueGroup </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<p>
Definition at line <a class="el" href="OgreRenderQueueSortingGrouping_8h-source.html#l00260">260</a> of file <a class="el" href="OgreRenderQueueSortingGrouping_8h-source.html">OgreRenderQueueSortingGrouping.h</a>. </td>
</tr>
</table>
<a name="Ogre_1_1RenderQueueGroupa1" doxytag="Ogre::RenderQueueGroup::~RenderQueueGroup"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> Ogre::RenderQueueGroup::~RenderQueueGroup </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<p>
Definition at line <a class="el" href="OgreRenderQueueSortingGrouping_8h-source.html#l00262">262</a> of file <a class="el" href="OgreRenderQueueSortingGrouping_8h-source.html">OgreRenderQueueSortingGrouping.h</a>.
<p>
References <a class="el" href="OgreRenderQueueSortingGrouping_8h-source.html#l00256">mPriorityGroups</a>. </td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a name="Ogre_1_1RenderQueueGroupa3" doxytag="Ogre::RenderQueueGroup::addRenderable"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void Ogre::RenderQueueGroup::addRenderable </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1Renderable.html">Renderable</a> * </td>
<td class="mdname" nowrap> <em>pRend</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap><a class="el" href="namespaceOgre.html#a351">ushort</a> </td>
<td class="mdname" nowrap> <em>priority</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Add a renderable to this group, with the given priority.
<p>
<p>
Definition at line <a class="el" href="OgreRenderQueueSortingGrouping_8h-source.html#l00278">278</a> of file <a class="el" href="OgreRenderQueueSortingGrouping_8h-source.html">OgreRenderQueueSortingGrouping.h</a>.
<p>
References <a class="el" href="OgreRenderQueueSortingGrouping_8h-source.html#l00154">Ogre::RenderPriorityGroup::addRenderable</a>(), <a class="el" href="OgreRenderQueueSortingGrouping_8h-source.html#l00256">mPriorityGroups</a>, and <a class="el" href="OgrePrerequisites_8h-source.html#l00115">Ogre::ushort</a>.
<p>
Referenced by <a class="el" href="OgreRenderQueue_8cpp-source.html#l00061">Ogre::RenderQueue::addRenderable</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1RenderQueueGroupa4" doxytag="Ogre::RenderQueueGroup::clear"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void Ogre::RenderQueueGroup::clear </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Clears this group of renderables.
<p>
<dl compact><dt><b>
Remarks: </b><dd>
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. </dl>
<p>
Definition at line <a class="el" href="OgreRenderQueueSortingGrouping_8h-source.html#l00305">305</a> of file <a class="el" href="OgreRenderQueueSortingGrouping_8h-source.html">OgreRenderQueueSortingGrouping.h</a>.
<p>
References <a class="el" href="OgreRenderQueueSortingGrouping_8h-source.html#l00256">mPriorityGroups</a>. </td>
</tr>
</table>
<a name="Ogre_1_1RenderQueueGroupa2" doxytag="Ogre::RenderQueueGroup::getIterator"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1RenderQueueGroup.html#Ogre_1_1RenderQueueGroups1">PriorityMapIterator</a> Ogre::RenderQueueGroup::getIterator </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Get an iterator for browsing through child contents.
<p>
<p>
Definition at line <a class="el" href="OgreRenderQueueSortingGrouping_8h-source.html#l00272">272</a> of file <a class="el" href="OgreRenderQueueSortingGrouping_8h-source.html">OgreRenderQueueSortingGrouping.h</a>.
<p>
References <a class="el" href="OgreRenderQueueSortingGrouping_8h-source.html#l00256">mPriorityGroups</a>, and <a class="el" href="OgreRenderQueueSortingGrouping_8h-source.html#l00253">PriorityMapIterator</a>.
<p>
Referenced by <a class="el" href="OgreSceneManager_8cpp-source.html#l01118">Ogre::SceneManager::_renderVisibleObjects</a>(). </td>
</tr>
</table>
<hr><h2>Member Data Documentation</h2>
<a name="Ogre_1_1RenderQueueGroupn0" doxytag="Ogre::RenderQueueGroup::mPriorityGroups"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1RenderQueueGroup.html#Ogre_1_1RenderQueueGroups0">PriorityMap</a> Ogre::RenderQueueGroup::mPriorityGroups<code> [protected]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<p>
Definition at line <a class="el" href="OgreRenderQueueSortingGrouping_8h-source.html#l00256">256</a> of file <a class="el" href="OgreRenderQueueSortingGrouping_8h-source.html">OgreRenderQueueSortingGrouping.h</a>.
<p>
Referenced by <a class="el" href="OgreRenderQueueSortingGrouping_8h-source.html#l00278">addRenderable</a>(), <a class="el" href="OgreRenderQueueSortingGrouping_8h-source.html#l00305">clear</a>(), <a class="el" href="OgreRenderQueueSortingGrouping_8h-source.html#l00272">getIterator</a>(), and <a class="el" href="OgreRenderQueueSortingGrouping_8h-source.html#l00262">~RenderQueueGroup</a>(). </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="OgreRenderQueueSortingGrouping_8h-source.html">OgreRenderQueueSortingGrouping.h</a></ul>
<p>
Copyright © 2002-2003 by The OGRE Team<br />
Last modified Wed Jan 21 00:19:27 2004
</p>
</body>
</html>
