<html>
<head>
<title>Ogre::RenderQueueListener 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::RenderQueueListener Class Reference</h1>Abstract interface which classes must implement if they wish to receive events from the render queue.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="OgreRenderQueueListener_8h-source.html">OgreRenderQueueListener.h</a>></code>
<p>
<a href="classOgre_1_1RenderQueueListener-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
<tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classOgre_1_1RenderQueueListener.html#Ogre_1_1RenderQueueListenera0">renderQueueStarted</a> (<a class="el" href="namespaceOgre.html#a638">RenderQueueGroupID</a> id, bool &skipThisQueue)=0</td></tr>
<tr><td> </td><td><font size=-1><em>Event raised before a queue group is rendered.</em> <a href="#Ogre_1_1RenderQueueListenera0"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classOgre_1_1RenderQueueListener.html#Ogre_1_1RenderQueueListenera1">renderQueueEnded</a> (<a class="el" href="namespaceOgre.html#a638">RenderQueueGroupID</a> id, bool &repeatThisQueue)=0</td></tr>
<tr><td> </td><td><font size=-1><em>Event raised after a queue group is rendered.</em> <a href="#Ogre_1_1RenderQueueListenera1"></a><em></em></font><br><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Abstract interface which classes must implement if they wish to receive events from the render queue.
<p>
<dl compact><dt><b>
Remarks: </b><dd>
The OGRE render queue is divided into several queue groups, as defined by RenderQueueGroupID. A class may implement this interface, and register itself as a listener by calling <a class="el" href="classOgre_1_1SceneManager.html#Ogre_1_1TerrainSceneManagera90">SceneManager::addRenderQueueListener</a>. After doing so, the class will receive an event before and after each queue group is sent to the rendering system.
<p>
The event listeners have an option to make a queue either be skipped, or to repeat. Note that if multiple listeners are registered, the one registered last has the final say, although options set by previous listeners will not be changed if the latest does not express a preference. </dl>
<p>
<p>
Definition at line <a class="el" href="OgreRenderQueueListener_8h-source.html#l00047">47</a> of file <a class="el" href="OgreRenderQueueListener_8h-source.html">OgreRenderQueueListener.h</a>.<hr><h2>Member Function Documentation</h2>
<a name="Ogre_1_1RenderQueueListenera1" doxytag="Ogre::RenderQueueListener::renderQueueEnded"></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"> virtual void Ogre::RenderQueueListener::renderQueueEnded </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="namespaceOgre.html#a638">RenderQueueGroupID</a> </td>
<td class="mdname" nowrap> <em>id</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>bool & </td>
<td class="mdname" nowrap> <em>repeatThisQueue</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Event raised after a queue group is rendered.
<p>
<dl compact><dt><b>
Remarks: </b><dd>
This method is called by the <a class="el" href="classOgre_1_1SceneManager.html">SceneManager</a> after each queue group is rendered. </dl><dl compact><dt><b>
Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>id</em> </td><td>
The id of the queue group which has just been rendered </td></tr>
<tr><td valign=top><em>repeatThisQueue</em> </td><td>
A boolean passed by reference which is by default set to false. If the event sets this to true, the queue which has just been rendered will be repeated, and the renderQueueStarted and renderQueueEnded events will also be fired for it again. </td></tr>
</table>
</dl> </td>
</tr>
</table>
<a name="Ogre_1_1RenderQueueListenera0" doxytag="Ogre::RenderQueueListener::renderQueueStarted"></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"> virtual void Ogre::RenderQueueListener::renderQueueStarted </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="namespaceOgre.html#a638">RenderQueueGroupID</a> </td>
<td class="mdname" nowrap> <em>id</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>bool & </td>
<td class="mdname" nowrap> <em>skipThisQueue</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Event raised before a queue group is rendered.
<p>
<dl compact><dt><b>
Remarks: </b><dd>
This method is called by the <a class="el" href="classOgre_1_1SceneManager.html">SceneManager</a> before each queue group is rendered. </dl><dl compact><dt><b>
Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>id</em> </td><td>
The id of the queue group which is about to be rendered </td></tr>
<tr><td valign=top><em>skipThisQueue</em> </td><td>
A boolean passed by reference which is by default set to false. If the event sets this to true, the queue will be skipped and not rendered. Note that in this case the renderQueueEnded event will not be raised for this queue group. </td></tr>
</table>
</dl> </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="OgreRenderQueueListener_8h-source.html">OgreRenderQueueListener.h</a></ul>
<p>
Copyright © 2002-2003 by The OGRE Team<br />
Last modified Wed Jan 21 00:19:27 2004
</p>
</body>
</html>
