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

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

adding ogre 1.2 and dependencies
RevLine 
[692]1<html>
2<head>
3<title>OgreRenderQueue.h Source File - 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>OgreRenderQueue.h</h1><a href="OgreRenderQueue_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre>00001 <span class="comment">/*</span>
1100002 <span class="comment">-----------------------------------------------------------------------------</span>
1200003 <span class="comment">This source file is part of OGRE</span>
1300004 <span class="comment">    (Object-oriented Graphics Rendering Engine)</span>
1400005 <span class="comment">For the latest info, see http://www.ogre3d.org/</span>
1500006 <span class="comment"></span>
1600007 <span class="comment">Copyright (c) 2000-2005 The OGRE Team</span>
1700008 <span class="comment">Also see acknowledgements in Readme.html</span>
1800009 <span class="comment"></span>
1900010 <span class="comment">This program is free software; you can redistribute it and/or modify it under</span>
2000011 <span class="comment">the terms of the GNU Lesser General Public License as published by the Free Software</span>
2100012 <span class="comment">Foundation; either version 2 of the License, or (at your option) any later</span>
2200013 <span class="comment">version.</span>
2300014 <span class="comment"></span>
2400015 <span class="comment">This program is distributed in the hope that it will be useful, but WITHOUT</span>
2500016 <span class="comment">ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS</span>
2600017 <span class="comment">FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.</span>
2700018 <span class="comment"></span>
2800019 <span class="comment">You should have received a copy of the GNU Lesser General Public License along with</span>
2900020 <span class="comment">this program; if not, write to the Free Software Foundation, Inc., 59 Temple</span>
3000021 <span class="comment">Place - Suite 330, Boston, MA 02111-1307, USA, or go to</span>
3100022 <span class="comment">http://www.gnu.org/copyleft/lesser.txt.</span>
3200023 <span class="comment">-----------------------------------------------------------------------------</span>
3300024 <span class="comment">*/</span>
3400025 <span class="preprocessor">#ifndef __RenderQueue_H__</span>
3500026 <span class="preprocessor"></span><span class="preprocessor">#define __RenderQueue_H__</span>
3600027 <span class="preprocessor"></span>
3700028 <span class="preprocessor">#include "<a class="code" href="OgrePrerequisites_8h.html">OgrePrerequisites.h</a>"</span>
3800029 <span class="preprocessor">#include "<a class="code" href="OgreIteratorWrappers_8h.html">OgreIteratorWrappers.h</a>"</span>
3900030
4000031 <span class="keyword">namespace </span>Ogre {
4100032
42<a name="l00039"></a><a class="code" href="namespaceOgre.html#a674">00039</a>     <span class="keyword">enum</span> <a class="code" href="namespaceOgre.html#a674">RenderQueueGroupID</a>
4300040     {
4400042         <a class="code" href="namespaceOgre.html#a674a472">RENDER_QUEUE_BACKGROUND</a> = 0,
4500044         <a class="code" href="namespaceOgre.html#a674a473">RENDER_QUEUE_SKIES_EARLY</a> = 5,
4600045         <a class="code" href="namespaceOgre.html#a674a474">RENDER_QUEUE_1</a> = 10,
4700046         <a class="code" href="namespaceOgre.html#a674a475">RENDER_QUEUE_2</a> = 20,
4800047         <a class="code" href="namespaceOgre.html#a674a476">RENDER_QUEUE_WORLD_GEOMETRY_1</a> = 25,
4900048         <a class="code" href="namespaceOgre.html#a674a477">RENDER_QUEUE_3</a> = 30,
5000049         <a class="code" href="namespaceOgre.html#a674a478">RENDER_QUEUE_4</a> = 40,
5100051         <a class="code" href="namespaceOgre.html#a674a479">RENDER_QUEUE_MAIN</a> = 50,
5200052         <a class="code" href="namespaceOgre.html#a674a480">RENDER_QUEUE_6</a> = 60,
5300053         <a class="code" href="namespaceOgre.html#a674a481">RENDER_QUEUE_7</a> = 70,
5400054         <a class="code" href="namespaceOgre.html#a674a482">RENDER_QUEUE_WORLD_GEOMETRY_2</a> = 75,
5500055         <a class="code" href="namespaceOgre.html#a674a483">RENDER_QUEUE_8</a> = 80,
5600056         <a class="code" href="namespaceOgre.html#a674a484">RENDER_QUEUE_9</a> = 90,
5700058         <a class="code" href="namespaceOgre.html#a674a485">RENDER_QUEUE_SKIES_LATE</a> = 95,
5800060         <a class="code" href="namespaceOgre.html#a674a486">RENDER_QUEUE_OVERLAY</a> = 100
5900061     };
6000062
61<a name="l00063"></a><a class="code" href="OgreRenderQueue_8h.html#a0">00063</a> <span class="preprocessor">    #define OGRE_RENDERABLE_DEFAULT_PRIORITY  100</span>
6200064 <span class="preprocessor"></span>
63<a name="l00076"></a><a class="code" href="classOgre_1_1RenderQueue.html">00076</a>     <span class="keyword">class </span><a class="code" href="OgrePlatform_8h.html#a16">_OgreExport</a> RenderQueue
6400077     {
6500078     <span class="keyword">public</span>:
66<a name="l00079"></a><a class="code" href="classOgre_1_1RenderQueue.html#Ogre_1_1RenderQueuew0">00079</a>         <span class="keyword">typedef</span> std::map&lt; uint8, RenderQueueGroup* &gt; <a class="code" href="classOgre_1_1RenderQueue.html#Ogre_1_1RenderQueuew0">RenderQueueGroupMap</a>;
67<a name="l00081"></a><a class="code" href="classOgre_1_1RenderQueue.html#Ogre_1_1RenderQueuew1">00081</a>         <span class="keyword">typedef</span> <a class="code" href="classOgre_1_1MapIterator.html">MapIterator&lt;RenderQueueGroupMap&gt;</a> <a class="code" href="classOgre_1_1MapIterator.html">QueueGroupIterator</a>;
68<a name="l00087"></a><a class="code" href="classOgre_1_1RenderQueue_1_1RenderableListener.html">00087</a>         <span class="keyword">class </span><a class="code" href="class__OgreExport.html">_OgreExport</a> RenderableListener
6900088         {
7000089         <span class="keyword">public</span>:
71<a name="l00090"></a><a class="code" href="classOgre_1_1RenderQueue_1_1RenderableListener.html#Ogre_1_1RenderQueue_1_1RenderableListenera0">00090</a>             RenderableListener() {}
72<a name="l00091"></a><a class="code" href="classOgre_1_1RenderQueue_1_1RenderableListener.html#Ogre_1_1RenderQueue_1_1RenderableListenera1">00091</a>             <span class="keyword">virtual</span> ~RenderableListener() {}
7300092
7400109             <span class="keyword">virtual</span> <span class="keywordtype">bool</span> renderableQueued(<a class="code" href="classOgre_1_1Renderable.html">Renderable</a>* rend, <a class="code" href="namespaceOgre.html#a457">uint8</a> groupID,
7500110                 <a class="code" href="namespaceOgre.html#a467">ushort</a> priority, <a class="code" href="classOgre_1_1Technique.html">Technique</a>** ppTech) = 0;
7600111         };
7700112     <span class="keyword">protected</span>:
78<a name="l00113"></a><a class="code" href="classOgre_1_1RenderQueue.html#Ogre_1_1RenderQueuep0">00113</a>         <a class="code" href="classOgre_1_1RenderQueue.html#Ogre_1_1RenderQueuew0">RenderQueueGroupMap</a> mGroups;
79<a name="l00115"></a><a class="code" href="classOgre_1_1RenderQueue.html#Ogre_1_1RenderQueuep1">00115</a>         <a class="code" href="namespaceOgre.html#a457">uint8</a> mDefaultQueueGroup;
80<a name="l00117"></a><a class="code" href="classOgre_1_1RenderQueue.html#Ogre_1_1RenderQueuep2">00117</a>         <a class="code" href="namespaceOgre.html#a467">ushort</a> mDefaultRenderablePriority;
8100118
82<a name="l00119"></a><a class="code" href="classOgre_1_1RenderQueue.html#Ogre_1_1RenderQueuep3">00119</a>         <span class="keywordtype">bool</span> mSplitPassesByLightingType;
83<a name="l00120"></a><a class="code" href="classOgre_1_1RenderQueue.html#Ogre_1_1RenderQueuep4">00120</a>         <span class="keywordtype">bool</span> mSplitNoShadowPasses;
84<a name="l00121"></a><a class="code" href="classOgre_1_1RenderQueue.html#Ogre_1_1RenderQueuep5">00121</a>         <span class="keywordtype">bool</span> mShadowCastersCannotBeReceivers;
8500122
86<a name="l00123"></a><a class="code" href="classOgre_1_1RenderQueue.html#Ogre_1_1RenderQueuep6">00123</a>         RenderableListener* mRenderableListener;
8700124     <span class="keyword">public</span>:
8800125         RenderQueue();
8900126         <span class="keyword">virtual</span> ~RenderQueue();
9000127
9100132         <span class="keywordtype">void</span> clear(<span class="keywordtype">bool</span> destroyPassMaps = <span class="keyword">false</span>);
9200133
9300139         <a class="code" href="classOgre_1_1RenderQueueGroup.html">RenderQueueGroup</a>* getQueueGroup(<a class="code" href="namespaceOgre.html#a457">uint8</a> qid);
9400140
9500163         <span class="keywordtype">void</span> addRenderable(<a class="code" href="classOgre_1_1Renderable.html">Renderable</a>* pRend, <a class="code" href="namespaceOgre.html#a457">uint8</a> groupID, <a class="code" href="namespaceOgre.html#a467">ushort</a> priority);
9600164
9700182         <span class="keywordtype">void</span> addRenderable(<a class="code" href="classOgre_1_1Renderable.html">Renderable</a>* pRend, <a class="code" href="namespaceOgre.html#a457">uint8</a> groupId);
9800183
9900196         <span class="keywordtype">void</span> addRenderable(<a class="code" href="classOgre_1_1Renderable.html">Renderable</a>* pRend);
10000197         
10100201         <a class="code" href="namespaceOgre.html#a457">uint8</a> getDefaultQueueGroup(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
10200202
10300207         <span class="keywordtype">void</span> setDefaultRenderablePriority(<a class="code" href="namespaceOgre.html#a467">ushort</a> priority);
10400208
10500212         <a class="code" href="namespaceOgre.html#a467">ushort</a> getDefaultRenderablePriority(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
10600213
10700217         <span class="keywordtype">void</span> setDefaultQueueGroup(<a class="code" href="namespaceOgre.html#a457">uint8</a> grp);
10800218         
10900220         <a class="code" href="classOgre_1_1MapIterator.html">QueueGroupIterator</a> _getQueueGroupIterator(<span class="keywordtype">void</span>);
11000224         <span class="keywordtype">void</span> setSplitPassesByLightingType(<span class="keywordtype">bool</span> split);
11100229         <span class="keywordtype">void</span> setSplitNoShadowPasses(<span class="keywordtype">bool</span> split);
11200233         <span class="keywordtype">void</span> setShadowCastersCannotBeReceivers(<span class="keywordtype">bool</span> ind);
11300234
114<a name="l00240"></a><a class="code" href="classOgre_1_1RenderQueue.html#Ogre_1_1RenderQueuea15">00240</a>         <span class="keywordtype">void</span> setRenderableListener(RenderableListener* listener)
11500241         { mRenderableListener = listener; }
11600242
117<a name="l00243"></a><a class="code" href="classOgre_1_1RenderQueue.html#Ogre_1_1RenderQueuea16">00243</a>         RenderableListener* getRenderableListener(<span class="keywordtype">void</span>)<span class="keyword"> const</span>
11800244 <span class="keyword">        </span>{ <span class="keywordflow">return</span> mRenderableListener; }
11900245
12000246     };
12100247
12200248
12300249 }
12400250
12500251
12600252 <span class="preprocessor">#endif</span>
127</pre></div><hr>
128<p>
129Copyright &copy; 2000-2005 by The OGRE Team<br />
130<!--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/>
131This 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/>
132                <!--/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#">
133                <Work rdf:about="">
134                        <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" />
135        <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" />
136                </Work>
137                <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> -->
138
139Last modified Sun Mar 12 14:37:47 2006
140</p>
141</body>
142</html>
Note: See TracBrowser for help on using the repository browser.