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

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

added ogre dependencies and patched ogre sources
Line 
1<html>
2<head>
3<title>Ogre::ParticleEmitterFactory 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::ParticleEmitterFactory Class Reference</h1>Abstract class defining the interface to be implemented by creators of <a class="el" href="classOgre_1_1ParticleEmitter.html">ParticleEmitter</a> subclasses. 
11<a href="#_details">More...</a>
12<p>
13<code>#include &lt;<a class="el" href="OgreParticleEmitterFactory_8h-source.html">OgreParticleEmitterFactory.h</a>&gt;</code>
14<p>
15<p>Inheritance diagram for Ogre::ParticleEmitterFactory:
16<p><center><img src="classOgre_1_1ParticleEmitterFactory.png" usemap="#Ogre::ParticleEmitterFactory_map" border="0" alt=""></center>
17<map name="Ogre::ParticleEmitterFactory_map">
18<area href="classOgre_1_1BoxEmitterFactory.html" alt="Ogre::BoxEmitterFactory" shape="rect" coords="0,56,214,80">
19<area href="classOgre_1_1CylinderEmitterFactory.html" alt="Ogre::CylinderEmitterFactory" shape="rect" coords="224,56,438,80">
20<area href="classOgre_1_1EllipsoidEmitterFactory.html" alt="Ogre::EllipsoidEmitterFactory" shape="rect" coords="448,56,662,80">
21<area href="classOgre_1_1HollowEllipsoidEmitterFactory.html" alt="Ogre::HollowEllipsoidEmitterFactory" shape="rect" coords="672,56,886,80">
22<area href="classOgre_1_1PointEmitterFactory.html" alt="Ogre::PointEmitterFactory" shape="rect" coords="896,56,1110,80">
23<area href="classOgre_1_1RingEmitterFactory.html" alt="Ogre::RingEmitterFactory" shape="rect" coords="1120,56,1334,80">
24</map>
25<a href="classOgre_1_1ParticleEmitterFactory-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
26<tr><td></td></tr>
27<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
28<tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ParticleEmitterFactory.html#Ogre_1_1ParticleEmitterFactorya0">ParticleEmitterFactory</a> ()</td></tr>
29
30<tr><td class="memItemLeft" nowrap align=right valign=top>virtual&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ParticleEmitterFactory.html#Ogre_1_1ParticleEmitterFactorya1">~ParticleEmitterFactory</a> ()</td></tr>
31
32<tr><td class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="namespaceOgre.html#a426">String</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ParticleEmitterFactory.html#Ogre_1_1ParticleEmitterFactorya2">getName</a> () const=0</td></tr>
33
34<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the name of the factory, the name which identifies the particle emitter type this factory creates.  <a href="#Ogre_1_1ParticleEmitterFactorya2"></a><br><br></td></tr>
35<tr><td class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="classOgre_1_1ParticleEmitter.html">ParticleEmitter</a> *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ParticleEmitterFactory.html#Ogre_1_1ParticleEmitterFactorya3">createEmitter</a> (<a class="el" href="classOgre_1_1ParticleSystem.html">ParticleSystem</a> *psys)=0</td></tr>
36
37<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Creates a new emitter instance.  <a href="#Ogre_1_1ParticleEmitterFactorya3"></a><br><br></td></tr>
38<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ParticleEmitterFactory.html#Ogre_1_1RingEmitterFactorya2">destroyEmitter</a> (<a class="el" href="classOgre_1_1ParticleEmitter.html">ParticleEmitter</a> *e)</td></tr>
39
40<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destroys the emitter pointed to by the parameter (for early clean up if reauired).  <a href="#Ogre_1_1RingEmitterFactorya2"></a><br><br></td></tr>
41<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr>
42<tr><td class="memItemLeft" nowrap align=right valign=top>std::vector&lt; <a class="el" href="classOgre_1_1ParticleEmitter.html">ParticleEmitter</a> * &gt;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ParticleEmitterFactory.html#Ogre_1_1RingEmitterFactoryp0">mEmitters</a></td></tr>
43
44</table>
45<hr><a name="_details"></a><h2>Detailed Description</h2>
46Abstract class defining the interface to be implemented by creators of <a class="el" href="classOgre_1_1ParticleEmitter.html">ParticleEmitter</a> subclasses.
47<p>
48<dl compact><dt><b>Remarks:</b></dt><dd>Plugins or 3rd party applications can add new types of particle emitters to <a class="el" href="namespaceOgre.html">Ogre</a> by creating subclasses of the <a class="el" href="classOgre_1_1ParticleEmitter.html">ParticleEmitter</a> class. Because multiple instances of these emitters may be required, a factory class to manage the instances is also required. </dd></dl>
49<dl compact><dt><b></b></dt><dd><a class="el" href="classOgre_1_1ParticleEmitterFactory.html">ParticleEmitterFactory</a> subclasses must allow the creation and destruction of <a class="el" href="classOgre_1_1ParticleEmitter.html">ParticleEmitter</a> subclasses. They must also be registered with the <a class="el" href="classOgre_1_1ParticleSystemManager.html">ParticleSystemManager</a>. All factories have a name which identifies them, examples might be 'point', 'cone', or 'box', and these can be also be used from particle system scripts. </dd></dl>
50
51<p>
52
53<p>
54Definition at line <a class="el" href="OgreParticleEmitterFactory_8h-source.html#l00046">46</a> of file <a class="el" href="OgreParticleEmitterFactory_8h-source.html">OgreParticleEmitterFactory.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
55<a class="anchor" name="Ogre_1_1ParticleEmitterFactorya0" doxytag="Ogre::ParticleEmitterFactory::ParticleEmitterFactory" ></a><p>
56<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
57  <tr>
58    <td class="mdRow">
59      <table cellpadding="0" cellspacing="0" border="0">
60        <tr>
61          <td class="md" nowrap valign="top"> Ogre::ParticleEmitterFactory::ParticleEmitterFactory </td>
62          <td class="md" valign="top">(&nbsp;</td>
63          <td class="mdname1" valign="top" nowrap>          </td>
64          <td class="md" valign="top">&nbsp;)&nbsp;</td>
65          <td class="md" nowrap></td>
66        </tr>
67
68      </table>
69    </td>
70  </tr>
71</table>
72<table cellspacing=5 cellpadding=0 border=0>
73  <tr>
74    <td>
75      &nbsp;
76    </td>
77    <td>
78
79<p>
80
81<p>
82Definition at line <a class="el" href="OgreParticleEmitterFactory_8h-source.html#l00051">51</a> of file <a class="el" href="OgreParticleEmitterFactory_8h-source.html">OgreParticleEmitterFactory.h</a>.    </td>
83  </tr>
84</table>
85<a class="anchor" name="Ogre_1_1ParticleEmitterFactorya1" doxytag="Ogre::ParticleEmitterFactory::~ParticleEmitterFactory" ></a><p>
86<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
87  <tr>
88    <td class="mdRow">
89      <table cellpadding="0" cellspacing="0" border="0">
90        <tr>
91          <td class="md" nowrap valign="top"> virtual Ogre::ParticleEmitterFactory::~<a class="el" href="classOgre_1_1ParticleEmitterFactory.html">ParticleEmitterFactory</a> </td>
92          <td class="md" valign="top">(&nbsp;</td>
93          <td class="mdname1" valign="top" nowrap>          </td>
94          <td class="md" valign="top">&nbsp;)&nbsp;</td>
95          <td class="md" nowrap><code> [virtual]</code></td>
96        </tr>
97
98      </table>
99    </td>
100  </tr>
101</table>
102<table cellspacing=5 cellpadding=0 border=0>
103  <tr>
104    <td>
105      &nbsp;
106    </td>
107    <td>
108
109<p>
110    </td>
111  </tr>
112</table>
113<hr><h2>Member Function Documentation</h2>
114<a class="anchor" name="Ogre_1_1ParticleEmitterFactorya3" doxytag="Ogre::ParticleEmitterFactory::createEmitter" ></a><p>
115<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
116  <tr>
117    <td class="mdRow">
118      <table cellpadding="0" cellspacing="0" border="0">
119        <tr>
120          <td class="md" nowrap valign="top"> virtual <a class="el" href="classOgre_1_1ParticleEmitter.html">ParticleEmitter</a>* Ogre::ParticleEmitterFactory::createEmitter </td>
121          <td class="md" valign="top">(&nbsp;</td>
122          <td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1ParticleSystem.html">ParticleSystem</a> *&nbsp;</td>
123          <td class="mdname1" valign="top" nowrap> <em>psys</em>          </td>
124          <td class="md" valign="top">&nbsp;)&nbsp;</td>
125          <td class="md" nowrap><code> [pure virtual]</code></td>
126        </tr>
127
128      </table>
129    </td>
130  </tr>
131</table>
132<table cellspacing=5 cellpadding=0 border=0>
133  <tr>
134    <td>
135      &nbsp;
136    </td>
137    <td>
138
139<p>
140Creates a new emitter instance.
141<p>
142<dl compact><dt><b>Remarks:</b></dt><dd>The subclass MUST add a pointer to the created instance to mEmitters. </dd></dl>
143
144<p>
145Implemented in <a class="el" href="classOgre_1_1BoxEmitterFactory.html#Ogre_1_1BoxEmitterFactorya1">Ogre::BoxEmitterFactory</a>, <a class="el" href="classOgre_1_1CylinderEmitterFactory.html#Ogre_1_1CylinderEmitterFactorya1">Ogre::CylinderEmitterFactory</a>, <a class="el" href="classOgre_1_1EllipsoidEmitterFactory.html#Ogre_1_1EllipsoidEmitterFactorya1">Ogre::EllipsoidEmitterFactory</a>, <a class="el" href="classOgre_1_1HollowEllipsoidEmitterFactory.html#Ogre_1_1HollowEllipsoidEmitterFactorya1">Ogre::HollowEllipsoidEmitterFactory</a>, <a class="el" href="classOgre_1_1PointEmitterFactory.html#Ogre_1_1PointEmitterFactorya1">Ogre::PointEmitterFactory</a>, and <a class="el" href="classOgre_1_1RingEmitterFactory.html#Ogre_1_1RingEmitterFactorya1">Ogre::RingEmitterFactory</a>.    </td>
146  </tr>
147</table>
148<a class="anchor" name="Ogre_1_1RingEmitterFactorya2" doxytag="Ogre::ParticleEmitterFactory::destroyEmitter" ></a><p>
149<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
150  <tr>
151    <td class="mdRow">
152      <table cellpadding="0" cellspacing="0" border="0">
153        <tr>
154          <td class="md" nowrap valign="top"> virtual void Ogre::ParticleEmitterFactory::destroyEmitter </td>
155          <td class="md" valign="top">(&nbsp;</td>
156          <td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1ParticleEmitter.html">ParticleEmitter</a> *&nbsp;</td>
157          <td class="mdname1" valign="top" nowrap> <em>e</em>          </td>
158          <td class="md" valign="top">&nbsp;)&nbsp;</td>
159          <td class="md" nowrap><code> [virtual]</code></td>
160        </tr>
161
162      </table>
163    </td>
164  </tr>
165</table>
166<table cellspacing=5 cellpadding=0 border=0>
167  <tr>
168    <td>
169      &nbsp;
170    </td>
171    <td>
172
173<p>
174Destroys the emitter pointed to by the parameter (for early clean up if reauired).
175<p>
176    </td>
177  </tr>
178</table>
179<a class="anchor" name="Ogre_1_1ParticleEmitterFactorya2" doxytag="Ogre::ParticleEmitterFactory::getName" ></a><p>
180<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
181  <tr>
182    <td class="mdRow">
183      <table cellpadding="0" cellspacing="0" border="0">
184        <tr>
185          <td class="md" nowrap valign="top"> virtual <a class="el" href="namespaceOgre.html#a426">String</a> Ogre::ParticleEmitterFactory::getName </td>
186          <td class="md" valign="top">(&nbsp;</td>
187          <td class="mdname1" valign="top" nowrap>          </td>
188          <td class="md" valign="top">&nbsp;)&nbsp;</td>
189          <td class="md" nowrap> const<code> [pure virtual]</code></td>
190        </tr>
191
192      </table>
193    </td>
194  </tr>
195</table>
196<table cellspacing=5 cellpadding=0 border=0>
197  <tr>
198    <td>
199      &nbsp;
200    </td>
201    <td>
202
203<p>
204Returns the name of the factory, the name which identifies the particle emitter type this factory creates.
205<p>
206
207<p>
208Implemented in <a class="el" href="classOgre_1_1BoxEmitterFactory.html#Ogre_1_1BoxEmitterFactorya0">Ogre::BoxEmitterFactory</a>, <a class="el" href="classOgre_1_1CylinderEmitterFactory.html#Ogre_1_1CylinderEmitterFactorya0">Ogre::CylinderEmitterFactory</a>, <a class="el" href="classOgre_1_1EllipsoidEmitterFactory.html#Ogre_1_1EllipsoidEmitterFactorya0">Ogre::EllipsoidEmitterFactory</a>, <a class="el" href="classOgre_1_1HollowEllipsoidEmitterFactory.html#Ogre_1_1HollowEllipsoidEmitterFactorya0">Ogre::HollowEllipsoidEmitterFactory</a>, <a class="el" href="classOgre_1_1PointEmitterFactory.html#Ogre_1_1PointEmitterFactorya0">Ogre::PointEmitterFactory</a>, and <a class="el" href="classOgre_1_1RingEmitterFactory.html#Ogre_1_1RingEmitterFactorya0">Ogre::RingEmitterFactory</a>.    </td>
209  </tr>
210</table>
211<hr><h2>Member Data Documentation</h2>
212<a class="anchor" name="Ogre_1_1RingEmitterFactoryp0" doxytag="Ogre::ParticleEmitterFactory::mEmitters" ></a><p>
213<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
214  <tr>
215    <td class="mdRow">
216      <table cellpadding="0" cellspacing="0" border="0">
217        <tr>
218          <td class="md" nowrap valign="top"> std::vector&lt;<a class="el" href="classOgre_1_1ParticleEmitter.html">ParticleEmitter</a>*&gt; <a class="el" href="classOgre_1_1ParticleEmitterFactory.html#Ogre_1_1RingEmitterFactoryp0">Ogre::ParticleEmitterFactory::mEmitters</a><code> [protected]</code>
219      </table>
220    </td>
221  </tr>
222</table>
223<table cellspacing=5 cellpadding=0 border=0>
224  <tr>
225    <td>
226      &nbsp;
227    </td>
228    <td>
229
230<p>
231
232<p>
233Definition at line <a class="el" href="OgreParticleEmitterFactory_8h-source.html#l00049">49</a> of file <a class="el" href="OgreParticleEmitterFactory_8h-source.html">OgreParticleEmitterFactory.h</a>.    </td>
234  </tr>
235</table>
236<hr>The documentation for this class was generated from the following file:<ul>
237<li><a class="el" href="OgreParticleEmitterFactory_8h-source.html">OgreParticleEmitterFactory.h</a></ul>
238<hr>
239<p>
240Copyright &copy; 2000-2005 by The OGRE Team<br />
241<!--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/>
242This 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/>
243                <!--/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#">
244                <Work rdf:about="">
245                        <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" />
246        <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" />
247                </Work>
248                <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> -->
249
250Last modified Sun Feb 12 13:01:48 2006
251</p>
252</body>
253</html>
Note: See TracBrowser for help on using the repository browser.