source: OGRE/trunk/ogrenew/Docs/api/html/classOgre_1_1RenderQueueListener.html @ 692

Revision 692, 12.4 KB checked in by mattausch, 18 years ago (diff)

adding ogre 1.2 and dependencies
Line 
1<html>
2<head>
3<title>Ogre::RenderQueueListener class Reference - OGRE Documentation</title> <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
4<link type="text/css" rel="stylesheet" href="style.css">
5</head>
6
7<body>
8<!-- Generated by Doxygen 1.3.6 -->
9<div class="qindex"><a class="qindex" href="index.html">Main&nbsp;Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class&nbsp;Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical&nbsp;List</a> | <a class="qindex" href="annotated.html">Class&nbsp;List</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="namespacemembers.html">Namespace&nbsp;Members</a> | <a class="qindex" href="functions.html">Class&nbsp;Members</a> | <a class="qindex" href="globals.html">File&nbsp;Members</a> | <a class="qindex" href="pages.html">Related&nbsp;Pages</a></div>
10<h1>Ogre::RenderQueueListener Class Reference</h1>Abstract interface which classes must implement if they wish to receive events from the render queue. 
11<a href="#_details">More...</a>
12<p>
13<code>#include &lt;<a class="el" href="OgreRenderQueueListener_8h-source.html">OgreRenderQueueListener.h</a>&gt;</code>
14<p>
15<p>Inheritance diagram for Ogre::RenderQueueListener:
16<p><center><img src="classOgre_1_1RenderQueueListener.png" usemap="#Ogre::RenderQueueListener_map" border="0" alt=""></center>
17<map name="Ogre::RenderQueueListener_map">
18<area href="classOgre_1_1CompositorChain_1_1RQListener.html" alt="Ogre::CompositorChain::RQListener" shape="rect" coords="0,56,212,80">
19</map>
20<a href="classOgre_1_1RenderQueueListener-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
21<tr><td></td></tr>
22<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
23<tr><td class="memItemLeft" nowrap align=right valign=top>virtual&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1RenderQueueListener.html#Ogre_1_1RenderQueueListenera0">~RenderQueueListener</a> ()</td></tr>
24
25<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1RenderQueueListener.html#Ogre_1_1RenderQueueListenera1">renderQueueStarted</a> (<a class="el" href="namespaceOgre.html#a457">uint8</a> queueGroupId, const <a class="el" href="namespaceOgre.html#a471">String</a> &amp;invocation, bool &amp;skipThisInvocation)=0</td></tr>
26
27<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Event raised before a queue group is rendered.  <a href="#Ogre_1_1RenderQueueListenera1"></a><br><br></td></tr>
28<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1RenderQueueListener.html#Ogre_1_1RenderQueueListenera2">renderQueueEnded</a> (<a class="el" href="namespaceOgre.html#a457">uint8</a> queueGroupId, const <a class="el" href="namespaceOgre.html#a471">String</a> &amp;invocation, bool &amp;repeatThisInvocation)=0</td></tr>
29
30<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Event raised after a queue group is rendered.  <a href="#Ogre_1_1RenderQueueListenera2"></a><br><br></td></tr>
31</table>
32<hr><a name="_details"></a><h2>Detailed Description</h2>
33Abstract interface which classes must implement if they wish to receive events from the render queue.
34<p>
35<dl compact><dt><b>Remarks:</b></dt><dd>The OGRE render queue is divided into several queue groups, as defined by uint8. A class may implement this interface, and register itself as a listener by calling <a class="el" href="classOgre_1_1SceneManager.html#Ogre_1_1TerrainSceneManagera162">SceneManager::addRenderQueueListener</a>. After doing so, the class will receive an event before and after each queue group is sent to the rendering system. </dd></dl>
36<dl compact><dt><b></b></dt><dd>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. </dd></dl>
37
38<p>
39
40<p>
41Definition 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>Constructor &amp; Destructor Documentation</h2>
42<a class="anchor" name="Ogre_1_1RenderQueueListenera0" doxytag="Ogre::RenderQueueListener::~RenderQueueListener" ></a><p>
43<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
44  <tr>
45    <td class="mdRow">
46      <table cellpadding="0" cellspacing="0" border="0">
47        <tr>
48          <td class="md" nowrap valign="top"> virtual Ogre::RenderQueueListener::~<a class="el" href="classOgre_1_1RenderQueueListener.html">RenderQueueListener</a> </td>
49          <td class="md" valign="top">(&nbsp;</td>
50          <td class="mdname1" valign="top" nowrap>          </td>
51          <td class="md" valign="top">&nbsp;)&nbsp;</td>
52          <td class="md" nowrap><code> [virtual]</code></td>
53        </tr>
54
55      </table>
56    </td>
57  </tr>
58</table>
59<table cellspacing=5 cellpadding=0 border=0>
60  <tr>
61    <td>
62      &nbsp;
63    </td>
64    <td>
65
66<p>
67
68<p>
69Definition at line <a class="el" href="OgreRenderQueueListener_8h-source.html#l00050">50</a> of file <a class="el" href="OgreRenderQueueListener_8h-source.html">OgreRenderQueueListener.h</a>.    </td>
70  </tr>
71</table>
72<hr><h2>Member Function Documentation</h2>
73<a class="anchor" name="Ogre_1_1RenderQueueListenera2" doxytag="Ogre::RenderQueueListener::renderQueueEnded" ></a><p>
74<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
75  <tr>
76    <td class="mdRow">
77      <table cellpadding="0" cellspacing="0" border="0">
78        <tr>
79          <td class="md" nowrap valign="top"> virtual void Ogre::RenderQueueListener::renderQueueEnded </td>
80          <td class="md" valign="top">(&nbsp;</td>
81          <td class="md" nowrap valign="top"><a class="el" href="namespaceOgre.html#a457">uint8</a>&nbsp;</td>
82          <td class="mdname" nowrap> <em>queueGroupId</em>, </td>
83        </tr>
84        <tr>
85          <td class="md" nowrap align="right"></td>
86          <td></td>
87          <td class="md" nowrap>const <a class="el" href="namespaceOgre.html#a471">String</a> &amp;&nbsp;</td>
88          <td class="mdname" nowrap> <em>invocation</em>, </td>
89        </tr>
90        <tr>
91          <td class="md" nowrap align="right"></td>
92          <td></td>
93          <td class="md" nowrap>bool &amp;&nbsp;</td>
94          <td class="mdname" nowrap> <em>repeatThisInvocation</em></td>
95        </tr>
96        <tr>
97          <td></td>
98          <td class="md">)&nbsp;</td>
99          <td class="md" colspan="2"><code> [pure virtual]</code></td>
100        </tr>
101
102      </table>
103    </td>
104  </tr>
105</table>
106<table cellspacing=5 cellpadding=0 border=0>
107  <tr>
108    <td>
109      &nbsp;
110    </td>
111    <td>
112
113<p>
114Event raised after a queue group is rendered.
115<p>
116<dl compact><dt><b>Remarks:</b></dt><dd>This method is called by the <a class="el" href="classOgre_1_1SceneManager.html">SceneManager</a> after each queue group is rendered. </dd></dl>
117<dl compact><dt><b>Parameters:</b></dt><dd>
118  <table border="0" cellspacing="2" cellpadding="0">
119    <tr><td valign=top><em>queueGroupId</em>&nbsp;</td><td>The id of the queue group which has just been rendered </td></tr>
120    <tr><td valign=top><em>invocation</em>&nbsp;</td><td>Name of the invocation which is causing this to be called (</td></tr>
121  </table>
122</dl>
123<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="classOgre_1_1RenderQueueInvocation.html">RenderQueueInvocation</a>) </dd></dl>
124<dl compact><dt><b>Parameters:</b></dt><dd>
125  <table border="0" cellspacing="2" cellpadding="0">
126    <tr><td valign=top><em>repeatThisInvocation</em>&nbsp;</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>
127  </table>
128</dl>
129
130<p>
131Implemented in <a class="el" href="classOgre_1_1CompositorChain_1_1RQListener.html#Ogre_1_1CompositorChain_1_1RQListenera1">Ogre::CompositorChain::RQListener</a>.    </td>
132  </tr>
133</table>
134<a class="anchor" name="Ogre_1_1RenderQueueListenera1" doxytag="Ogre::RenderQueueListener::renderQueueStarted" ></a><p>
135<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
136  <tr>
137    <td class="mdRow">
138      <table cellpadding="0" cellspacing="0" border="0">
139        <tr>
140          <td class="md" nowrap valign="top"> virtual void Ogre::RenderQueueListener::renderQueueStarted </td>
141          <td class="md" valign="top">(&nbsp;</td>
142          <td class="md" nowrap valign="top"><a class="el" href="namespaceOgre.html#a457">uint8</a>&nbsp;</td>
143          <td class="mdname" nowrap> <em>queueGroupId</em>, </td>
144        </tr>
145        <tr>
146          <td class="md" nowrap align="right"></td>
147          <td></td>
148          <td class="md" nowrap>const <a class="el" href="namespaceOgre.html#a471">String</a> &amp;&nbsp;</td>
149          <td class="mdname" nowrap> <em>invocation</em>, </td>
150        </tr>
151        <tr>
152          <td class="md" nowrap align="right"></td>
153          <td></td>
154          <td class="md" nowrap>bool &amp;&nbsp;</td>
155          <td class="mdname" nowrap> <em>skipThisInvocation</em></td>
156        </tr>
157        <tr>
158          <td></td>
159          <td class="md">)&nbsp;</td>
160          <td class="md" colspan="2"><code> [pure virtual]</code></td>
161        </tr>
162
163      </table>
164    </td>
165  </tr>
166</table>
167<table cellspacing=5 cellpadding=0 border=0>
168  <tr>
169    <td>
170      &nbsp;
171    </td>
172    <td>
173
174<p>
175Event raised before a queue group is rendered.
176<p>
177<dl compact><dt><b>Remarks:</b></dt><dd>This method is called by the <a class="el" href="classOgre_1_1SceneManager.html">SceneManager</a> before each queue group is rendered. </dd></dl>
178<dl compact><dt><b>Parameters:</b></dt><dd>
179  <table border="0" cellspacing="2" cellpadding="0">
180    <tr><td valign=top><em>queueGroupId</em>&nbsp;</td><td>The id of the queue group which is about to be rendered </td></tr>
181    <tr><td valign=top><em>invocation</em>&nbsp;</td><td>Name of the invocation which is causing this to be called (</td></tr>
182  </table>
183</dl>
184<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="classOgre_1_1RenderQueueInvocation.html">RenderQueueInvocation</a>) </dd></dl>
185<dl compact><dt><b>Parameters:</b></dt><dd>
186  <table border="0" cellspacing="2" cellpadding="0">
187    <tr><td valign=top><em>skipThisInvocation</em>&nbsp;</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>
188  </table>
189</dl>
190
191<p>
192Implemented in <a class="el" href="classOgre_1_1CompositorChain_1_1RQListener.html#Ogre_1_1CompositorChain_1_1RQListenera0">Ogre::CompositorChain::RQListener</a>.    </td>
193  </tr>
194</table>
195<hr>The documentation for this class was generated from the following file:<ul>
196<li><a class="el" href="OgreRenderQueueListener_8h-source.html">OgreRenderQueueListener.h</a></ul>
197<hr>
198<p>
199Copyright &copy; 2000-2005 by The OGRE Team<br />
200<!--Creative Commons License--><a rel="license" href="http://creativecommons.org/licenses/by-sa/2.5/"><img alt="Creative Commons License" border="0" src="http://creativecommons.org/images/public/somerights20.png"/></a><br/>
201This work is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-sa/2.5/">Creative Commons Attribution-ShareAlike 2.5 License</a>.<br/>
202                <!--/Creative Commons License--><!-- <rdf:RDF xmlns="http://web.resource.org/cc/" xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#">
203                <Work rdf:about="">
204                        <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" />
205        <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" />
206                </Work>
207                <License rdf:about="http://creativecommons.org/licenses/by-sa/2.5/"><permits rdf:resource="http://web.resource.org/cc/Reproduction"/><permits rdf:resource="http://web.resource.org/cc/Distribution"/><requires rdf:resource="http://web.resource.org/cc/Notice"/><requires rdf:resource="http://web.resource.org/cc/Attribution"/><permits rdf:resource="http://web.resource.org/cc/DerivativeWorks"/><requires rdf:resource="http://web.resource.org/cc/ShareAlike"/></License></rdf:RDF> -->
208
209Last modified Sun Mar 12 14:42:05 2006
210</p>
211</body>
212</html>
Note: See TracBrowser for help on using the repository browser.