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

Revision 657, 10.4 KB checked in by mattausch, 18 years ago (diff)

added ogre dependencies and patched ogre sources
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<a href="classOgre_1_1RenderQueueListener-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
16<tr><td></td></tr>
17<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
18<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>
19
20<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#a669">RenderQueueGroupID</a> <a class="el" href="OgreGLPrerequisites_8h.html#a86">id</a>, bool &amp;skipThisQueue)=0</td></tr>
21
22<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>
23<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#a669">RenderQueueGroupID</a> <a class="el" href="OgreGLPrerequisites_8h.html#a86">id</a>, bool &amp;repeatThisQueue)=0</td></tr>
24
25<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>
26</table>
27<hr><a name="_details"></a><h2>Detailed Description</h2>
28Abstract interface which classes must implement if they wish to receive events from the render queue.
29<p>
30<dl compact><dt><b>Remarks:</b></dt><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_1TerrainSceneManagera129">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>
31<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>
32
33<p>
34
35<p>
36Definition 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>
37<a class="anchor" name="Ogre_1_1RenderQueueListenera0" doxytag="Ogre::RenderQueueListener::~RenderQueueListener" ></a><p>
38<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
39  <tr>
40    <td class="mdRow">
41      <table cellpadding="0" cellspacing="0" border="0">
42        <tr>
43          <td class="md" nowrap valign="top"> virtual Ogre::RenderQueueListener::~<a class="el" href="classOgre_1_1RenderQueueListener.html">RenderQueueListener</a> </td>
44          <td class="md" valign="top">(&nbsp;</td>
45          <td class="mdname1" valign="top" nowrap>          </td>
46          <td class="md" valign="top">&nbsp;)&nbsp;</td>
47          <td class="md" nowrap><code> [virtual]</code></td>
48        </tr>
49
50      </table>
51    </td>
52  </tr>
53</table>
54<table cellspacing=5 cellpadding=0 border=0>
55  <tr>
56    <td>
57      &nbsp;
58    </td>
59    <td>
60
61<p>
62
63<p>
64Definition 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>
65  </tr>
66</table>
67<hr><h2>Member Function Documentation</h2>
68<a class="anchor" name="Ogre_1_1RenderQueueListenera2" doxytag="Ogre::RenderQueueListener::renderQueueEnded" ></a><p>
69<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
70  <tr>
71    <td class="mdRow">
72      <table cellpadding="0" cellspacing="0" border="0">
73        <tr>
74          <td class="md" nowrap valign="top"> virtual void Ogre::RenderQueueListener::renderQueueEnded </td>
75          <td class="md" valign="top">(&nbsp;</td>
76          <td class="md" nowrap valign="top"><a class="el" href="namespaceOgre.html#a669">RenderQueueGroupID</a>&nbsp;</td>
77          <td class="mdname" nowrap> <em>id</em>, </td>
78        </tr>
79        <tr>
80          <td class="md" nowrap align="right"></td>
81          <td></td>
82          <td class="md" nowrap>bool &amp;&nbsp;</td>
83          <td class="mdname" nowrap> <em>repeatThisQueue</em></td>
84        </tr>
85        <tr>
86          <td></td>
87          <td class="md">)&nbsp;</td>
88          <td class="md" colspan="2"><code> [pure virtual]</code></td>
89        </tr>
90
91      </table>
92    </td>
93  </tr>
94</table>
95<table cellspacing=5 cellpadding=0 border=0>
96  <tr>
97    <td>
98      &nbsp;
99    </td>
100    <td>
101
102<p>
103Event raised after a queue group is rendered.
104<p>
105<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>
106<dl compact><dt><b>Parameters:</b></dt><dd>
107  <table border="0" cellspacing="2" cellpadding="0">
108    <tr><td valign=top><em>id</em>&nbsp;</td><td>The id of the queue group which has just been rendered </td></tr>
109    <tr><td valign=top><em>repeatThisQueue</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>
110  </table>
111</dl>
112    </td>
113  </tr>
114</table>
115<a class="anchor" name="Ogre_1_1RenderQueueListenera1" doxytag="Ogre::RenderQueueListener::renderQueueStarted" ></a><p>
116<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
117  <tr>
118    <td class="mdRow">
119      <table cellpadding="0" cellspacing="0" border="0">
120        <tr>
121          <td class="md" nowrap valign="top"> virtual void Ogre::RenderQueueListener::renderQueueStarted </td>
122          <td class="md" valign="top">(&nbsp;</td>
123          <td class="md" nowrap valign="top"><a class="el" href="namespaceOgre.html#a669">RenderQueueGroupID</a>&nbsp;</td>
124          <td class="mdname" nowrap> <em>id</em>, </td>
125        </tr>
126        <tr>
127          <td class="md" nowrap align="right"></td>
128          <td></td>
129          <td class="md" nowrap>bool &amp;&nbsp;</td>
130          <td class="mdname" nowrap> <em>skipThisQueue</em></td>
131        </tr>
132        <tr>
133          <td></td>
134          <td class="md">)&nbsp;</td>
135          <td class="md" colspan="2"><code> [pure virtual]</code></td>
136        </tr>
137
138      </table>
139    </td>
140  </tr>
141</table>
142<table cellspacing=5 cellpadding=0 border=0>
143  <tr>
144    <td>
145      &nbsp;
146    </td>
147    <td>
148
149<p>
150Event raised before a queue group is rendered.
151<p>
152<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>
153<dl compact><dt><b>Parameters:</b></dt><dd>
154  <table border="0" cellspacing="2" cellpadding="0">
155    <tr><td valign=top><em>id</em>&nbsp;</td><td>The id of the queue group which is about to be rendered </td></tr>
156    <tr><td valign=top><em>skipThisQueue</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>
157  </table>
158</dl>
159    </td>
160  </tr>
161</table>
162<hr>The documentation for this class was generated from the following file:<ul>
163<li><a class="el" href="OgreRenderQueueListener_8h-source.html">OgreRenderQueueListener.h</a></ul>
164<hr>
165<p>
166Copyright &copy; 2000-2005 by The OGRE Team<br />
167<!--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/>
168This 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/>
169                <!--/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#">
170                <Work rdf:about="">
171                        <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" />
172        <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" />
173                </Work>
174                <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> -->
175
176Last modified Sun Feb 12 13:02:23 2006
177</p>
178</body>
179</html>
Note: See TracBrowser for help on using the repository browser.