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

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

added ogre dependencies and patched ogre sources
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
48<a name="l00057"></a><a class="code" href="classOgre_1_1ParticleSystemManager.html">00057</a>     <span class="keyword">class </span><a class="code" href="OgrePlatform_8h.html#a16">_OgreExport</a> ParticleSystemManager: <span class="keyword">public</span> <a class="code" href="classOgre_1_1Singleton.html">Singleton</a>&lt;ParticleSystemManager&gt;,
4900058         <span class="keyword">public</span> <a class="code" href="classOgre_1_1FrameListener.html">FrameListener</a>, <span class="keyword">public</span> <a class="code" href="classOgre_1_1ScriptLoader.html">ScriptLoader</a>
5000059     {
5100060     <span class="keyword">public</span>:
52<a name="l00061"></a><a class="code" href="classOgre_1_1ParticleSystemManager.html#Ogre_1_1ParticleSystemManagerw0">00061</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>;
53<a name="l00062"></a><a class="code" href="classOgre_1_1ParticleSystemManager.html#Ogre_1_1ParticleSystemManagerw1">00062</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>;
54<a name="l00063"></a><a class="code" href="classOgre_1_1ParticleSystemManager.html#Ogre_1_1ParticleSystemManagerw2">00063</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>;
55<a name="l00064"></a><a class="code" href="classOgre_1_1ParticleSystemManager.html#Ogre_1_1ParticleSystemManagerw3">00064</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>;
5600065     <span class="keyword">protected</span>:
57<a name="l00067"></a><a class="code" href="classOgre_1_1ParticleSystemManager.html#Ogre_1_1ParticleSystemManagerp0">00067</a>         <a class="code" href="classOgre_1_1ParticleSystemManager.html#Ogre_1_1ParticleSystemManagerw0">ParticleTemplateMap</a> mSystemTemplates;
5800068         
59<a name="l00069"></a><a class="code" href="classOgre_1_1ParticleSystemManager.html#Ogre_1_1ParticleSystemManagerx0">00069</a>         <span class="keyword">typedef</span> std::map&lt;String, ParticleSystem*&gt; <a class="code" href="classOgre_1_1ParticleSystemManager.html#Ogre_1_1ParticleSystemManagerx0">ParticleSystemMap</a>;
60<a name="l00071"></a><a class="code" href="classOgre_1_1ParticleSystemManager.html#Ogre_1_1ParticleSystemManagerp1">00071</a>         <a class="code" href="classOgre_1_1ParticleSystemManager.html#Ogre_1_1ParticleSystemManagerx0">ParticleSystemMap</a> mSystems;
6100072
62<a name="l00074"></a><a class="code" href="classOgre_1_1ParticleSystemManager.html#Ogre_1_1ParticleSystemManagerp2">00074</a>         <a class="code" href="classOgre_1_1ParticleSystemManager.html#Ogre_1_1ParticleSystemManagerw2">ParticleEmitterFactoryMap</a> mEmitterFactories;
6300075
64<a name="l00077"></a><a class="code" href="classOgre_1_1ParticleSystemManager.html#Ogre_1_1ParticleSystemManagerp3">00077</a>         <a class="code" href="classOgre_1_1ParticleSystemManager.html#Ogre_1_1ParticleSystemManagerw1">ParticleAffectorFactoryMap</a> mAffectorFactories;
6500078
66<a name="l00080"></a><a class="code" href="classOgre_1_1ParticleSystemManager.html#Ogre_1_1ParticleSystemManagerp4">00080</a>         <a class="code" href="classOgre_1_1ParticleSystemManager.html#Ogre_1_1ParticleSystemManagerw3">ParticleSystemRendererFactoryMap</a> mRendererFactories;
6700081
68<a name="l00082"></a><a class="code" href="classOgre_1_1ParticleSystemManager.html#Ogre_1_1ParticleSystemManagerp5">00082</a>         <a class="code" href="namespaceOgre.html#a535">StringVector</a> mScriptPatterns;
6900083
70<a name="l00085"></a><a class="code" href="classOgre_1_1ParticleSystemManager.html#Ogre_1_1ParticleSystemManagerp6">00085</a>         <a class="code" href="namespaceOgre.html#a420">Real</a> mTimeFactor;
7100086
7200088         <span class="keywordtype">void</span> parseNewEmitter(<span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a426">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);
7300090         <span class="keywordtype">void</span> parseNewAffector(<span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a426">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);
7400092         <span class="keywordtype">void</span> parseAttrib(<span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a426">String</a>&amp; line, <a class="code" href="classOgre_1_1ParticleSystem.html">ParticleSystem</a>* sys);
7500094         <span class="keywordtype">void</span> parseEmitterAttrib(<span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a426">String</a>&amp; line, <a class="code" href="classOgre_1_1ParticleEmitter.html">ParticleEmitter</a>* sys);
7600096         <span class="keywordtype">void</span> parseAffectorAttrib(<span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a426">String</a>&amp; line, <a class="code" href="classOgre_1_1ParticleAffector.html">ParticleAffector</a>* sys);
7700098         <span class="keywordtype">void</span> skipToNextCloseBrace(<a class="code" href="classOgre_1_1SharedPtr.html">DataStreamPtr</a>&amp; chunk);
7800100         <span class="keywordtype">void</span> skipToNextOpenBrace(<a class="code" href="classOgre_1_1SharedPtr.html">DataStreamPtr</a>&amp; chunk);
7900101     <span class="keyword">public</span>:
8000102
8100103         ParticleSystemManager();
8200104         <span class="keyword">virtual</span> ~ParticleSystemManager();
8300105
8400123         <span class="keywordtype">void</span> addEmitterFactory(<a class="code" href="classOgre_1_1ParticleEmitterFactory.html">ParticleEmitterFactory</a>* factory);
8500124
8600142         <span class="keywordtype">void</span> addAffectorFactory(<a class="code" href="classOgre_1_1ParticleAffectorFactory.html">ParticleAffectorFactory</a>* factory);
8700143
8800152         <span class="keywordtype">void</span> addRendererFactory(<a class="code" href="classOgre_1_1ParticleSystemRendererFactory.html">ParticleSystemRendererFactory</a>* factory);
8900153
9000170         <span class="keywordtype">void</span> addTemplate(<span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a426">String</a>&amp; name, <a class="code" href="classOgre_1_1ParticleSystem.html">ParticleSystem</a>* sysTemplate);
9100171
9200184         <a class="code" href="classOgre_1_1ParticleSystem.html">ParticleSystem</a>* createTemplate(<span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a426">String</a>&amp; name, <span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a426">String</a>&amp; resourceGroup);
9300185
9400191         <a class="code" href="classOgre_1_1ParticleSystem.html">ParticleSystem</a>* getTemplate(<span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a426">String</a>&amp; name);
9500192
9600212         <a class="code" href="classOgre_1_1ParticleSystem.html">ParticleSystem</a>* createSystem(<span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a426">String</a>&amp; name, size_t quota = 500,
9700213             <span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a426">String</a>&amp; resourceGroup = ResourceGroupManager::DEFAULT_RESOURCE_GROUP_NAME);
9800214
9900234         <a class="code" href="classOgre_1_1ParticleSystem.html">ParticleSystem</a>* createSystem(<span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a426">String</a>&amp; name, <span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a426">String</a>&amp; templateName);
10000235
10100243         <span class="keywordtype">void</span> destroySystem(<span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a426">String</a>&amp; name);
10200244
10300252         <span class="keywordtype">void</span> destroySystem(<a class="code" href="classOgre_1_1ParticleSystem.html">ParticleSystem</a>* sys);
10400253
10500255         <a class="code" href="classOgre_1_1ParticleSystem.html">ParticleSystem</a>* getSystem(<span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a426">String</a>&amp; name);
10600256
10700257
10800268         <a class="code" href="classOgre_1_1ParticleEmitter.html">ParticleEmitter</a>* _createEmitter(<span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a426">String</a>&amp; emitterType, <a class="code" href="classOgre_1_1ParticleSystem.html">ParticleSystem</a>* psys);
10900269
11000278         <span class="keywordtype">void</span> _destroyEmitter(<a class="code" href="classOgre_1_1ParticleEmitter.html">ParticleEmitter</a>* emitter);
11100279
11200290         <a class="code" href="classOgre_1_1ParticleAffector.html">ParticleAffector</a>* _createAffector(<span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a426">String</a>&amp; affectorType, <a class="code" href="classOgre_1_1ParticleSystem.html">ParticleSystem</a>* psys);
11300291
11400300         <span class="keywordtype">void</span> _destroyAffector(<a class="code" href="classOgre_1_1ParticleAffector.html">ParticleAffector</a>* affector);
11500301
11600310         <a class="code" href="classOgre_1_1ParticleSystemRenderer.html">ParticleSystemRenderer</a>* _createRenderer(<span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a426">String</a>&amp; rendererType);
11700311
11800320         <span class="keywordtype">void</span> _destroyRenderer(<a class="code" href="classOgre_1_1ParticleSystemRenderer.html">ParticleSystemRenderer</a>* renderer);
11900321
12000323         <span class="keywordtype">bool</span> frameStarted(<span class="keyword">const</span> <a class="code" href="structOgre_1_1FrameEvent.html">FrameEvent</a> &amp;evt);
12100324
12200326         <span class="keywordtype">bool</span> frameEnded(<span class="keyword">const</span> <a class="code" href="structOgre_1_1FrameEvent.html">FrameEvent</a> &amp;evt);
12300327
12400333         <span class="keywordtype">void</span> _initialise(<span class="keywordtype">void</span>);
12500334
12600336         <span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a535">StringVector</a>&amp; getScriptPatterns(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
12700338         <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#a426">String</a>&amp; groupName);
12800340         <a class="code" href="namespaceOgre.html#a420">Real</a> getLoadingOrder(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
12900341
130<a name="l00342"></a><a class="code" href="classOgre_1_1ParticleSystemManager.html#Ogre_1_1ParticleSystemManagerw4">00342</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>;
131<a name="l00343"></a><a class="code" href="classOgre_1_1ParticleSystemManager.html#Ogre_1_1ParticleSystemManagerw5">00343</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>;
132<a name="l00344"></a><a class="code" href="classOgre_1_1ParticleSystemManager.html#Ogre_1_1ParticleSystemManagerw6">00344</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>;
13300346         <a class="code" href="classOgre_1_1MapIterator.html">ParticleAffectorFactoryIterator</a> getAffectorFactoryIterator(<span class="keywordtype">void</span>);
13400348         <a class="code" href="classOgre_1_1MapIterator.html">ParticleEmitterFactoryIterator</a> getEmitterFactoryIterator(<span class="keywordtype">void</span>);
13500350         <a class="code" href="classOgre_1_1MapIterator.html">ParticleRendererFactoryIterator</a> getRendererFactoryIterator(<span class="keywordtype">void</span>);
13600351
13700352
13800357         <a class="code" href="namespaceOgre.html#a420">Real</a> getTimeFactor(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
13900358
14000367         <span class="keywordtype">void</span> setTimeFactor(<a class="code" href="namespaceOgre.html#a420">Real</a> tf);
14100368
142<a name="l00369"></a><a class="code" href="classOgre_1_1ParticleSystemManager.html#Ogre_1_1ParticleSystemManagerw7">00369</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>;
143<a name="l00371"></a><a class="code" href="classOgre_1_1ParticleSystemManager.html#Ogre_1_1ParticleSystemManagera30">00371</a>         <a class="code" href="classOgre_1_1MapIterator.html">ParticleSystemTemplateIterator</a> getTemplateIterator(<span class="keywordtype">void</span>)
14400372         {
14500373             <span class="keywordflow">return</span> <a class="code" href="classOgre_1_1MapIterator.html">ParticleSystemTemplateIterator</a>(
14600374                 mSystemTemplates.begin(), mSystemTemplates.end());
14700375         }
14800376
14900392         <span class="keyword">static</span> ParticleSystemManager&amp; getSingleton(<span class="keywordtype">void</span>);
15000408         <span class="keyword">static</span> ParticleSystemManager* getSingletonPtr(<span class="keywordtype">void</span>);
15100409
15200410     };
15300411
15400412 }
15500413
15600414 <span class="preprocessor">#endif</span>
15700415 <span class="preprocessor"></span>
158</pre></div><hr>
159<p>
160Copyright &copy; 2000-2005 by The OGRE Team<br />
161<!--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/>
162This 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/>
163                <!--/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#">
164                <Work rdf:about="">
165                        <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" />
166        <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" />
167                </Work>
168                <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> -->
169
170Last modified Sun Feb 12 12:59:49 2006
171</p>
172</body>
173</html>
Note: See TracBrowser for help on using the repository browser.