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

Revision 692, 34.2 KB checked in by mattausch, 19 years ago (diff)

adding ogre 1.2 and dependencies
Line 
1<html>
2<head>
3<title>Ogre::RenderQueueInvocation 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::RenderQueueInvocation Class Reference</h1>Class representing the invocation of queue groups in a <a class="el" href="classOgre_1_1RenderQueue.html">RenderQueue</a>. 
11<a href="#_details">More...</a>
12<p>
13<code>#include &lt;<a class="el" href="OgreRenderQueueInvocation_8h-source.html">OgreRenderQueueInvocation.h</a>&gt;</code>
14<p>
15<a href="classOgre_1_1RenderQueueInvocation-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>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1RenderQueueInvocation.html#Ogre_1_1RenderQueueInvocationa0">RenderQueueInvocation</a> (<a class="el" href="namespaceOgre.html#a457">uint8</a> renderQueueGroupID, const <a class="el" href="namespaceOgre.html#a471">String</a> &amp;invocationName=<a class="el" href="classOgre_1_1StringUtil.html#Ogre_1_1StringUtils0">StringUtil::BLANK</a>)</td></tr>
19
20<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor.  <a href="#Ogre_1_1RenderQueueInvocationa0"></a><br><br></td></tr>
21<tr><td class="memItemLeft" nowrap align=right valign=top>virtual&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1RenderQueueInvocation.html#Ogre_1_1RenderQueueInvocationa1">~RenderQueueInvocation</a> ()</td></tr>
22
23<tr><td class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="namespaceOgre.html#a457">uint8</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1RenderQueueInvocation.html#Ogre_1_1RenderQueueInvocationa2">getRenderQueueGroupID</a> (void) const </td></tr>
24
25<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the render queue group id.  <a href="#Ogre_1_1RenderQueueInvocationa2"></a><br><br></td></tr>
26<tr><td class="memItemLeft" nowrap align=right valign=top>virtual const <a class="el" href="namespaceOgre.html#a471">String</a> &amp;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1RenderQueueInvocation.html#Ogre_1_1RenderQueueInvocationa3">getInvocationName</a> (void) const </td></tr>
27
28<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the invocation name (may be blank if not set by creator).  <a href="#Ogre_1_1RenderQueueInvocationa3"></a><br><br></td></tr>
29<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1RenderQueueInvocation.html#Ogre_1_1RenderQueueInvocationa4">setSolidsOrganisation</a> (<a class="el" href="classOgre_1_1QueuedRenderableCollection.html#Ogre_1_1QueuedRenderableCollectionw3">QueuedRenderableCollection::OrganisationMode</a> org)</td></tr>
30
31<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the organisation mode being used for solids in this queue group invocation.  <a href="#Ogre_1_1RenderQueueInvocationa4"></a><br><br></td></tr>
32<tr><td class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="classOgre_1_1QueuedRenderableCollection.html#Ogre_1_1QueuedRenderableCollectionw3">QueuedRenderableCollection::OrganisationMode</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1RenderQueueInvocation.html#Ogre_1_1RenderQueueInvocationa5">getSolidsOrganisation</a> (void) const </td></tr>
33
34<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the organisation mode being used for solids in this queue group invocation.  <a href="#Ogre_1_1RenderQueueInvocationa5"></a><br><br></td></tr>
35<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1RenderQueueInvocation.html#Ogre_1_1RenderQueueInvocationa6">setSuppressShadows</a> (bool suppress)</td></tr>
36
37<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets whether shadows are suppressed when invoking this queue.  <a href="#Ogre_1_1RenderQueueInvocationa6"></a><br><br></td></tr>
38<tr><td class="memItemLeft" nowrap align=right valign=top>virtual bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1RenderQueueInvocation.html#Ogre_1_1RenderQueueInvocationa7">getSuppressShadows</a> (void) const </td></tr>
39
40<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Gets whether shadows are suppressed when invoking this queue.  <a href="#Ogre_1_1RenderQueueInvocationa7"></a><br><br></td></tr>
41<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1RenderQueueInvocation.html#Ogre_1_1RenderQueueInvocationa8">setSuppressRenderStateChanges</a> (bool suppress)</td></tr>
42
43<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets whether render state changes are suppressed when invoking this queue.  <a href="#Ogre_1_1RenderQueueInvocationa8"></a><br><br></td></tr>
44<tr><td class="memItemLeft" nowrap align=right valign=top>virtual bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1RenderQueueInvocation.html#Ogre_1_1RenderQueueInvocationa9">getSuppressRenderStateChanges</a> (void) const </td></tr>
45
46<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Gets whether shadows are suppressed when invoking this queue.  <a href="#Ogre_1_1RenderQueueInvocationa9"></a><br><br></td></tr>
47<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1RenderQueueInvocation.html#Ogre_1_1RenderQueueInvocationa10">invoke</a> (<a class="el" href="classOgre_1_1RenderQueueGroup.html">RenderQueueGroup</a> *group, <a class="el" href="classOgre_1_1SceneManager.html">SceneManager</a> *targetSceneManager)</td></tr>
48
49<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Invoke this class on a concrete queue group.  <a href="#Ogre_1_1RenderQueueInvocationa10"></a><br><br></td></tr>
50<tr><td colspan=2><br><h2>Static Public Attributes</h2></td></tr>
51<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a471">String</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1RenderQueueInvocation.html#Ogre_1_1RenderQueueInvocations0">RENDER_QUEUE_INVOCATION_SHADOWS</a></td></tr>
52
53<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Invocation identifier for shadows.  <a href="#Ogre_1_1RenderQueueInvocations0"></a><br><br></td></tr>
54<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr>
55<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a457">uint8</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1RenderQueueInvocation.html#Ogre_1_1RenderQueueInvocationp0">mRenderQueueGroupID</a></td></tr>
56
57<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Target queue group.  <a href="#Ogre_1_1RenderQueueInvocationp0"></a><br><br></td></tr>
58<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a471">String</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1RenderQueueInvocation.html#Ogre_1_1RenderQueueInvocationp1">mInvocationName</a></td></tr>
59
60<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Invocation identifier - used in listeners.  <a href="#Ogre_1_1RenderQueueInvocationp1"></a><br><br></td></tr>
61<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1QueuedRenderableCollection.html#Ogre_1_1QueuedRenderableCollectionw3">QueuedRenderableCollection::OrganisationMode</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1RenderQueueInvocation.html#Ogre_1_1RenderQueueInvocationp2">mSolidsOrganisation</a></td></tr>
62
63<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Solids ordering mode.  <a href="#Ogre_1_1RenderQueueInvocationp2"></a><br><br></td></tr>
64<tr><td class="memItemLeft" nowrap align=right valign=top>bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1RenderQueueInvocation.html#Ogre_1_1RenderQueueInvocationp3">mSuppressShadows</a></td></tr>
65
66<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Suppress shadows processing in this invocation?  <a href="#Ogre_1_1RenderQueueInvocationp3"></a><br><br></td></tr>
67<tr><td class="memItemLeft" nowrap align=right valign=top>bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1RenderQueueInvocation.html#Ogre_1_1RenderQueueInvocationp4">mSuppressRenderStateChanges</a></td></tr>
68
69<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Suppress OGRE's render state management?  <a href="#Ogre_1_1RenderQueueInvocationp4"></a><br><br></td></tr>
70</table>
71<hr><a name="_details"></a><h2>Detailed Description</h2>
72Class representing the invocation of queue groups in a <a class="el" href="classOgre_1_1RenderQueue.html">RenderQueue</a>.
73<p>
74<dl compact><dt><b>Remarks:</b></dt><dd>The default behaviour for OGRE's render queue is to render each queue group in turn, dealing with shadows automatically, and rendering solids in grouped passes, followed by transparent objects in descending order. This class, together with <a class="el" href="classOgre_1_1RenderQueueInvocationSequence.html">RenderQueueInvocationSequence</a> and the ability to associate one with a <a class="el" href="classOgre_1_1Viewport.html">Viewport</a>, allows you to change that behaviour and render queue groups in arbitrary sequence, repeatedly, and to skip shadows, change the ordering of solids, or even prevent OGRE controlling the render state during a particular invocation for special effects. </dd></dl>
75<dl compact><dt><b></b></dt><dd>Note that whilst you can change the ordering of rendering solids, you can't change the ordering on transparent objects, since to do this would cause them to render incorrectly. </dd></dl>
76<dl compact><dt><b></b></dt><dd>As well as using this class directly and using the options it provides you with, you can also provide subclasses of it to a <a class="el" href="classOgre_1_1RenderQueueInvocationSequence.html">RenderQueueInvocationSequence</a> instance if you want to gain ultimate control. </dd></dl>
77<dl compact><dt><b>Note:</b></dt><dd>Invocations will be skipped if there are scene-level options preventing them being rendered - for example special-case render queues and render queue listeners that dictate this.</dd></dl>
78
79<p>
80
81<p>
82Definition at line <a class="el" href="OgreRenderQueueInvocation_8h-source.html#l00057">57</a> of file <a class="el" href="OgreRenderQueueInvocation_8h-source.html">OgreRenderQueueInvocation.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
83<a class="anchor" name="Ogre_1_1RenderQueueInvocationa0" doxytag="Ogre::RenderQueueInvocation::RenderQueueInvocation" ></a><p>
84<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
85  <tr>
86    <td class="mdRow">
87      <table cellpadding="0" cellspacing="0" border="0">
88        <tr>
89          <td class="md" nowrap valign="top"> Ogre::RenderQueueInvocation::RenderQueueInvocation </td>
90          <td class="md" valign="top">(&nbsp;</td>
91          <td class="md" nowrap valign="top"><a class="el" href="namespaceOgre.html#a457">uint8</a>&nbsp;</td>
92          <td class="mdname" nowrap> <em>renderQueueGroupID</em>, </td>
93        </tr>
94        <tr>
95          <td class="md" nowrap align="right"></td>
96          <td></td>
97          <td class="md" nowrap>const <a class="el" href="namespaceOgre.html#a471">String</a> &amp;&nbsp;</td>
98          <td class="mdname" nowrap> <em>invocationName</em> = <a class="el" href="classOgre_1_1StringUtil.html#Ogre_1_1StringUtils0">StringUtil::BLANK</a></td>
99        </tr>
100        <tr>
101          <td></td>
102          <td class="md">)&nbsp;</td>
103          <td class="md" colspan="2"></td>
104        </tr>
105
106      </table>
107    </td>
108  </tr>
109</table>
110<table cellspacing=5 cellpadding=0 border=0>
111  <tr>
112    <td>
113      &nbsp;
114    </td>
115    <td>
116
117<p>
118Constructor.
119<p>
120<dl compact><dt><b>Parameters:</b></dt><dd>
121  <table border="0" cellspacing="2" cellpadding="0">
122    <tr><td valign=top><em>renderQueueGroupID</em>&nbsp;</td><td>ID of the queue this will target </td></tr>
123    <tr><td valign=top><em>invocationName</em>&nbsp;</td><td>Optional name to uniquely identify this invocation from others in a <a class="el" href="classOgre_1_1RenderQueueListener.html">RenderQueueListener</a></td></tr>
124  </table>
125</dl>
126    </td>
127  </tr>
128</table>
129<a class="anchor" name="Ogre_1_1RenderQueueInvocationa1" doxytag="Ogre::RenderQueueInvocation::~RenderQueueInvocation" ></a><p>
130<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
131  <tr>
132    <td class="mdRow">
133      <table cellpadding="0" cellspacing="0" border="0">
134        <tr>
135          <td class="md" nowrap valign="top"> virtual Ogre::RenderQueueInvocation::~<a class="el" href="classOgre_1_1RenderQueueInvocation.html">RenderQueueInvocation</a> </td>
136          <td class="md" valign="top">(&nbsp;</td>
137          <td class="mdname1" valign="top" nowrap>          </td>
138          <td class="md" valign="top">&nbsp;)&nbsp;</td>
139          <td class="md" nowrap><code> [virtual]</code></td>
140        </tr>
141
142      </table>
143    </td>
144  </tr>
145</table>
146<table cellspacing=5 cellpadding=0 border=0>
147  <tr>
148    <td>
149      &nbsp;
150    </td>
151    <td>
152
153<p>
154    </td>
155  </tr>
156</table>
157<hr><h2>Member Function Documentation</h2>
158<a class="anchor" name="Ogre_1_1RenderQueueInvocationa3" doxytag="Ogre::RenderQueueInvocation::getInvocationName" ></a><p>
159<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
160  <tr>
161    <td class="mdRow">
162      <table cellpadding="0" cellspacing="0" border="0">
163        <tr>
164          <td class="md" nowrap valign="top"> virtual const <a class="el" href="namespaceOgre.html#a471">String</a>&amp; Ogre::RenderQueueInvocation::getInvocationName </td>
165          <td class="md" valign="top">(&nbsp;</td>
166          <td class="md" nowrap valign="top">void&nbsp;</td>
167          <td class="mdname1" valign="top" nowrap>          </td>
168          <td class="md" valign="top">&nbsp;)&nbsp;</td>
169          <td class="md" nowrap> const<code> [virtual]</code></td>
170        </tr>
171
172      </table>
173    </td>
174  </tr>
175</table>
176<table cellspacing=5 cellpadding=0 border=0>
177  <tr>
178    <td>
179      &nbsp;
180    </td>
181    <td>
182
183<p>
184Get the invocation name (may be blank if not set by creator).
185<p>
186
187<p>
188Definition at line <a class="el" href="OgreRenderQueueInvocation_8h-source.html#l00084">84</a> of file <a class="el" href="OgreRenderQueueInvocation_8h-source.html">OgreRenderQueueInvocation.h</a>.
189<p>
190References <a class="el" href="OgrePrerequisites_8h-source.html#l00156">Ogre::String</a>.    </td>
191  </tr>
192</table>
193<a class="anchor" name="Ogre_1_1RenderQueueInvocationa2" doxytag="Ogre::RenderQueueInvocation::getRenderQueueGroupID" ></a><p>
194<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
195  <tr>
196    <td class="mdRow">
197      <table cellpadding="0" cellspacing="0" border="0">
198        <tr>
199          <td class="md" nowrap valign="top"> virtual <a class="el" href="namespaceOgre.html#a457">uint8</a> Ogre::RenderQueueInvocation::getRenderQueueGroupID </td>
200          <td class="md" valign="top">(&nbsp;</td>
201          <td class="md" nowrap valign="top">void&nbsp;</td>
202          <td class="mdname1" valign="top" nowrap>          </td>
203          <td class="md" valign="top">&nbsp;)&nbsp;</td>
204          <td class="md" nowrap> const<code> [virtual]</code></td>
205        </tr>
206
207      </table>
208    </td>
209  </tr>
210</table>
211<table cellspacing=5 cellpadding=0 border=0>
212  <tr>
213    <td>
214      &nbsp;
215    </td>
216    <td>
217
218<p>
219Get the render queue group id.
220<p>
221
222<p>
223Definition at line <a class="el" href="OgreRenderQueueInvocation_8h-source.html#l00081">81</a> of file <a class="el" href="OgreRenderQueueInvocation_8h-source.html">OgreRenderQueueInvocation.h</a>.
224<p>
225References <a class="el" href="OgrePlatform_8h-source.html#l00202">Ogre::uint8</a>.    </td>
226  </tr>
227</table>
228<a class="anchor" name="Ogre_1_1RenderQueueInvocationa5" doxytag="Ogre::RenderQueueInvocation::getSolidsOrganisation" ></a><p>
229<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
230  <tr>
231    <td class="mdRow">
232      <table cellpadding="0" cellspacing="0" border="0">
233        <tr>
234          <td class="md" nowrap valign="top"> virtual <a class="el" href="classOgre_1_1QueuedRenderableCollection.html#Ogre_1_1QueuedRenderableCollectionw3">QueuedRenderableCollection::OrganisationMode</a> Ogre::RenderQueueInvocation::getSolidsOrganisation </td>
235          <td class="md" valign="top">(&nbsp;</td>
236          <td class="md" nowrap valign="top">void&nbsp;</td>
237          <td class="mdname1" valign="top" nowrap>          </td>
238          <td class="md" valign="top">&nbsp;)&nbsp;</td>
239          <td class="md" nowrap> const<code> [virtual]</code></td>
240        </tr>
241
242      </table>
243    </td>
244  </tr>
245</table>
246<table cellspacing=5 cellpadding=0 border=0>
247  <tr>
248    <td>
249      &nbsp;
250    </td>
251    <td>
252
253<p>
254Get the organisation mode being used for solids in this queue group invocation.
255<p>
256
257<p>
258Definition at line <a class="el" href="OgreRenderQueueInvocation_8h-source.html#l00097">97</a> of file <a class="el" href="OgreRenderQueueInvocation_8h-source.html">OgreRenderQueueInvocation.h</a>.    </td>
259  </tr>
260</table>
261<a class="anchor" name="Ogre_1_1RenderQueueInvocationa9" doxytag="Ogre::RenderQueueInvocation::getSuppressRenderStateChanges" ></a><p>
262<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
263  <tr>
264    <td class="mdRow">
265      <table cellpadding="0" cellspacing="0" border="0">
266        <tr>
267          <td class="md" nowrap valign="top"> virtual bool Ogre::RenderQueueInvocation::getSuppressRenderStateChanges </td>
268          <td class="md" valign="top">(&nbsp;</td>
269          <td class="md" nowrap valign="top">void&nbsp;</td>
270          <td class="mdname1" valign="top" nowrap>          </td>
271          <td class="md" valign="top">&nbsp;)&nbsp;</td>
272          <td class="md" nowrap> const<code> [virtual]</code></td>
273        </tr>
274
275      </table>
276    </td>
277  </tr>
278</table>
279<table cellspacing=5 cellpadding=0 border=0>
280  <tr>
281    <td>
282      &nbsp;
283    </td>
284    <td>
285
286<p>
287Gets whether shadows are suppressed when invoking this queue.
288<p>
289
290<p>
291Definition at line <a class="el" href="OgreRenderQueueInvocation_8h-source.html#l00136">136</a> of file <a class="el" href="OgreRenderQueueInvocation_8h-source.html">OgreRenderQueueInvocation.h</a>.    </td>
292  </tr>
293</table>
294<a class="anchor" name="Ogre_1_1RenderQueueInvocationa7" doxytag="Ogre::RenderQueueInvocation::getSuppressShadows" ></a><p>
295<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
296  <tr>
297    <td class="mdRow">
298      <table cellpadding="0" cellspacing="0" border="0">
299        <tr>
300          <td class="md" nowrap valign="top"> virtual bool Ogre::RenderQueueInvocation::getSuppressShadows </td>
301          <td class="md" valign="top">(&nbsp;</td>
302          <td class="md" nowrap valign="top">void&nbsp;</td>
303          <td class="mdname1" valign="top" nowrap>          </td>
304          <td class="md" valign="top">&nbsp;)&nbsp;</td>
305          <td class="md" nowrap> const<code> [virtual]</code></td>
306        </tr>
307
308      </table>
309    </td>
310  </tr>
311</table>
312<table cellspacing=5 cellpadding=0 border=0>
313  <tr>
314    <td>
315      &nbsp;
316    </td>
317    <td>
318
319<p>
320Gets whether shadows are suppressed when invoking this queue.
321<p>
322
323<p>
324Definition at line <a class="el" href="OgreRenderQueueInvocation_8h-source.html#l00109">109</a> of file <a class="el" href="OgreRenderQueueInvocation_8h-source.html">OgreRenderQueueInvocation.h</a>.    </td>
325  </tr>
326</table>
327<a class="anchor" name="Ogre_1_1RenderQueueInvocationa10" doxytag="Ogre::RenderQueueInvocation::invoke" ></a><p>
328<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
329  <tr>
330    <td class="mdRow">
331      <table cellpadding="0" cellspacing="0" border="0">
332        <tr>
333          <td class="md" nowrap valign="top"> virtual void Ogre::RenderQueueInvocation::invoke </td>
334          <td class="md" valign="top">(&nbsp;</td>
335          <td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1RenderQueueGroup.html">RenderQueueGroup</a> *&nbsp;</td>
336          <td class="mdname" nowrap> <em>group</em>, </td>
337        </tr>
338        <tr>
339          <td class="md" nowrap align="right"></td>
340          <td></td>
341          <td class="md" nowrap><a class="el" href="classOgre_1_1SceneManager.html">SceneManager</a> *&nbsp;</td>
342          <td class="mdname" nowrap> <em>targetSceneManager</em></td>
343        </tr>
344        <tr>
345          <td></td>
346          <td class="md">)&nbsp;</td>
347          <td class="md" colspan="2"><code> [virtual]</code></td>
348        </tr>
349
350      </table>
351    </td>
352  </tr>
353</table>
354<table cellspacing=5 cellpadding=0 border=0>
355  <tr>
356    <td>
357      &nbsp;
358    </td>
359    <td>
360
361<p>
362Invoke this class on a concrete queue group.
363<p>
364<dl compact><dt><b>Remarks:</b></dt><dd>Implementation will send the queue group to the target scene manager after doing what it needs to do.</dd></dl>
365    </td>
366  </tr>
367</table>
368<a class="anchor" name="Ogre_1_1RenderQueueInvocationa4" doxytag="Ogre::RenderQueueInvocation::setSolidsOrganisation" ></a><p>
369<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
370  <tr>
371    <td class="mdRow">
372      <table cellpadding="0" cellspacing="0" border="0">
373        <tr>
374          <td class="md" nowrap valign="top"> virtual void Ogre::RenderQueueInvocation::setSolidsOrganisation </td>
375          <td class="md" valign="top">(&nbsp;</td>
376          <td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1QueuedRenderableCollection.html#Ogre_1_1QueuedRenderableCollectionw3">QueuedRenderableCollection::OrganisationMode</a>&nbsp;</td>
377          <td class="mdname1" valign="top" nowrap> <em>org</em>          </td>
378          <td class="md" valign="top">&nbsp;)&nbsp;</td>
379          <td class="md" nowrap><code> [virtual]</code></td>
380        </tr>
381
382      </table>
383    </td>
384  </tr>
385</table>
386<table cellspacing=5 cellpadding=0 border=0>
387  <tr>
388    <td>
389      &nbsp;
390    </td>
391    <td>
392
393<p>
394Set the organisation mode being used for solids in this queue group invocation.
395<p>
396
397<p>
398Definition at line <a class="el" href="OgreRenderQueueInvocation_8h-source.html#l00089">89</a> of file <a class="el" href="OgreRenderQueueInvocation_8h-source.html">OgreRenderQueueInvocation.h</a>.    </td>
399  </tr>
400</table>
401<a class="anchor" name="Ogre_1_1RenderQueueInvocationa8" doxytag="Ogre::RenderQueueInvocation::setSuppressRenderStateChanges" ></a><p>
402<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
403  <tr>
404    <td class="mdRow">
405      <table cellpadding="0" cellspacing="0" border="0">
406        <tr>
407          <td class="md" nowrap valign="top"> virtual void Ogre::RenderQueueInvocation::setSuppressRenderStateChanges </td>
408          <td class="md" valign="top">(&nbsp;</td>
409          <td class="md" nowrap valign="top">bool&nbsp;</td>
410          <td class="mdname1" valign="top" nowrap> <em>suppress</em>          </td>
411          <td class="md" valign="top">&nbsp;)&nbsp;</td>
412          <td class="md" nowrap><code> [virtual]</code></td>
413        </tr>
414
415      </table>
416    </td>
417  </tr>
418</table>
419<table cellspacing=5 cellpadding=0 border=0>
420  <tr>
421    <td>
422      &nbsp;
423    </td>
424    <td>
425
426<p>
427Sets whether render state changes are suppressed when invoking this queue.
428<p>
429<dl compact><dt><b>Remarks:</b></dt><dd>When doing special effects you may want to set up render state yourself and have it apply for the entire rendering of a queue. In that case, you should call this method with a parameter of 'true', and use a <a class="el" href="classOgre_1_1RenderQueueListener.html">RenderQueueListener</a> to set the render state directly on <a class="el" href="classOgre_1_1RenderSystem.html">RenderSystem</a> yourself before the invocation. </dd></dl>
430<dl compact><dt><b></b></dt><dd>Suppressing render state changes is only intended for advanced use, don't use it if you're unsure of the effect. The only <a class="el" href="classOgre_1_1RenderSystem.html">RenderSystem</a> calls made are to set the world matrix for each object (note - view an projection matrices are NOT SET - they are under your control) and to render the object; it is up to the caller to do everything else, including enabling any vertex / fragment programs and updating their parameter state, and binding parameters to the <a class="el" href="classOgre_1_1RenderSystem.html">RenderSystem</a>. We advise you use a <a class="el" href="classOgre_1_1RenderQueueListener.html">RenderQueueListener</a> in order to get a notification when this invocation is going to happen (use an invocation name to identify it if you like), at which point you can set the state you need to apply before the objects are rendered.</dd></dl>
431
432<p>
433Definition at line <a class="el" href="OgreRenderQueueInvocation_8h-source.html#l00131">131</a> of file <a class="el" href="OgreRenderQueueInvocation_8h-source.html">OgreRenderQueueInvocation.h</a>.    </td>
434  </tr>
435</table>
436<a class="anchor" name="Ogre_1_1RenderQueueInvocationa6" doxytag="Ogre::RenderQueueInvocation::setSuppressShadows" ></a><p>
437<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
438  <tr>
439    <td class="mdRow">
440      <table cellpadding="0" cellspacing="0" border="0">
441        <tr>
442          <td class="md" nowrap valign="top"> virtual void Ogre::RenderQueueInvocation::setSuppressShadows </td>
443          <td class="md" valign="top">(&nbsp;</td>
444          <td class="md" nowrap valign="top">bool&nbsp;</td>
445          <td class="mdname1" valign="top" nowrap> <em>suppress</em>          </td>
446          <td class="md" valign="top">&nbsp;)&nbsp;</td>
447          <td class="md" nowrap><code> [virtual]</code></td>
448        </tr>
449
450      </table>
451    </td>
452  </tr>
453</table>
454<table cellspacing=5 cellpadding=0 border=0>
455  <tr>
456    <td>
457      &nbsp;
458    </td>
459    <td>
460
461<p>
462Sets whether shadows are suppressed when invoking this queue.
463<p>
464<dl compact><dt><b>Remarks:</b></dt><dd>When doing effects you often will want to suppress shadow processing if shadows will already have been done by a previous render.</dd></dl>
465
466<p>
467Definition at line <a class="el" href="OgreRenderQueueInvocation_8h-source.html#l00104">104</a> of file <a class="el" href="OgreRenderQueueInvocation_8h-source.html">OgreRenderQueueInvocation.h</a>.    </td>
468  </tr>
469</table>
470<hr><h2>Member Data Documentation</h2>
471<a class="anchor" name="Ogre_1_1RenderQueueInvocationp1" doxytag="Ogre::RenderQueueInvocation::mInvocationName" ></a><p>
472<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
473  <tr>
474    <td class="mdRow">
475      <table cellpadding="0" cellspacing="0" border="0">
476        <tr>
477          <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a471">String</a> <a class="el" href="classOgre_1_1RenderQueueInvocation.html#Ogre_1_1RenderQueueInvocationp1">Ogre::RenderQueueInvocation::mInvocationName</a><code> [protected]</code>
478      </table>
479    </td>
480  </tr>
481</table>
482<table cellspacing=5 cellpadding=0 border=0>
483  <tr>
484    <td>
485      &nbsp;
486    </td>
487    <td>
488
489<p>
490Invocation identifier - used in listeners.
491<p>
492
493<p>
494Definition at line <a class="el" href="OgreRenderQueueInvocation_8h-source.html#l00063">63</a> of file <a class="el" href="OgreRenderQueueInvocation_8h-source.html">OgreRenderQueueInvocation.h</a>.    </td>
495  </tr>
496</table>
497<a class="anchor" name="Ogre_1_1RenderQueueInvocationp0" doxytag="Ogre::RenderQueueInvocation::mRenderQueueGroupID" ></a><p>
498<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
499  <tr>
500    <td class="mdRow">
501      <table cellpadding="0" cellspacing="0" border="0">
502        <tr>
503          <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a457">uint8</a> <a class="el" href="classOgre_1_1RenderQueueInvocation.html#Ogre_1_1RenderQueueInvocationp0">Ogre::RenderQueueInvocation::mRenderQueueGroupID</a><code> [protected]</code>
504      </table>
505    </td>
506  </tr>
507</table>
508<table cellspacing=5 cellpadding=0 border=0>
509  <tr>
510    <td>
511      &nbsp;
512    </td>
513    <td>
514
515<p>
516Target queue group.
517<p>
518
519<p>
520Definition at line <a class="el" href="OgreRenderQueueInvocation_8h-source.html#l00061">61</a> of file <a class="el" href="OgreRenderQueueInvocation_8h-source.html">OgreRenderQueueInvocation.h</a>.    </td>
521  </tr>
522</table>
523<a class="anchor" name="Ogre_1_1RenderQueueInvocationp2" doxytag="Ogre::RenderQueueInvocation::mSolidsOrganisation" ></a><p>
524<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
525  <tr>
526    <td class="mdRow">
527      <table cellpadding="0" cellspacing="0" border="0">
528        <tr>
529          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1QueuedRenderableCollection.html#Ogre_1_1QueuedRenderableCollectionw3">QueuedRenderableCollection::OrganisationMode</a> <a class="el" href="classOgre_1_1RenderQueueInvocation.html#Ogre_1_1RenderQueueInvocationp2">Ogre::RenderQueueInvocation::mSolidsOrganisation</a><code> [protected]</code>
530      </table>
531    </td>
532  </tr>
533</table>
534<table cellspacing=5 cellpadding=0 border=0>
535  <tr>
536    <td>
537      &nbsp;
538    </td>
539    <td>
540
541<p>
542Solids ordering mode.
543<p>
544
545<p>
546Definition at line <a class="el" href="OgreRenderQueueInvocation_8h-source.html#l00065">65</a> of file <a class="el" href="OgreRenderQueueInvocation_8h-source.html">OgreRenderQueueInvocation.h</a>.    </td>
547  </tr>
548</table>
549<a class="anchor" name="Ogre_1_1RenderQueueInvocationp4" doxytag="Ogre::RenderQueueInvocation::mSuppressRenderStateChanges" ></a><p>
550<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
551  <tr>
552    <td class="mdRow">
553      <table cellpadding="0" cellspacing="0" border="0">
554        <tr>
555          <td class="md" nowrap valign="top"> bool <a class="el" href="classOgre_1_1RenderQueueInvocation.html#Ogre_1_1RenderQueueInvocationp4">Ogre::RenderQueueInvocation::mSuppressRenderStateChanges</a><code> [protected]</code>
556      </table>
557    </td>
558  </tr>
559</table>
560<table cellspacing=5 cellpadding=0 border=0>
561  <tr>
562    <td>
563      &nbsp;
564    </td>
565    <td>
566
567<p>
568Suppress OGRE's render state management?
569<p>
570
571<p>
572Definition at line <a class="el" href="OgreRenderQueueInvocation_8h-source.html#l00069">69</a> of file <a class="el" href="OgreRenderQueueInvocation_8h-source.html">OgreRenderQueueInvocation.h</a>.    </td>
573  </tr>
574</table>
575<a class="anchor" name="Ogre_1_1RenderQueueInvocationp3" doxytag="Ogre::RenderQueueInvocation::mSuppressShadows" ></a><p>
576<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
577  <tr>
578    <td class="mdRow">
579      <table cellpadding="0" cellspacing="0" border="0">
580        <tr>
581          <td class="md" nowrap valign="top"> bool <a class="el" href="classOgre_1_1RenderQueueInvocation.html#Ogre_1_1RenderQueueInvocationp3">Ogre::RenderQueueInvocation::mSuppressShadows</a><code> [protected]</code>
582      </table>
583    </td>
584  </tr>
585</table>
586<table cellspacing=5 cellpadding=0 border=0>
587  <tr>
588    <td>
589      &nbsp;
590    </td>
591    <td>
592
593<p>
594Suppress shadows processing in this invocation?
595<p>
596
597<p>
598Definition at line <a class="el" href="OgreRenderQueueInvocation_8h-source.html#l00067">67</a> of file <a class="el" href="OgreRenderQueueInvocation_8h-source.html">OgreRenderQueueInvocation.h</a>.    </td>
599  </tr>
600</table>
601<a class="anchor" name="Ogre_1_1RenderQueueInvocations0" doxytag="Ogre::RenderQueueInvocation::RENDER_QUEUE_INVOCATION_SHADOWS" ></a><p>
602<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
603  <tr>
604    <td class="mdRow">
605      <table cellpadding="0" cellspacing="0" border="0">
606        <tr>
607          <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a471">String</a> <a class="el" href="classOgre_1_1RenderQueueInvocation.html#Ogre_1_1RenderQueueInvocations0">Ogre::RenderQueueInvocation::RENDER_QUEUE_INVOCATION_SHADOWS</a><code> [static]</code>
608      </table>
609    </td>
610  </tr>
611</table>
612<table cellspacing=5 cellpadding=0 border=0>
613  <tr>
614    <td>
615      &nbsp;
616    </td>
617    <td>
618
619<p>
620Invocation identifier for shadows.
621<p>
622
623<p>
624Definition at line <a class="el" href="OgreRenderQueueInvocation_8h-source.html#l00146">146</a> of file <a class="el" href="OgreRenderQueueInvocation_8h-source.html">OgreRenderQueueInvocation.h</a>.    </td>
625  </tr>
626</table>
627<hr>The documentation for this class was generated from the following file:<ul>
628<li><a class="el" href="OgreRenderQueueInvocation_8h-source.html">OgreRenderQueueInvocation.h</a></ul>
629<hr>
630<p>
631Copyright &copy; 2000-2005 by The OGRE Team<br />
632<!--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/>
633This 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/>
634                <!--/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#">
635                <Work rdf:about="">
636                        <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" />
637        <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" />
638                </Work>
639                <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> -->
640
641Last modified Sun Mar 12 14:42:05 2006
642</p>
643</body>
644</html>
Note: See TracBrowser for help on using the repository browser.