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

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

adding ogre 1.2 and dependencies
Line 
1<html>
2<head>
3<title>OgreParticleSystemManager.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>OgreParticleSystemManager.h</h1><a href="OgreParticleSystemManager_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 __ParticleSystemManager_H__</span>
3500026 <span class="preprocessor"></span><span class="preprocessor">#define __ParticleSystemManager_H__</span>
3600027 <span class="preprocessor"></span>
3700028
3800029 <span class="preprocessor">#include "<a class="code" href="OgrePrerequisites_8h.html">OgrePrerequisites.h</a>"</span>
3900030 <span class="preprocessor">#include "<a class="code" href="OgreParticleSystem_8h.html">OgreParticleSystem.h</a>"</span>
4000031 <span class="preprocessor">#include "<a class="code" href="OgreFrameListener_8h.html">OgreFrameListener.h</a>"</span>
4100032 <span class="preprocessor">#include "<a class="code" href="OgreSingleton_8h.html">OgreSingleton.h</a>"</span>
4200033 <span class="preprocessor">#include "<a class="code" href="OgreIteratorWrappers_8h.html">OgreIteratorWrappers.h</a>"</span>
4300034 <span class="preprocessor">#include "<a class="code" href="OgreScriptLoader_8h.html">OgreScriptLoader.h</a>"</span>
4400035 <span class="preprocessor">#include "<a class="code" href="OgreResourceGroupManager_8h.html">OgreResourceGroupManager.h</a>"</span>
4500036
4600037 <span class="keyword">namespace </span>Ogre {
4700038
4800039     <span class="comment">// Forward decl</span>
4900040     <span class="keyword">class </span>ParticleSystemFactory;
5000041     
51<a name="l00067"></a><a class="code" href="classOgre_1_1ParticleSystemManager.html">00067</a>     <span class="keyword">class </span><a class="code" href="OgrePlatform_8h.html#a16">_OgreExport</a> ParticleSystemManager:
5200068         <span class="keyword">public</span> <a class="code" href="classOgre_1_1Singleton.html">Singleton</a>&lt;ParticleSystemManager&gt;, <span class="keyword">public</span> <a class="code" href="classOgre_1_1ScriptLoader.html">ScriptLoader</a>
5300069     {
54<a name="l00070"></a><a class="code" href="classOgre_1_1ParticleSystemManager.html#Ogre_1_1ParticleSystemManagern0">00070</a>         <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classOgre_1_1ParticleSystemFactory.html">ParticleSystemFactory</a>;
5500071     <span class="keyword">public</span>:
56<a name="l00072"></a><a class="code" href="classOgre_1_1ParticleSystemManager.html#Ogre_1_1ParticleSystemManagerw0">00072</a>         <span class="keyword">typedef</span> std::map&lt;String, ParticleSystem*&gt; <a class="code" href="classOgre_1_1ParticleSystemManager.html#Ogre_1_1ParticleSystemManagerw0">ParticleTemplateMap</a>;
57<a name="l00073"></a><a class="code" href="classOgre_1_1ParticleSystemManager.html#Ogre_1_1ParticleSystemManagerw1">00073</a>         <span class="keyword">typedef</span> std::map&lt;String, ParticleAffectorFactory*&gt; <a class="code" href="classOgre_1_1ParticleSystemManager.html#Ogre_1_1ParticleSystemManagerw1">ParticleAffectorFactoryMap</a>;
58<a name="l00074"></a><a class="code" href="classOgre_1_1ParticleSystemManager.html#Ogre_1_1ParticleSystemManagerw2">00074</a>         <span class="keyword">typedef</span> std::map&lt;String, ParticleEmitterFactory*&gt; <a class="code" href="classOgre_1_1ParticleSystemManager.html#Ogre_1_1ParticleSystemManagerw2">ParticleEmitterFactoryMap</a>;
59<a name="l00075"></a><a class="code" href="classOgre_1_1ParticleSystemManager.html#Ogre_1_1ParticleSystemManagerw3">00075</a>         <span class="keyword">typedef</span> std::map&lt;String, ParticleSystemRendererFactory*&gt; <a class="code" href="classOgre_1_1ParticleSystemManager.html#Ogre_1_1ParticleSystemManagerw3">ParticleSystemRendererFactoryMap</a>;
6000076     <span class="keyword">protected</span>:
61<a name="l00078"></a><a class="code" href="classOgre_1_1ParticleSystemManager.html#Ogre_1_1ParticleSystemManagerp0">00078</a>         <a class="code" href="classOgre_1_1ParticleSystemManager.html#Ogre_1_1ParticleSystemManagerw0">ParticleTemplateMap</a> mSystemTemplates;
6200079         
63<a name="l00081"></a><a class="code" href="classOgre_1_1ParticleSystemManager.html#Ogre_1_1ParticleSystemManagerp1">00081</a>         <a class="code" href="classOgre_1_1ParticleSystemManager.html#Ogre_1_1ParticleSystemManagerw2">ParticleEmitterFactoryMap</a> mEmitterFactories;
6400082
65<a name="l00084"></a><a class="code" href="classOgre_1_1ParticleSystemManager.html#Ogre_1_1ParticleSystemManagerp2">00084</a>         <a class="code" href="classOgre_1_1ParticleSystemManager.html#Ogre_1_1ParticleSystemManagerw1">ParticleAffectorFactoryMap</a> mAffectorFactories;
6600085
67<a name="l00087"></a><a class="code" href="classOgre_1_1ParticleSystemManager.html#Ogre_1_1ParticleSystemManagerp3">00087</a>         <a class="code" href="classOgre_1_1ParticleSystemManager.html#Ogre_1_1ParticleSystemManagerw3">ParticleSystemRendererFactoryMap</a> mRendererFactories;
6800088
69<a name="l00089"></a><a class="code" href="classOgre_1_1ParticleSystemManager.html#Ogre_1_1ParticleSystemManagerp4">00089</a>         <a class="code" href="namespaceOgre.html#a580">StringVector</a> mScriptPatterns;
7000090
7100091         <span class="comment">// Factory instance</span>
72<a name="l00092"></a><a class="code" href="classOgre_1_1ParticleSystemManager.html#Ogre_1_1ParticleSystemManagerp5">00092</a>         <a class="code" href="classOgre_1_1ParticleSystemFactory.html">ParticleSystemFactory</a>* mFactory;
7300093
7400095         <span class="keywordtype">void</span> parseNewEmitter(<span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a471">String</a>&amp; type, <a class="code" href="classOgre_1_1SharedPtr.html">DataStreamPtr</a>&amp; chunk, <a class="code" href="classOgre_1_1ParticleSystem.html">ParticleSystem</a>* sys);
7500097         <span class="keywordtype">void</span> parseNewAffector(<span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a471">String</a>&amp; type, <a class="code" href="classOgre_1_1SharedPtr.html">DataStreamPtr</a>&amp; chunk, <a class="code" href="classOgre_1_1ParticleSystem.html">ParticleSystem</a>* sys);
7600099         <span class="keywordtype">void</span> parseAttrib(<span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a471">String</a>&amp; line, <a class="code" href="classOgre_1_1ParticleSystem.html">ParticleSystem</a>* sys);
7700101         <span class="keywordtype">void</span> parseEmitterAttrib(<span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a471">String</a>&amp; line, <a class="code" href="classOgre_1_1ParticleEmitter.html">ParticleEmitter</a>* sys);
7800103         <span class="keywordtype">void</span> parseAffectorAttrib(<span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a471">String</a>&amp; line, <a class="code" href="classOgre_1_1ParticleAffector.html">ParticleAffector</a>* sys);
7900105         <span class="keywordtype">void</span> skipToNextCloseBrace(<a class="code" href="classOgre_1_1SharedPtr.html">DataStreamPtr</a>&amp; chunk);
8000107         <span class="keywordtype">void</span> skipToNextOpenBrace(<a class="code" href="classOgre_1_1SharedPtr.html">DataStreamPtr</a>&amp; chunk);
8100108
8200110         <a class="code" href="classOgre_1_1ParticleSystem.html">ParticleSystem</a>* createSystemImpl(<span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a471">String</a>&amp; name, size_t quota,
8300111             <span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a471">String</a>&amp; resourceGroup);
8400113         <a class="code" href="classOgre_1_1ParticleSystem.html">ParticleSystem</a>* createSystemImpl(<span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a471">String</a>&amp; name, <span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a471">String</a>&amp; templateName);
8500115         <span class="keywordtype">void</span> destroySystemImpl(<a class="code" href="classOgre_1_1ParticleSystem.html">ParticleSystem</a>* sys);
8600116         
8700117         
8800118     <span class="keyword">public</span>:
8900119
9000120         ParticleSystemManager();
9100121         <span class="keyword">virtual</span> ~ParticleSystemManager();
9200122
9300140         <span class="keywordtype">void</span> addEmitterFactory(<a class="code" href="classOgre_1_1ParticleEmitterFactory.html">ParticleEmitterFactory</a>* factory);
9400141
9500159         <span class="keywordtype">void</span> addAffectorFactory(<a class="code" href="classOgre_1_1ParticleAffectorFactory.html">ParticleAffectorFactory</a>* factory);
9600160
9700169         <span class="keywordtype">void</span> addRendererFactory(<a class="code" href="classOgre_1_1ParticleSystemRendererFactory.html">ParticleSystemRendererFactory</a>* factory);
9800170
9900187         <span class="keywordtype">void</span> addTemplate(<span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a471">String</a>&amp; name, <a class="code" href="classOgre_1_1ParticleSystem.html">ParticleSystem</a>* sysTemplate);
10000188
10100201         <a class="code" href="classOgre_1_1ParticleSystem.html">ParticleSystem</a>* createTemplate(<span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a471">String</a>&amp; name, <span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a471">String</a>&amp; resourceGroup);
10200202
10300208         <a class="code" href="classOgre_1_1ParticleSystem.html">ParticleSystem</a>* getTemplate(<span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a471">String</a>&amp; name);
10400209
10500220         <a class="code" href="classOgre_1_1ParticleEmitter.html">ParticleEmitter</a>* _createEmitter(<span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a471">String</a>&amp; emitterType, <a class="code" href="classOgre_1_1ParticleSystem.html">ParticleSystem</a>* psys);
10600221
10700230         <span class="keywordtype">void</span> _destroyEmitter(<a class="code" href="classOgre_1_1ParticleEmitter.html">ParticleEmitter</a>* emitter);
10800231
10900242         <a class="code" href="classOgre_1_1ParticleAffector.html">ParticleAffector</a>* _createAffector(<span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a471">String</a>&amp; affectorType, <a class="code" href="classOgre_1_1ParticleSystem.html">ParticleSystem</a>* psys);
11000243
11100252         <span class="keywordtype">void</span> _destroyAffector(<a class="code" href="classOgre_1_1ParticleAffector.html">ParticleAffector</a>* affector);
11200253
11300262         <a class="code" href="classOgre_1_1ParticleSystemRenderer.html">ParticleSystemRenderer</a>* _createRenderer(<span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a471">String</a>&amp; rendererType);
11400263
11500272         <span class="keywordtype">void</span> _destroyRenderer(<a class="code" href="classOgre_1_1ParticleSystemRenderer.html">ParticleSystemRenderer</a>* renderer);
11600273
11700275         <span class="keywordtype">bool</span> frameStarted(<span class="keyword">const</span> <a class="code" href="structOgre_1_1FrameEvent.html">FrameEvent</a> &amp;evt);
11800276
11900278         <span class="keywordtype">bool</span> frameEnded(<span class="keyword">const</span> <a class="code" href="structOgre_1_1FrameEvent.html">FrameEvent</a> &amp;evt);
12000279
12100285         <span class="keywordtype">void</span> _initialise(<span class="keywordtype">void</span>);
12200286
12300288         <span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a580">StringVector</a>&amp; getScriptPatterns(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
12400290         <span class="keywordtype">void</span> parseScript(<a class="code" href="classOgre_1_1SharedPtr.html">DataStreamPtr</a>&amp; stream, <span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a471">String</a>&amp; groupName);
12500292         <a class="code" href="namespaceOgre.html#a465">Real</a> getLoadingOrder(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
12600293
127<a name="l00294"></a><a class="code" href="classOgre_1_1ParticleSystemManager.html#Ogre_1_1ParticleSystemManagerw4">00294</a>         <span class="keyword">typedef</span> <a class="code" href="classOgre_1_1MapIterator.html">MapIterator&lt;ParticleAffectorFactoryMap&gt;</a> <a class="code" href="classOgre_1_1MapIterator.html">ParticleAffectorFactoryIterator</a>;
128<a name="l00295"></a><a class="code" href="classOgre_1_1ParticleSystemManager.html#Ogre_1_1ParticleSystemManagerw5">00295</a>         <span class="keyword">typedef</span> <a class="code" href="classOgre_1_1MapIterator.html">MapIterator&lt;ParticleEmitterFactoryMap&gt;</a> <a class="code" href="classOgre_1_1MapIterator.html">ParticleEmitterFactoryIterator</a>;
129<a name="l00296"></a><a class="code" href="classOgre_1_1ParticleSystemManager.html#Ogre_1_1ParticleSystemManagerw6">00296</a>         <span class="keyword">typedef</span> <a class="code" href="classOgre_1_1MapIterator.html">MapIterator&lt;ParticleSystemRendererFactoryMap&gt;</a> <a class="code" href="classOgre_1_1MapIterator.html">ParticleRendererFactoryIterator</a>;
13000298         <a class="code" href="classOgre_1_1MapIterator.html">ParticleAffectorFactoryIterator</a> getAffectorFactoryIterator(<span class="keywordtype">void</span>);
13100300         <a class="code" href="classOgre_1_1MapIterator.html">ParticleEmitterFactoryIterator</a> getEmitterFactoryIterator(<span class="keywordtype">void</span>);
13200302         <a class="code" href="classOgre_1_1MapIterator.html">ParticleRendererFactoryIterator</a> getRendererFactoryIterator(<span class="keywordtype">void</span>);
13300303
13400304
135<a name="l00305"></a><a class="code" href="classOgre_1_1ParticleSystemManager.html#Ogre_1_1ParticleSystemManagerw7">00305</a>         <span class="keyword">typedef</span> <a class="code" href="classOgre_1_1MapIterator.html">MapIterator&lt;ParticleTemplateMap&gt;</a> <a class="code" href="classOgre_1_1MapIterator.html">ParticleSystemTemplateIterator</a>;
136<a name="l00307"></a><a class="code" href="classOgre_1_1ParticleSystemManager.html#Ogre_1_1ParticleSystemManagera23">00307</a>         <a class="code" href="classOgre_1_1MapIterator.html">ParticleSystemTemplateIterator</a> getTemplateIterator(<span class="keywordtype">void</span>)
13700308         {
13800309             <span class="keywordflow">return</span> <a class="code" href="classOgre_1_1MapIterator.html">ParticleSystemTemplateIterator</a>(
13900310                 mSystemTemplates.begin(), mSystemTemplates.end());
14000311         }
14100312
142<a name="l00314"></a><a class="code" href="classOgre_1_1ParticleSystemManager.html#Ogre_1_1ParticleSystemManagera24">00314</a>         <a class="code" href="classOgre_1_1ParticleSystemFactory.html">ParticleSystemFactory</a>* _getFactory(<span class="keywordtype">void</span>) { <span class="keywordflow">return</span> mFactory; }
14300315         
14400331         <span class="keyword">static</span> ParticleSystemManager&amp; getSingleton(<span class="keywordtype">void</span>);
14500347         <span class="keyword">static</span> ParticleSystemManager* getSingletonPtr(<span class="keywordtype">void</span>);
14600348
14700349     };
14800350
149<a name="l00352"></a><a class="code" href="classOgre_1_1ParticleSystemFactory.html">00352</a>     <span class="keyword">class </span><a class="code" href="class__OgreExport.html">_OgreExport</a> ParticleSystemFactory : <span class="keyword">public</span> <a class="code" href="classOgre_1_1MovableObjectFactory.html">MovableObjectFactory</a>
15000353     {
15100354     <span class="keyword">protected</span>:
15200355         <a class="code" href="classOgre_1_1MovableObject.html">MovableObject</a>* createInstanceImpl(<span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a471">String</a>&amp; name, <span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a76">NameValuePairList</a>* params);
15300356     <span class="keyword">public</span>:
154<a name="l00357"></a><a class="code" href="classOgre_1_1ParticleSystemFactory.html#Ogre_1_1ParticleSystemFactorya0">00357</a>         ParticleSystemFactory() {}
155<a name="l00358"></a><a class="code" href="classOgre_1_1ParticleSystemFactory.html#Ogre_1_1ParticleSystemFactorya1">00358</a>         ~ParticleSystemFactory() {}
15600359         
157<a name="l00360"></a><a class="code" href="classOgre_1_1ParticleSystemFactory.html#Ogre_1_1ParticleSystemFactorys0">00360</a>         <span class="keyword">static</span> <a class="code" href="namespaceOgre.html#a471">String</a> FACTORY_TYPE_NAME;
15800361
15900362         <span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a471">String</a>&amp; getType(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
16000363         <span class="keywordtype">void</span> destroyInstance( <a class="code" href="classOgre_1_1MovableObject.html">MovableObject</a>* obj); 
16100364
16200365     };
16300366     
16400367 }
16500368
16600369 <span class="preprocessor">#endif</span>
16700370 <span class="preprocessor"></span>
168</pre></div><hr>
169<p>
170Copyright &copy; 2000-2005 by The OGRE Team<br />
171<!--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/>
172This 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/>
173                <!--/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#">
174                <Work rdf:about="">
175                        <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" />
176        <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" />
177                </Work>
178                <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> -->
179
180Last modified Sun Mar 12 14:37:46 2006
181</p>
182</body>
183</html>
Note: See TracBrowser for help on using the repository browser.