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

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

adding ogre 1.2 and dependencies
Line 
1<html>
2<head>
3<title>Ogre::RenderQueueGroup 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::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. 
11<a href="#_details">More...</a>
12<p>
13<code>#include &lt;<a class="el" href="OgreRenderQueueSortingGrouping_8h-source.html">OgreRenderQueueSortingGrouping.h</a>&gt;</code>
14<p>
15<a href="classOgre_1_1RenderQueueGroup-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 Types</h2></td></tr>
18<tr><td class="memItemLeft" nowrap align=right valign=top>typedef std::map&lt; <a class="el" href="namespaceOgre.html#a467">ushort</a>,<br>
19 <a class="el" href="classOgre_1_1RenderPriorityGroup.html">RenderPriorityGroup</a> *, std::less&lt;<br>
20 <a class="el" href="namespaceOgre.html#a467">ushort</a> &gt; &gt;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1RenderQueueGroup.html#Ogre_1_1RenderQueueGroupw0">PriorityMap</a></td></tr>
21
22<tr><td class="memItemLeft" nowrap align=right valign=top>typedef <a class="el" href="classOgre_1_1MapIterator.html">MapIterator</a>&lt; <a class="el" href="classOgre_1_1RenderQueueGroup.html#Ogre_1_1RenderQueueGroupw0">PriorityMap</a> &gt;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1RenderQueueGroup.html#Ogre_1_1RenderQueueGroupw1">PriorityMapIterator</a></td></tr>
23
24<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
25<tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1RenderQueueGroup.html#Ogre_1_1RenderQueueGroupa0">RenderQueueGroup</a> (<a class="el" href="classOgre_1_1RenderQueue.html">RenderQueue</a> *parent, bool splitPassesByLightingType, bool splitNoShadowPasses, bool shadowCastersNotReceivers)</td></tr>
26
27<tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1RenderQueueGroup.html#Ogre_1_1RenderQueueGroupa1">~RenderQueueGroup</a> ()</td></tr>
28
29<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1MapIterator.html">PriorityMapIterator</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1RenderQueueGroup.html#Ogre_1_1RenderQueueGroupa2">getIterator</a> (void)</td></tr>
30
31<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get an iterator for browsing through child contents.  <a href="#Ogre_1_1RenderQueueGroupa2"></a><br><br></td></tr>
32<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" 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="classOgre_1_1Technique.html">Technique</a> *pTech, <a class="el" href="namespaceOgre.html#a467">ushort</a> priority)</td></tr>
33
34<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Add a renderable to this group, with the given priority.  <a href="#Ogre_1_1RenderQueueGroupa3"></a><br><br></td></tr>
35<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1RenderQueueGroup.html#Ogre_1_1RenderQueueGroupa4">clear</a> (bool destroy=false)</td></tr>
36
37<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Clears this group of renderables.  <a href="#Ogre_1_1RenderQueueGroupa4"></a><br><br></td></tr>
38<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1RenderQueueGroup.html#Ogre_1_1RenderQueueGroupa5">setShadowsEnabled</a> (bool enabled)</td></tr>
39
40<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Indicate whether a given queue group will be doing any shadow setup.  <a href="#Ogre_1_1RenderQueueGroupa5"></a><br><br></td></tr>
41<tr><td class="memItemLeft" nowrap align=right valign=top>bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1RenderQueueGroup.html#Ogre_1_1RenderQueueGroupa6">getShadowsEnabled</a> (void) const </td></tr>
42
43<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Are shadows enabled for this queue?  <a href="#Ogre_1_1RenderQueueGroupa6"></a><br><br></td></tr>
44<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1RenderQueueGroup.html#Ogre_1_1RenderQueueGroupa7">setSplitPassesByLightingType</a> (bool split)</td></tr>
45
46<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets whether or not the queue will split passes by their lighting type, ie ambient, per-light and decal.  <a href="#Ogre_1_1RenderQueueGroupa7"></a><br><br></td></tr>
47<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1RenderQueueGroup.html#Ogre_1_1RenderQueueGroupa8">setSplitNoShadowPasses</a> (bool split)</td></tr>
48
49<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets whether or not the queue will split passes which have shadow receive turned off (in their parent material), which is needed when certain shadow techniques are used.  <a href="#Ogre_1_1RenderQueueGroupa8"></a><br><br></td></tr>
50<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1RenderQueueGroup.html#Ogre_1_1RenderQueueGroupa9">setShadowCastersCannotBeReceivers</a> (bool ind)</td></tr>
51
52<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets whether or not objects which cast shadows should be treated as never receiving shadows.  <a href="#Ogre_1_1RenderQueueGroupa9"></a><br><br></td></tr>
53<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1RenderQueueGroup.html#Ogre_1_1RenderQueueGroupa10">resetOrganisationModes</a> (void)</td></tr>
54
55<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Reset the organisation modes required for the solids in this group.  <a href="#Ogre_1_1RenderQueueGroupa10"></a><br><br></td></tr>
56<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1RenderQueueGroup.html#Ogre_1_1RenderQueueGroupa11">addOrganisationMode</a> (<a class="el" href="classOgre_1_1QueuedRenderableCollection.html#Ogre_1_1QueuedRenderableCollectionw3">QueuedRenderableCollection::OrganisationMode</a> om)</td></tr>
57
58<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Add a required sorting / grouping mode for the solids in this group.  <a href="#Ogre_1_1RenderQueueGroupa11"></a><br><br></td></tr>
59<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1RenderQueueGroup.html#Ogre_1_1RenderQueueGroupa12">defaultOrganisationMode</a> (void)</td></tr>
60
61<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Setthe sorting / grouping mode for the solids in this group to the default.  <a href="#Ogre_1_1RenderQueueGroupa12"></a><br><br></td></tr>
62<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr>
63<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1RenderQueue.html">RenderQueue</a> *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1RenderQueueGroup.html#Ogre_1_1RenderQueueGroupp0">mParent</a></td></tr>
64
65<tr><td class="memItemLeft" nowrap align=right valign=top>bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1RenderQueueGroup.html#Ogre_1_1RenderQueueGroupp1">mSplitPassesByLightingType</a></td></tr>
66
67<tr><td class="memItemLeft" nowrap align=right valign=top>bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1RenderQueueGroup.html#Ogre_1_1RenderQueueGroupp2">mSplitNoShadowPasses</a></td></tr>
68
69<tr><td class="memItemLeft" nowrap align=right valign=top>bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1RenderQueueGroup.html#Ogre_1_1RenderQueueGroupp3">mShadowCastersNotReceivers</a></td></tr>
70
71<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1RenderQueueGroup.html#Ogre_1_1RenderQueueGroupw0">PriorityMap</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1RenderQueueGroup.html#Ogre_1_1RenderQueueGroupp4">mPriorityGroups</a></td></tr>
72
73<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Map of <a class="el" href="classOgre_1_1RenderPriorityGroup.html">RenderPriorityGroup</a> objects.  <a href="#Ogre_1_1RenderQueueGroupp4"></a><br><br></td></tr>
74<tr><td class="memItemLeft" nowrap align=right valign=top>bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1RenderQueueGroup.html#Ogre_1_1RenderQueueGroupp5">mShadowsEnabled</a></td></tr>
75
76<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Whether shadows are enabled for this queue.  <a href="#Ogre_1_1RenderQueueGroupp5"></a><br><br></td></tr>
77</table>
78<hr><a name="_details"></a><h2>Detailed Description</h2>
79A 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.
80<p>
81<dl compact><dt><b>Remarks:</b></dt><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). </dd></dl>
82
83<p>
84
85<p>
86Definition at line <a class="el" href="OgreRenderQueueSortingGrouping_8h-source.html#l00443">443</a> of file <a class="el" href="OgreRenderQueueSortingGrouping_8h-source.html">OgreRenderQueueSortingGrouping.h</a>.<hr><h2>Member Typedef Documentation</h2>
87<a class="anchor" name="Ogre_1_1RenderQueueGroupw0" doxytag="Ogre::RenderQueueGroup::PriorityMap" ></a><p>
88<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
89  <tr>
90    <td class="mdRow">
91      <table cellpadding="0" cellspacing="0" border="0">
92        <tr>
93          <td class="md" nowrap valign="top"> typedef std::map&lt;<a class="el" href="namespaceOgre.html#a467">ushort</a>, <a class="el" href="classOgre_1_1RenderPriorityGroup.html">RenderPriorityGroup</a>*, std::less&lt;<a class="el" href="namespaceOgre.html#a467">ushort</a>&gt; &gt; <a class="el" href="classOgre_1_1RenderQueueGroup.html#Ogre_1_1RenderQueueGroupw0">Ogre::RenderQueueGroup::PriorityMap</a>
94      </table>
95    </td>
96  </tr>
97</table>
98<table cellspacing=5 cellpadding=0 border=0>
99  <tr>
100    <td>
101      &nbsp;
102    </td>
103    <td>
104
105<p>
106
107<p>
108Definition at line <a class="el" href="OgreRenderQueueSortingGrouping_8h-source.html#l00446">446</a> of file <a class="el" href="OgreRenderQueueSortingGrouping_8h-source.html">OgreRenderQueueSortingGrouping.h</a>.    </td>
109  </tr>
110</table>
111<a class="anchor" name="Ogre_1_1RenderQueueGroupw1" doxytag="Ogre::RenderQueueGroup::PriorityMapIterator" ></a><p>
112<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
113  <tr>
114    <td class="mdRow">
115      <table cellpadding="0" cellspacing="0" border="0">
116        <tr>
117          <td class="md" nowrap valign="top"> typedef <a class="el" href="classOgre_1_1MapIterator.html">MapIterator</a>&lt;<a class="el" href="classOgre_1_1RenderQueueGroup.html#Ogre_1_1RenderQueueGroupw0">PriorityMap</a>&gt; <a class="el" href="classOgre_1_1MapIterator.html">Ogre::RenderQueueGroup::PriorityMapIterator</a>
118      </table>
119    </td>
120  </tr>
121</table>
122<table cellspacing=5 cellpadding=0 border=0>
123  <tr>
124    <td>
125      &nbsp;
126    </td>
127    <td>
128
129<p>
130
131<p>
132Definition at line <a class="el" href="OgreRenderQueueSortingGrouping_8h-source.html#l00447">447</a> of file <a class="el" href="OgreRenderQueueSortingGrouping_8h-source.html">OgreRenderQueueSortingGrouping.h</a>.
133<p>
134Referenced by <a class="el" href="OgreRenderQueueSortingGrouping_8h-source.html#l00482">getIterator()</a>.    </td>
135  </tr>
136</table>
137<hr><h2>Constructor &amp; Destructor Documentation</h2>
138<a class="anchor" name="Ogre_1_1RenderQueueGroupa0" doxytag="Ogre::RenderQueueGroup::RenderQueueGroup" ></a><p>
139<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
140  <tr>
141    <td class="mdRow">
142      <table cellpadding="0" cellspacing="0" border="0">
143        <tr>
144          <td class="md" nowrap valign="top"> Ogre::RenderQueueGroup::RenderQueueGroup </td>
145          <td class="md" valign="top">(&nbsp;</td>
146          <td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1RenderQueue.html">RenderQueue</a> *&nbsp;</td>
147          <td class="mdname" nowrap> <em>parent</em>, </td>
148        </tr>
149        <tr>
150          <td class="md" nowrap align="right"></td>
151          <td></td>
152          <td class="md" nowrap>bool&nbsp;</td>
153          <td class="mdname" nowrap> <em>splitPassesByLightingType</em>, </td>
154        </tr>
155        <tr>
156          <td class="md" nowrap align="right"></td>
157          <td></td>
158          <td class="md" nowrap>bool&nbsp;</td>
159          <td class="mdname" nowrap> <em>splitNoShadowPasses</em>, </td>
160        </tr>
161        <tr>
162          <td class="md" nowrap align="right"></td>
163          <td></td>
164          <td class="md" nowrap>bool&nbsp;</td>
165          <td class="mdname" nowrap> <em>shadowCastersNotReceivers</em></td>
166        </tr>
167        <tr>
168          <td></td>
169          <td class="md">)&nbsp;</td>
170          <td class="md" colspan="2"></td>
171        </tr>
172
173      </table>
174    </td>
175  </tr>
176</table>
177<table cellspacing=5 cellpadding=0 border=0>
178  <tr>
179    <td>
180      &nbsp;
181    </td>
182    <td>
183
184<p>
185
186<p>
187Definition at line <a class="el" href="OgreRenderQueueSortingGrouping_8h-source.html#l00460">460</a> of file <a class="el" href="OgreRenderQueueSortingGrouping_8h-source.html">OgreRenderQueueSortingGrouping.h</a>.    </td>
188  </tr>
189</table>
190<a class="anchor" name="Ogre_1_1RenderQueueGroupa1" doxytag="Ogre::RenderQueueGroup::~RenderQueueGroup" ></a><p>
191<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
192  <tr>
193    <td class="mdRow">
194      <table cellpadding="0" cellspacing="0" border="0">
195        <tr>
196          <td class="md" nowrap valign="top"> Ogre::RenderQueueGroup::~<a class="el" href="classOgre_1_1RenderQueueGroup.html">RenderQueueGroup</a> </td>
197          <td class="md" valign="top">(&nbsp;</td>
198          <td class="mdname1" valign="top" nowrap>          </td>
199          <td class="md" valign="top">&nbsp;)&nbsp;</td>
200          <td class="md" nowrap></td>
201        </tr>
202
203      </table>
204    </td>
205  </tr>
206</table>
207<table cellspacing=5 cellpadding=0 border=0>
208  <tr>
209    <td>
210      &nbsp;
211    </td>
212    <td>
213
214<p>
215
216<p>
217Definition at line <a class="el" href="OgreRenderQueueSortingGrouping_8h-source.html#l00472">472</a> of file <a class="el" href="OgreRenderQueueSortingGrouping_8h-source.html">OgreRenderQueueSortingGrouping.h</a>.    </td>
218  </tr>
219</table>
220<hr><h2>Member Function Documentation</h2>
221<a class="anchor" name="Ogre_1_1RenderQueueGroupa11" doxytag="Ogre::RenderQueueGroup::addOrganisationMode" ></a><p>
222<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
223  <tr>
224    <td class="mdRow">
225      <table cellpadding="0" cellspacing="0" border="0">
226        <tr>
227          <td class="md" nowrap valign="top"> void Ogre::RenderQueueGroup::addOrganisationMode </td>
228          <td class="md" valign="top">(&nbsp;</td>
229          <td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1QueuedRenderableCollection.html#Ogre_1_1QueuedRenderableCollectionw3">QueuedRenderableCollection::OrganisationMode</a>&nbsp;</td>
230          <td class="mdname1" valign="top" nowrap> <em>om</em>          </td>
231          <td class="md" valign="top">&nbsp;)&nbsp;</td>
232          <td class="md" nowrap></td>
233        </tr>
234
235      </table>
236    </td>
237  </tr>
238</table>
239<table cellspacing=5 cellpadding=0 border=0>
240  <tr>
241    <td>
242      &nbsp;
243    </td>
244    <td>
245
246<p>
247Add a required sorting / grouping mode for the solids in this group.
248<p>
249<dl compact><dt><b>Remarks:</b></dt><dd>You can only do this when the group is empty, ie after clearing the queue. </dd></dl>
250<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="classOgre_1_1QueuedRenderableCollection.html#Ogre_1_1QueuedRenderableCollectionw3">QueuedRenderableCollection::OrganisationMode</a></dd></dl>
251
252<p>
253Definition at line <a class="el" href="OgreRenderQueueSortingGrouping_8h-source.html#l00615">615</a> of file <a class="el" href="OgreRenderQueueSortingGrouping_8h-source.html">OgreRenderQueueSortingGrouping.h</a>.    </td>
254  </tr>
255</table>
256<a class="anchor" name="Ogre_1_1RenderQueueGroupa3" doxytag="Ogre::RenderQueueGroup::addRenderable" ></a><p>
257<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
258  <tr>
259    <td class="mdRow">
260      <table cellpadding="0" cellspacing="0" border="0">
261        <tr>
262          <td class="md" nowrap valign="top"> void Ogre::RenderQueueGroup::addRenderable </td>
263          <td class="md" valign="top">(&nbsp;</td>
264          <td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1Renderable.html">Renderable</a> *&nbsp;</td>
265          <td class="mdname" nowrap> <em>pRend</em>, </td>
266        </tr>
267        <tr>
268          <td class="md" nowrap align="right"></td>
269          <td></td>
270          <td class="md" nowrap><a class="el" href="classOgre_1_1Technique.html">Technique</a> *&nbsp;</td>
271          <td class="mdname" nowrap> <em>pTech</em>, </td>
272        </tr>
273        <tr>
274          <td class="md" nowrap align="right"></td>
275          <td></td>
276          <td class="md" nowrap><a class="el" href="namespaceOgre.html#a467">ushort</a>&nbsp;</td>
277          <td class="mdname" nowrap> <em>priority</em></td>
278        </tr>
279        <tr>
280          <td></td>
281          <td class="md">)&nbsp;</td>
282          <td class="md" colspan="2"></td>
283        </tr>
284
285      </table>
286    </td>
287  </tr>
288</table>
289<table cellspacing=5 cellpadding=0 border=0>
290  <tr>
291    <td>
292      &nbsp;
293    </td>
294    <td>
295
296<p>
297Add a renderable to this group, with the given priority.
298<p>
299
300<p>
301Definition at line <a class="el" href="OgreRenderQueueSortingGrouping_8h-source.html#l00488">488</a> of file <a class="el" href="OgreRenderQueueSortingGrouping_8h-source.html">OgreRenderQueueSortingGrouping.h</a>.
302<p>
303References <a class="el" href="classOgre_1_1RenderPriorityGroup.html#Ogre_1_1RenderPriorityGroupa10">Ogre::RenderPriorityGroup::addRenderable()</a>, and <a class="el" href="OgrePrerequisites_8h-source.html#l00142">Ogre::ushort</a>.    </td>
304  </tr>
305</table>
306<a class="anchor" name="Ogre_1_1RenderQueueGroupa4" doxytag="Ogre::RenderQueueGroup::clear" ></a><p>
307<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
308  <tr>
309    <td class="mdRow">
310      <table cellpadding="0" cellspacing="0" border="0">
311        <tr>
312          <td class="md" nowrap valign="top"> void Ogre::RenderQueueGroup::clear </td>
313          <td class="md" valign="top">(&nbsp;</td>
314          <td class="md" nowrap valign="top">bool&nbsp;</td>
315          <td class="mdname1" valign="top" nowrap> <em>destroy</em> = false          </td>
316          <td class="md" valign="top">&nbsp;)&nbsp;</td>
317          <td class="md" nowrap></td>
318        </tr>
319
320      </table>
321    </td>
322  </tr>
323</table>
324<table cellspacing=5 cellpadding=0 border=0>
325  <tr>
326    <td>
327      &nbsp;
328    </td>
329    <td>
330
331<p>
332Clears this group of renderables.
333<p>
334<dl compact><dt><b>Parameters:</b></dt><dd>
335  <table border="0" cellspacing="2" cellpadding="0">
336    <tr><td valign=top><em>destroy</em>&nbsp;</td><td>If false, 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. If true, completely destroys. </td></tr>
337  </table>
338</dl>
339
340<p>
341Definition at line <a class="el" href="OgreRenderQueueSortingGrouping_8h-source.html#l00519">519</a> of file <a class="el" href="OgreRenderQueueSortingGrouping_8h-source.html">OgreRenderQueueSortingGrouping.h</a>.    </td>
342  </tr>
343</table>
344<a class="anchor" name="Ogre_1_1RenderQueueGroupa12" doxytag="Ogre::RenderQueueGroup::defaultOrganisationMode" ></a><p>
345<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
346  <tr>
347    <td class="mdRow">
348      <table cellpadding="0" cellspacing="0" border="0">
349        <tr>
350          <td class="md" nowrap valign="top"> void Ogre::RenderQueueGroup::defaultOrganisationMode </td>
351          <td class="md" valign="top">(&nbsp;</td>
352          <td class="md" nowrap valign="top">void&nbsp;</td>
353          <td class="mdname1" valign="top" nowrap>          </td>
354          <td class="md" valign="top">&nbsp;)&nbsp;</td>
355          <td class="md" nowrap></td>
356        </tr>
357
358      </table>
359    </td>
360  </tr>
361</table>
362<table cellspacing=5 cellpadding=0 border=0>
363  <tr>
364    <td>
365      &nbsp;
366    </td>
367    <td>
368
369<p>
370Setthe sorting / grouping mode for the solids in this group to the default.
371<p>
372<dl compact><dt><b>Remarks:</b></dt><dd>You can only do this when the group is empty, ie after clearing the queue. </dd></dl>
373<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="classOgre_1_1QueuedRenderableCollection.html#Ogre_1_1QueuedRenderableCollectionw3">QueuedRenderableCollection::OrganisationMode</a></dd></dl>
374
375<p>
376Definition at line <a class="el" href="OgreRenderQueueSortingGrouping_8h-source.html#l00631">631</a> of file <a class="el" href="OgreRenderQueueSortingGrouping_8h-source.html">OgreRenderQueueSortingGrouping.h</a>.    </td>
377  </tr>
378</table>
379<a class="anchor" name="Ogre_1_1RenderQueueGroupa2" doxytag="Ogre::RenderQueueGroup::getIterator" ></a><p>
380<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
381  <tr>
382    <td class="mdRow">
383      <table cellpadding="0" cellspacing="0" border="0">
384        <tr>
385          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1MapIterator.html">PriorityMapIterator</a> Ogre::RenderQueueGroup::getIterator </td>
386          <td class="md" valign="top">(&nbsp;</td>
387          <td class="md" nowrap valign="top">void&nbsp;</td>
388          <td class="mdname1" valign="top" nowrap>          </td>
389          <td class="md" valign="top">&nbsp;)&nbsp;</td>
390          <td class="md" nowrap></td>
391        </tr>
392
393      </table>
394    </td>
395  </tr>
396</table>
397<table cellspacing=5 cellpadding=0 border=0>
398  <tr>
399    <td>
400      &nbsp;
401    </td>
402    <td>
403
404<p>
405Get an iterator for browsing through child contents.
406<p>
407
408<p>
409Definition at line <a class="el" href="OgreRenderQueueSortingGrouping_8h-source.html#l00482">482</a> of file <a class="el" href="OgreRenderQueueSortingGrouping_8h-source.html">OgreRenderQueueSortingGrouping.h</a>.
410<p>
411References <a class="el" href="OgreRenderQueueSortingGrouping_8h-source.html#l00447">PriorityMapIterator</a>.    </td>
412  </tr>
413</table>
414<a class="anchor" name="Ogre_1_1RenderQueueGroupa6" doxytag="Ogre::RenderQueueGroup::getShadowsEnabled" ></a><p>
415<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
416  <tr>
417    <td class="mdRow">
418      <table cellpadding="0" cellspacing="0" border="0">
419        <tr>
420          <td class="md" nowrap valign="top"> bool Ogre::RenderQueueGroup::getShadowsEnabled </td>
421          <td class="md" valign="top">(&nbsp;</td>
422          <td class="md" nowrap valign="top">void&nbsp;</td>
423          <td class="mdname1" valign="top" nowrap>          </td>
424          <td class="md" valign="top">&nbsp;)&nbsp;</td>
425          <td class="md" nowrap> const</td>
426        </tr>
427
428      </table>
429    </td>
430  </tr>
431</table>
432<table cellspacing=5 cellpadding=0 border=0>
433  <tr>
434    <td>
435      &nbsp;
436    </td>
437    <td>
438
439<p>
440Are shadows enabled for this queue?
441<p>
442
443<p>
444Definition at line <a class="el" href="OgreRenderQueueSortingGrouping_8h-source.html#l00551">551</a> of file <a class="el" href="OgreRenderQueueSortingGrouping_8h-source.html">OgreRenderQueueSortingGrouping.h</a>.    </td>
445  </tr>
446</table>
447<a class="anchor" name="Ogre_1_1RenderQueueGroupa10" doxytag="Ogre::RenderQueueGroup::resetOrganisationModes" ></a><p>
448<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
449  <tr>
450    <td class="mdRow">
451      <table cellpadding="0" cellspacing="0" border="0">
452        <tr>
453          <td class="md" nowrap valign="top"> void Ogre::RenderQueueGroup::resetOrganisationModes </td>
454          <td class="md" valign="top">(&nbsp;</td>
455          <td class="md" nowrap valign="top">void&nbsp;</td>
456          <td class="mdname1" valign="top" nowrap>          </td>
457          <td class="md" valign="top">&nbsp;)&nbsp;</td>
458          <td class="md" nowrap></td>
459        </tr>
460
461      </table>
462    </td>
463  </tr>
464</table>
465<table cellspacing=5 cellpadding=0 border=0>
466  <tr>
467    <td>
468      &nbsp;
469    </td>
470    <td>
471
472<p>
473Reset the organisation modes required for the solids in this group.
474<p>
475<dl compact><dt><b>Remarks:</b></dt><dd>You can only do this when the group is empty, ie after clearing the queue. </dd></dl>
476<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="classOgre_1_1QueuedRenderableCollection.html#Ogre_1_1QueuedRenderableCollectionw3">QueuedRenderableCollection::OrganisationMode</a></dd></dl>
477
478<p>
479Definition at line <a class="el" href="OgreRenderQueueSortingGrouping_8h-source.html#l00599">599</a> of file <a class="el" href="OgreRenderQueueSortingGrouping_8h-source.html">OgreRenderQueueSortingGrouping.h</a>.    </td>
480  </tr>
481</table>
482<a class="anchor" name="Ogre_1_1RenderQueueGroupa9" doxytag="Ogre::RenderQueueGroup::setShadowCastersCannotBeReceivers" ></a><p>
483<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
484  <tr>
485    <td class="mdRow">
486      <table cellpadding="0" cellspacing="0" border="0">
487        <tr>
488          <td class="md" nowrap valign="top"> void Ogre::RenderQueueGroup::setShadowCastersCannotBeReceivers </td>
489          <td class="md" valign="top">(&nbsp;</td>
490          <td class="md" nowrap valign="top">bool&nbsp;</td>
491          <td class="mdname1" valign="top" nowrap> <em>ind</em>          </td>
492          <td class="md" valign="top">&nbsp;)&nbsp;</td>
493          <td class="md" nowrap></td>
494        </tr>
495
496      </table>
497    </td>
498  </tr>
499</table>
500<table cellspacing=5 cellpadding=0 border=0>
501  <tr>
502    <td>
503      &nbsp;
504    </td>
505    <td>
506
507<p>
508Sets whether or not objects which cast shadows should be treated as never receiving shadows.
509<p>
510
511<p>
512Definition at line <a class="el" href="OgreRenderQueueSortingGrouping_8h-source.html#l00583">583</a> of file <a class="el" href="OgreRenderQueueSortingGrouping_8h-source.html">OgreRenderQueueSortingGrouping.h</a>.    </td>
513  </tr>
514</table>
515<a class="anchor" name="Ogre_1_1RenderQueueGroupa5" doxytag="Ogre::RenderQueueGroup::setShadowsEnabled" ></a><p>
516<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
517  <tr>
518    <td class="mdRow">
519      <table cellpadding="0" cellspacing="0" border="0">
520        <tr>
521          <td class="md" nowrap valign="top"> void Ogre::RenderQueueGroup::setShadowsEnabled </td>
522          <td class="md" valign="top">(&nbsp;</td>
523          <td class="md" nowrap valign="top">bool&nbsp;</td>
524          <td class="mdname1" valign="top" nowrap> <em>enabled</em>          </td>
525          <td class="md" valign="top">&nbsp;)&nbsp;</td>
526          <td class="md" nowrap></td>
527        </tr>
528
529      </table>
530    </td>
531  </tr>
532</table>
533<table cellspacing=5 cellpadding=0 border=0>
534  <tr>
535    <td>
536      &nbsp;
537    </td>
538    <td>
539
540<p>
541Indicate whether a given queue group will be doing any shadow setup.
542<p>
543<dl compact><dt><b>Remarks:</b></dt><dd>This method allows you to inform the queue about a queue group, and to indicate whether this group will require shadow processing of any sort. In order to preserve rendering order, OGRE has to treat queue groups as very separate elements of the scene, and this can result in it having to duplicate shadow setup for each group. Therefore, if you know that a group which you are using will never need shadows, you should preregister the group using this method in order to improve the performance.</dd></dl>
544
545<p>
546Definition at line <a class="el" href="OgreRenderQueueSortingGrouping_8h-source.html#l00548">548</a> of file <a class="el" href="OgreRenderQueueSortingGrouping_8h-source.html">OgreRenderQueueSortingGrouping.h</a>.    </td>
547  </tr>
548</table>
549<a class="anchor" name="Ogre_1_1RenderQueueGroupa8" doxytag="Ogre::RenderQueueGroup::setSplitNoShadowPasses" ></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"> void Ogre::RenderQueueGroup::setSplitNoShadowPasses </td>
556          <td class="md" valign="top">(&nbsp;</td>
557          <td class="md" nowrap valign="top">bool&nbsp;</td>
558          <td class="mdname1" valign="top" nowrap> <em>split</em>          </td>
559          <td class="md" valign="top">&nbsp;)&nbsp;</td>
560          <td class="md" nowrap></td>
561        </tr>
562
563      </table>
564    </td>
565  </tr>
566</table>
567<table cellspacing=5 cellpadding=0 border=0>
568  <tr>
569    <td>
570      &nbsp;
571    </td>
572    <td>
573
574<p>
575Sets whether or not the queue will split passes which have shadow receive turned off (in their parent material), which is needed when certain shadow techniques are used.
576<p>
577
578<p>
579Definition at line <a class="el" href="OgreRenderQueueSortingGrouping_8h-source.html#l00570">570</a> of file <a class="el" href="OgreRenderQueueSortingGrouping_8h-source.html">OgreRenderQueueSortingGrouping.h</a>.    </td>
580  </tr>
581</table>
582<a class="anchor" name="Ogre_1_1RenderQueueGroupa7" doxytag="Ogre::RenderQueueGroup::setSplitPassesByLightingType" ></a><p>
583<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
584  <tr>
585    <td class="mdRow">
586      <table cellpadding="0" cellspacing="0" border="0">
587        <tr>
588          <td class="md" nowrap valign="top"> void Ogre::RenderQueueGroup::setSplitPassesByLightingType </td>
589          <td class="md" valign="top">(&nbsp;</td>
590          <td class="md" nowrap valign="top">bool&nbsp;</td>
591          <td class="mdname1" valign="top" nowrap> <em>split</em>          </td>
592          <td class="md" valign="top">&nbsp;)&nbsp;</td>
593          <td class="md" nowrap></td>
594        </tr>
595
596      </table>
597    </td>
598  </tr>
599</table>
600<table cellspacing=5 cellpadding=0 border=0>
601  <tr>
602    <td>
603      &nbsp;
604    </td>
605    <td>
606
607<p>
608Sets whether or not the queue will split passes by their lighting type, ie ambient, per-light and decal.
609<p>
610
611<p>
612Definition at line <a class="el" href="OgreRenderQueueSortingGrouping_8h-source.html#l00556">556</a> of file <a class="el" href="OgreRenderQueueSortingGrouping_8h-source.html">OgreRenderQueueSortingGrouping.h</a>.    </td>
613  </tr>
614</table>
615<hr><h2>Member Data Documentation</h2>
616<a class="anchor" name="Ogre_1_1RenderQueueGroupp0" doxytag="Ogre::RenderQueueGroup::mParent" ></a><p>
617<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
618  <tr>
619    <td class="mdRow">
620      <table cellpadding="0" cellspacing="0" border="0">
621        <tr>
622          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1RenderQueue.html">RenderQueue</a>* <a class="el" href="classOgre_1_1RenderQueueGroup.html#Ogre_1_1RenderQueueGroupp0">Ogre::RenderQueueGroup::mParent</a><code> [protected]</code>
623      </table>
624    </td>
625  </tr>
626</table>
627<table cellspacing=5 cellpadding=0 border=0>
628  <tr>
629    <td>
630      &nbsp;
631    </td>
632    <td>
633
634<p>
635
636<p>
637Definition at line <a class="el" href="OgreRenderQueueSortingGrouping_8h-source.html#l00449">449</a> of file <a class="el" href="OgreRenderQueueSortingGrouping_8h-source.html">OgreRenderQueueSortingGrouping.h</a>.    </td>
638  </tr>
639</table>
640<a class="anchor" name="Ogre_1_1RenderQueueGroupp4" doxytag="Ogre::RenderQueueGroup::mPriorityGroups" ></a><p>
641<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
642  <tr>
643    <td class="mdRow">
644      <table cellpadding="0" cellspacing="0" border="0">
645        <tr>
646          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1RenderQueueGroup.html#Ogre_1_1RenderQueueGroupw0">PriorityMap</a> <a class="el" href="classOgre_1_1RenderQueueGroup.html#Ogre_1_1RenderQueueGroupp4">Ogre::RenderQueueGroup::mPriorityGroups</a><code> [protected]</code>
647      </table>
648    </td>
649  </tr>
650</table>
651<table cellspacing=5 cellpadding=0 border=0>
652  <tr>
653    <td>
654      &nbsp;
655    </td>
656    <td>
657
658<p>
659Map of <a class="el" href="classOgre_1_1RenderPriorityGroup.html">RenderPriorityGroup</a> objects.
660<p>
661
662<p>
663Definition at line <a class="el" href="OgreRenderQueueSortingGrouping_8h-source.html#l00454">454</a> of file <a class="el" href="OgreRenderQueueSortingGrouping_8h-source.html">OgreRenderQueueSortingGrouping.h</a>.    </td>
664  </tr>
665</table>
666<a class="anchor" name="Ogre_1_1RenderQueueGroupp3" doxytag="Ogre::RenderQueueGroup::mShadowCastersNotReceivers" ></a><p>
667<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
668  <tr>
669    <td class="mdRow">
670      <table cellpadding="0" cellspacing="0" border="0">
671        <tr>
672          <td class="md" nowrap valign="top"> bool <a class="el" href="classOgre_1_1RenderQueueGroup.html#Ogre_1_1RenderQueueGroupp3">Ogre::RenderQueueGroup::mShadowCastersNotReceivers</a><code> [protected]</code>
673      </table>
674    </td>
675  </tr>
676</table>
677<table cellspacing=5 cellpadding=0 border=0>
678  <tr>
679    <td>
680      &nbsp;
681    </td>
682    <td>
683
684<p>
685
686<p>
687Definition at line <a class="el" href="OgreRenderQueueSortingGrouping_8h-source.html#l00452">452</a> of file <a class="el" href="OgreRenderQueueSortingGrouping_8h-source.html">OgreRenderQueueSortingGrouping.h</a>.    </td>
688  </tr>
689</table>
690<a class="anchor" name="Ogre_1_1RenderQueueGroupp5" doxytag="Ogre::RenderQueueGroup::mShadowsEnabled" ></a><p>
691<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
692  <tr>
693    <td class="mdRow">
694      <table cellpadding="0" cellspacing="0" border="0">
695        <tr>
696          <td class="md" nowrap valign="top"> bool <a class="el" href="classOgre_1_1RenderQueueGroup.html#Ogre_1_1RenderQueueGroupp5">Ogre::RenderQueueGroup::mShadowsEnabled</a><code> [protected]</code>
697      </table>
698    </td>
699  </tr>
700</table>
701<table cellspacing=5 cellpadding=0 border=0>
702  <tr>
703    <td>
704      &nbsp;
705    </td>
706    <td>
707
708<p>
709Whether shadows are enabled for this queue.
710<p>
711
712<p>
713Definition at line <a class="el" href="OgreRenderQueueSortingGrouping_8h-source.html#l00456">456</a> of file <a class="el" href="OgreRenderQueueSortingGrouping_8h-source.html">OgreRenderQueueSortingGrouping.h</a>.    </td>
714  </tr>
715</table>
716<a class="anchor" name="Ogre_1_1RenderQueueGroupp2" doxytag="Ogre::RenderQueueGroup::mSplitNoShadowPasses" ></a><p>
717<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
718  <tr>
719    <td class="mdRow">
720      <table cellpadding="0" cellspacing="0" border="0">
721        <tr>
722          <td class="md" nowrap valign="top"> bool <a class="el" href="classOgre_1_1RenderQueueGroup.html#Ogre_1_1RenderQueueGroupp2">Ogre::RenderQueueGroup::mSplitNoShadowPasses</a><code> [protected]</code>
723      </table>
724    </td>
725  </tr>
726</table>
727<table cellspacing=5 cellpadding=0 border=0>
728  <tr>
729    <td>
730      &nbsp;
731    </td>
732    <td>
733
734<p>
735
736<p>
737Definition at line <a class="el" href="OgreRenderQueueSortingGrouping_8h-source.html#l00451">451</a> of file <a class="el" href="OgreRenderQueueSortingGrouping_8h-source.html">OgreRenderQueueSortingGrouping.h</a>.    </td>
738  </tr>
739</table>
740<a class="anchor" name="Ogre_1_1RenderQueueGroupp1" doxytag="Ogre::RenderQueueGroup::mSplitPassesByLightingType" ></a><p>
741<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
742  <tr>
743    <td class="mdRow">
744      <table cellpadding="0" cellspacing="0" border="0">
745        <tr>
746          <td class="md" nowrap valign="top"> bool <a class="el" href="classOgre_1_1RenderQueueGroup.html#Ogre_1_1RenderQueueGroupp1">Ogre::RenderQueueGroup::mSplitPassesByLightingType</a><code> [protected]</code>
747      </table>
748    </td>
749  </tr>
750</table>
751<table cellspacing=5 cellpadding=0 border=0>
752  <tr>
753    <td>
754      &nbsp;
755    </td>
756    <td>
757
758<p>
759
760<p>
761Definition at line <a class="el" href="OgreRenderQueueSortingGrouping_8h-source.html#l00450">450</a> of file <a class="el" href="OgreRenderQueueSortingGrouping_8h-source.html">OgreRenderQueueSortingGrouping.h</a>.    </td>
762  </tr>
763</table>
764<hr>The documentation for this class was generated from the following file:<ul>
765<li><a class="el" href="OgreRenderQueueSortingGrouping_8h-source.html">OgreRenderQueueSortingGrouping.h</a></ul>
766<hr>
767<p>
768Copyright &copy; 2000-2005 by The OGRE Team<br />
769<!--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/>
770This 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/>
771                <!--/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#">
772                <Work rdf:about="">
773                        <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" />
774        <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" />
775                </Work>
776                <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> -->
777
778Last modified Sun Mar 12 14:42:10 2006
779</p>
780</body>
781</html>
Note: See TracBrowser for help on using the repository browser.