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

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

added ogre dependencies and patched ogre sources
Line 
1<html>
2<head>
3<title>Ogre::BoxEmitterFactory 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::BoxEmitterFactory Class Reference</h1>Factory class for particle emitter of type "Box". 
11<a href="#_details">More...</a>
12<p>
13<code>#include &lt;<a class="el" href="OgreBoxEmitterFactory_8h-source.html">OgreBoxEmitterFactory.h</a>&gt;</code>
14<p>
15<p>Inheritance diagram for Ogre::BoxEmitterFactory:
16<p><center><img src="classOgre_1_1BoxEmitterFactory.png" usemap="#Ogre::BoxEmitterFactory_map" border="0" alt=""></center>
17<map name="Ogre::BoxEmitterFactory_map">
18<area href="classOgre_1_1ParticleEmitterFactory.html" alt="Ogre::ParticleEmitterFactory" shape="rect" coords="0,0,172,24">
19</map>
20<a href="classOgre_1_1BoxEmitterFactory-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
21<tr><td></td></tr>
22<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
23<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a426">String</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1BoxEmitterFactory.html#Ogre_1_1BoxEmitterFactorya0">getName</a> () const </td></tr>
24
25<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">See <a class="el" href="classOgre_1_1ParticleEmitterFactory.html">ParticleEmitterFactory</a>.  <a href="#Ogre_1_1BoxEmitterFactorya0"></a><br><br></td></tr>
26<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1ParticleEmitter.html">ParticleEmitter</a> *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1BoxEmitterFactory.html#Ogre_1_1BoxEmitterFactorya1">createEmitter</a> (<a class="el" href="classOgre_1_1ParticleSystem.html">ParticleSystem</a> *psys)</td></tr>
27
28<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">See <a class="el" href="classOgre_1_1ParticleEmitterFactory.html">ParticleEmitterFactory</a>.  <a href="#Ogre_1_1BoxEmitterFactorya1"></a><br><br></td></tr>
29<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>
30
31<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>
32<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr>
33<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>
34
35</table>
36<hr><a name="_details"></a><h2>Detailed Description</h2>
37Factory class for particle emitter of type "Box".
38<p>
39<dl compact><dt><b>Remarks:</b></dt><dd>Creates instances of <a class="el" href="classOgre_1_1BoxEmitter.html">BoxEmitter</a> to be used in particle systems. </dd></dl>
40
41<p>
42
43<p>
44Definition at line <a class="el" href="OgreBoxEmitterFactory_8h-source.html#l00039">39</a> of file <a class="el" href="OgreBoxEmitterFactory_8h-source.html">OgreBoxEmitterFactory.h</a>.<hr><h2>Member Function Documentation</h2>
45<a class="anchor" name="Ogre_1_1BoxEmitterFactorya1" doxytag="Ogre::BoxEmitterFactory::createEmitter" ></a><p>
46<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
47  <tr>
48    <td class="mdRow">
49      <table cellpadding="0" cellspacing="0" border="0">
50        <tr>
51          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1ParticleEmitter.html">ParticleEmitter</a>* Ogre::BoxEmitterFactory::createEmitter </td>
52          <td class="md" valign="top">(&nbsp;</td>
53          <td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1ParticleSystem.html">ParticleSystem</a> *&nbsp;</td>
54          <td class="mdname1" valign="top" nowrap> <em>psys</em>          </td>
55          <td class="md" valign="top">&nbsp;)&nbsp;</td>
56          <td class="md" nowrap><code> [virtual]</code></td>
57        </tr>
58
59      </table>
60    </td>
61  </tr>
62</table>
63<table cellspacing=5 cellpadding=0 border=0>
64  <tr>
65    <td>
66      &nbsp;
67    </td>
68    <td>
69
70<p>
71See <a class="el" href="classOgre_1_1ParticleEmitterFactory.html">ParticleEmitterFactory</a>.
72<p>
73
74<p>
75Implements <a class="el" href="classOgre_1_1ParticleEmitterFactory.html#Ogre_1_1ParticleEmitterFactorya3">Ogre::ParticleEmitterFactory</a>.
76<p>
77Definition at line <a class="el" href="OgreBoxEmitterFactory_8h-source.html#l00051">51</a> of file <a class="el" href="OgreBoxEmitterFactory_8h-source.html">OgreBoxEmitterFactory.h</a>.    </td>
78  </tr>
79</table>
80<a class="anchor" name="Ogre_1_1RingEmitterFactorya2" doxytag="Ogre::BoxEmitterFactory::destroyEmitter" ></a><p>
81<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
82  <tr>
83    <td class="mdRow">
84      <table cellpadding="0" cellspacing="0" border="0">
85        <tr>
86          <td class="md" nowrap valign="top"> virtual void Ogre::ParticleEmitterFactory::destroyEmitter </td>
87          <td class="md" valign="top">(&nbsp;</td>
88          <td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1ParticleEmitter.html">ParticleEmitter</a> *&nbsp;</td>
89          <td class="mdname1" valign="top" nowrap> <em>e</em>          </td>
90          <td class="md" valign="top">&nbsp;)&nbsp;</td>
91          <td class="md" nowrap><code> [virtual, inherited]</code></td>
92        </tr>
93
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>
106Destroys the emitter pointed to by the parameter (for early clean up if reauired).
107<p>
108    </td>
109  </tr>
110</table>
111<a class="anchor" name="Ogre_1_1BoxEmitterFactorya0" doxytag="Ogre::BoxEmitterFactory::getName" ></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"> <a class="el" href="namespaceOgre.html#a426">String</a> Ogre::BoxEmitterFactory::getName </td>
118          <td class="md" valign="top">(&nbsp;</td>
119          <td class="md" nowrap valign="top">void&nbsp;</td>
120          <td class="mdname1" valign="top" nowrap>          </td>
121          <td class="md" valign="top">&nbsp;)&nbsp;</td>
122          <td class="md" nowrap> const<code> [virtual]</code></td>
123        </tr>
124
125      </table>
126    </td>
127  </tr>
128</table>
129<table cellspacing=5 cellpadding=0 border=0>
130  <tr>
131    <td>
132      &nbsp;
133    </td>
134    <td>
135
136<p>
137See <a class="el" href="classOgre_1_1ParticleEmitterFactory.html">ParticleEmitterFactory</a>.
138<p>
139
140<p>
141Implements <a class="el" href="classOgre_1_1ParticleEmitterFactory.html#Ogre_1_1ParticleEmitterFactorya2">Ogre::ParticleEmitterFactory</a>.
142<p>
143Definition at line <a class="el" href="OgreBoxEmitterFactory_8h-source.html#l00045">45</a> of file <a class="el" href="OgreBoxEmitterFactory_8h-source.html">OgreBoxEmitterFactory.h</a>.
144<p>
145References <a class="el" href="OgrePrerequisites_8h-source.html#l00154">Ogre::String</a>.    </td>
146  </tr>
147</table>
148<hr><h2>Member Data Documentation</h2>
149<a class="anchor" name="Ogre_1_1RingEmitterFactoryp0" doxytag="Ogre::BoxEmitterFactory::mEmitters" ></a><p>
150<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
151  <tr>
152    <td class="mdRow">
153      <table cellpadding="0" cellspacing="0" border="0">
154        <tr>
155          <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, inherited]</code>
156      </table>
157    </td>
158  </tr>
159</table>
160<table cellspacing=5 cellpadding=0 border=0>
161  <tr>
162    <td>
163      &nbsp;
164    </td>
165    <td>
166
167<p>
168
169<p>
170Definition 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>
171  </tr>
172</table>
173<hr>The documentation for this class was generated from the following file:<ul>
174<li><a class="el" href="OgreBoxEmitterFactory_8h-source.html">OgreBoxEmitterFactory.h</a></ul>
175<hr>
176<p>
177Copyright &copy; 2000-2005 by The OGRE Team<br />
178<!--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/>
179This 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/>
180                <!--/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#">
181                <Work rdf:about="">
182                        <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" />
183        <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" />
184                </Work>
185                <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> -->
186
187Last modified Sun Feb 12 13:07:07 2006
188</p>
189</body>
190</html>
Note: See TracBrowser for help on using the repository browser.