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

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

added ogre dependencies and patched ogre sources
Line 
1<html>
2<head>
3<title>Ogre::Particle 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::Particle Class Reference</h1>Class representing a single particle instance. 
11<a href="#_details">More...</a>
12<p>
13<code>#include &lt;<a class="el" href="OgreParticle_8h-source.html">OgreParticle.h</a>&gt;</code>
14<p>
15<a href="classOgre_1_1Particle-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
16<tr><td></td></tr>
17<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
18<tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Particle.html#Ogre_1_1Particlea0">Particle</a> ()</td></tr>
19
20<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Particle.html#Ogre_1_1Particlea1">setDimensions</a> (<a class="el" href="namespaceOgre.html#a420">Real</a> width, <a class="el" href="namespaceOgre.html#a420">Real</a> height)</td></tr>
21
22<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets the width and height for this particle.  <a href="#Ogre_1_1Particlea1"></a><br><br></td></tr>
23<tr><td class="memItemLeft" nowrap align=right valign=top>bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Particle.html#Ogre_1_1Particlea2">hasOwnDimensions</a> (void) const </td></tr>
24
25<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns true if this particle deviates from the ParticleSystem's default dimensions (i.e.  <a href="#Ogre_1_1Particlea2"></a><br><br></td></tr>
26<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a420">Real</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Particle.html#Ogre_1_1Particlea3">getOwnWidth</a> (void) const </td></tr>
27
28<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves the particle's personal width, if hasOwnDimensions is true.  <a href="#Ogre_1_1Particlea3"></a><br><br></td></tr>
29<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a420">Real</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Particle.html#Ogre_1_1Particlea4">getOwnHeight</a> (void) const </td></tr>
30
31<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves the particle's personal width, if hasOwnDimensions is true.  <a href="#Ogre_1_1Particlea4"></a><br><br></td></tr>
32<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Particle.html#Ogre_1_1Particlea5">setRotation</a> (const <a class="el" href="classOgre_1_1Radian.html">Radian</a> &amp;rad)</td></tr>
33
34<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets the current rotation.  <a href="#Ogre_1_1Particlea5"></a><br><br></td></tr>
35<tr><td class="memItemLeft" nowrap align=right valign=top>const <a class="el" href="classOgre_1_1Radian.html">Radian</a> &amp;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Particle.html#Ogre_1_1Particlea6">getRotation</a> (void) const </td></tr>
36
37<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Particle.html#Ogre_1_1Particlea7">_notifyOwner</a> (<a class="el" href="classOgre_1_1ParticleSystem.html">ParticleSystem</a> *owner)</td></tr>
38
39<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Internal method for notifying the particle of it's owner.  <a href="#Ogre_1_1Particlea7"></a><br><br></td></tr>
40<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Particle.html#Ogre_1_1Particlea8">_notifyVisualData</a> (<a class="el" href="classOgre_1_1ParticleVisualData.html">ParticleVisualData</a> *vis)</td></tr>
41
42<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Internal method for notifying the particle of it's optional visual data.  <a href="#Ogre_1_1Particlea8"></a><br><br></td></tr>
43<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1ParticleVisualData.html">ParticleVisualData</a> *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Particle.html#Ogre_1_1Particlea9">getVisualData</a> (void) const </td></tr>
44
45<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the optional visual data associated with the class.  <a href="#Ogre_1_1Particlea9"></a><br><br></td></tr>
46<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Particle.html#Ogre_1_1Particlea10">resetDimensions</a> (void)</td></tr>
47
48<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Utility method to reset this particle.  <a href="#Ogre_1_1Particlea10"></a><br><br></td></tr>
49<tr><td colspan=2><br><h2>Public Attributes</h2></td></tr>
50<tr><td class="memItemLeft" nowrap align=right valign=top>bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Particle.html#Ogre_1_1Particleo0">mOwnDimensions</a></td></tr>
51
52<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Does this particle have it's own dimensions?  <a href="#Ogre_1_1Particleo0"></a><br><br></td></tr>
53<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a420">Real</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Particle.html#Ogre_1_1Particleo1">mWidth</a></td></tr>
54
55<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Personal width if mOwnDimensions == true.  <a href="#Ogre_1_1Particleo1"></a><br><br></td></tr>
56<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a420">Real</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Particle.html#Ogre_1_1Particleo2">mHeight</a></td></tr>
57
58<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Personal height if mOwnDimensions == true.  <a href="#Ogre_1_1Particleo2"></a><br><br></td></tr>
59<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1Radian.html">Radian</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Particle.html#Ogre_1_1Particleo3">rotation</a></td></tr>
60
61<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Current rotation value.  <a href="#Ogre_1_1Particleo3"></a><br><br></td></tr>
62<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1Vector3.html">Vector3</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Particle.html#Ogre_1_1Particleo4">position</a></td></tr>
63
64<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">World position.  <a href="#Ogre_1_1Particleo4"></a><br><br></td></tr>
65<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1Vector3.html">Vector3</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Particle.html#Ogre_1_1Particleo5">direction</a></td></tr>
66
67<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Direction (and speed).  <a href="#Ogre_1_1Particleo5"></a><br><br></td></tr>
68<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1ColourValue.html">ColourValue</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Particle.html#Ogre_1_1Particleo6">colour</a></td></tr>
69
70<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Current colour.  <a href="#Ogre_1_1Particleo6"></a><br><br></td></tr>
71<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a420">Real</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Particle.html#Ogre_1_1Particleo7">timeToLive</a></td></tr>
72
73<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Time to live, number of seconds left of particles natural life.  <a href="#Ogre_1_1Particleo7"></a><br><br></td></tr>
74<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a420">Real</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Particle.html#Ogre_1_1Particleo8">totalTimeToLive</a></td></tr>
75
76<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Total Time to live, number of seconds of particles natural life.  <a href="#Ogre_1_1Particleo8"></a><br><br></td></tr>
77<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1Radian.html">Radian</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Particle.html#Ogre_1_1Particleo9">rotationSpeed</a></td></tr>
78
79<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Speed of rotation in radians/sec.  <a href="#Ogre_1_1Particleo9"></a><br><br></td></tr>
80<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr>
81<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1ParticleSystem.html">ParticleSystem</a> *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Particle.html#Ogre_1_1Particlep0">mParentSystem</a></td></tr>
82
83<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Parent <a class="el" href="classOgre_1_1ParticleSystem.html">ParticleSystem</a>.  <a href="#Ogre_1_1Particlep0"></a><br><br></td></tr>
84<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1ParticleVisualData.html">ParticleVisualData</a> *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Particle.html#Ogre_1_1Particlep1">mVisual</a></td></tr>
85
86<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Additional visual data you might want to associate with the <a class="el" href="classOgre_1_1Particle.html">Particle</a>.  <a href="#Ogre_1_1Particlep1"></a><br><br></td></tr>
87</table>
88<hr><a name="_details"></a><h2>Detailed Description</h2>
89Class representing a single particle instance.
90<p>
91
92<p>
93Definition at line <a class="el" href="OgreParticle_8h-source.html#l00051">51</a> of file <a class="el" href="OgreParticle_8h-source.html">OgreParticle.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
94<a class="anchor" name="Ogre_1_1Particlea0" doxytag="Ogre::Particle::Particle" ></a><p>
95<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
96  <tr>
97    <td class="mdRow">
98      <table cellpadding="0" cellspacing="0" border="0">
99        <tr>
100          <td class="md" nowrap valign="top"> Ogre::Particle::Particle </td>
101          <td class="md" valign="top">(&nbsp;</td>
102          <td class="mdname1" valign="top" nowrap>          </td>
103          <td class="md" valign="top">&nbsp;)&nbsp;</td>
104          <td class="md" nowrap></td>
105        </tr>
106
107      </table>
108    </td>
109  </tr>
110</table>
111<table cellspacing=5 cellpadding=0 border=0>
112  <tr>
113    <td>
114      &nbsp;
115    </td>
116    <td>
117
118<p>
119
120<p>
121Definition at line <a class="el" href="OgreParticle_8h-source.html#l00083">83</a> of file <a class="el" href="OgreParticle_8h-source.html">OgreParticle.h</a>.    </td>
122  </tr>
123</table>
124<hr><h2>Member Function Documentation</h2>
125<a class="anchor" name="Ogre_1_1Particlea7" doxytag="Ogre::Particle::_notifyOwner" ></a><p>
126<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
127  <tr>
128    <td class="mdRow">
129      <table cellpadding="0" cellspacing="0" border="0">
130        <tr>
131          <td class="md" nowrap valign="top"> void Ogre::Particle::_notifyOwner </td>
132          <td class="md" valign="top">(&nbsp;</td>
133          <td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1ParticleSystem.html">ParticleSystem</a> *&nbsp;</td>
134          <td class="mdname1" valign="top" nowrap> <em>owner</em>          </td>
135          <td class="md" valign="top">&nbsp;)&nbsp;</td>
136          <td class="md" nowrap></td>
137        </tr>
138
139      </table>
140    </td>
141  </tr>
142</table>
143<table cellspacing=5 cellpadding=0 border=0>
144  <tr>
145    <td>
146      &nbsp;
147    </td>
148    <td>
149
150<p>
151Internal method for notifying the particle of it's owner.
152<p>
153    </td>
154  </tr>
155</table>
156<a class="anchor" name="Ogre_1_1Particlea8" doxytag="Ogre::Particle::_notifyVisualData" ></a><p>
157<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
158  <tr>
159    <td class="mdRow">
160      <table cellpadding="0" cellspacing="0" border="0">
161        <tr>
162          <td class="md" nowrap valign="top"> void Ogre::Particle::_notifyVisualData </td>
163          <td class="md" valign="top">(&nbsp;</td>
164          <td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1ParticleVisualData.html">ParticleVisualData</a> *&nbsp;</td>
165          <td class="mdname1" valign="top" nowrap> <em>vis</em>          </td>
166          <td class="md" valign="top">&nbsp;)&nbsp;</td>
167          <td class="md" nowrap></td>
168        </tr>
169
170      </table>
171    </td>
172  </tr>
173</table>
174<table cellspacing=5 cellpadding=0 border=0>
175  <tr>
176    <td>
177      &nbsp;
178    </td>
179    <td>
180
181<p>
182Internal method for notifying the particle of it's optional visual data.
183<p>
184
185<p>
186Definition at line <a class="el" href="OgreParticle_8h-source.html#l00124">124</a> of file <a class="el" href="OgreParticle_8h-source.html">OgreParticle.h</a>.    </td>
187  </tr>
188</table>
189<a class="anchor" name="Ogre_1_1Particlea4" doxytag="Ogre::Particle::getOwnHeight" ></a><p>
190<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
191  <tr>
192    <td class="mdRow">
193      <table cellpadding="0" cellspacing="0" border="0">
194        <tr>
195          <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a420">Real</a> Ogre::Particle::getOwnHeight </td>
196          <td class="md" valign="top">(&nbsp;</td>
197          <td class="md" nowrap valign="top">void&nbsp;</td>
198          <td class="mdname1" valign="top" nowrap>          </td>
199          <td class="md" valign="top">&nbsp;)&nbsp;</td>
200          <td class="md" nowrap> const</td>
201        </tr>
202
203      </table>
204    </td>
205  </tr>
206</table>
207<table cellspacing=5 cellpadding=0 border=0>
208  <tr>
209    <td>
210      &nbsp;
211    </td>
212    <td>
213
214<p>
215Retrieves the particle's personal width, if hasOwnDimensions is true.
216<p>
217
218<p>
219Definition at line <a class="el" href="OgreParticle_8h-source.html#l00111">111</a> of file <a class="el" href="OgreParticle_8h-source.html">OgreParticle.h</a>.
220<p>
221References <a class="el" href="OgrePrerequisites_8h-source.html#l00111">Ogre::Real</a>.    </td>
222  </tr>
223</table>
224<a class="anchor" name="Ogre_1_1Particlea3" doxytag="Ogre::Particle::getOwnWidth" ></a><p>
225<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
226  <tr>
227    <td class="mdRow">
228      <table cellpadding="0" cellspacing="0" border="0">
229        <tr>
230          <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a420">Real</a> Ogre::Particle::getOwnWidth </td>
231          <td class="md" valign="top">(&nbsp;</td>
232          <td class="md" nowrap valign="top">void&nbsp;</td>
233          <td class="mdname1" valign="top" nowrap>          </td>
234          <td class="md" valign="top">&nbsp;)&nbsp;</td>
235          <td class="md" nowrap> const</td>
236        </tr>
237
238      </table>
239    </td>
240  </tr>
241</table>
242<table cellspacing=5 cellpadding=0 border=0>
243  <tr>
244    <td>
245      &nbsp;
246    </td>
247    <td>
248
249<p>
250Retrieves the particle's personal width, if hasOwnDimensions is true.
251<p>
252
253<p>
254Definition at line <a class="el" href="OgreParticle_8h-source.html#l00108">108</a> of file <a class="el" href="OgreParticle_8h-source.html">OgreParticle.h</a>.
255<p>
256References <a class="el" href="OgrePrerequisites_8h-source.html#l00111">Ogre::Real</a>.    </td>
257  </tr>
258</table>
259<a class="anchor" name="Ogre_1_1Particlea6" doxytag="Ogre::Particle::getRotation" ></a><p>
260<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
261  <tr>
262    <td class="mdRow">
263      <table cellpadding="0" cellspacing="0" border="0">
264        <tr>
265          <td class="md" nowrap valign="top"> const <a class="el" href="classOgre_1_1Radian.html">Radian</a>&amp; Ogre::Particle::getRotation </td>
266          <td class="md" valign="top">(&nbsp;</td>
267          <td class="md" nowrap valign="top">void&nbsp;</td>
268          <td class="mdname1" valign="top" nowrap>          </td>
269          <td class="md" valign="top">&nbsp;)&nbsp;</td>
270          <td class="md" nowrap> const</td>
271        </tr>
272
273      </table>
274    </td>
275  </tr>
276</table>
277<table cellspacing=5 cellpadding=0 border=0>
278  <tr>
279    <td>
280      &nbsp;
281    </td>
282    <td>
283
284<p>
285
286<p>
287Definition at line <a class="el" href="OgreParticle_8h-source.html#l00116">116</a> of file <a class="el" href="OgreParticle_8h-source.html">OgreParticle.h</a>.    </td>
288  </tr>
289</table>
290<a class="anchor" name="Ogre_1_1Particlea9" doxytag="Ogre::Particle::getVisualData" ></a><p>
291<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
292  <tr>
293    <td class="mdRow">
294      <table cellpadding="0" cellspacing="0" border="0">
295        <tr>
296          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1ParticleVisualData.html">ParticleVisualData</a>* Ogre::Particle::getVisualData </td>
297          <td class="md" valign="top">(&nbsp;</td>
298          <td class="md" nowrap valign="top">void&nbsp;</td>
299          <td class="mdname1" valign="top" nowrap>          </td>
300          <td class="md" valign="top">&nbsp;)&nbsp;</td>
301          <td class="md" nowrap> const</td>
302        </tr>
303
304      </table>
305    </td>
306  </tr>
307</table>
308<table cellspacing=5 cellpadding=0 border=0>
309  <tr>
310    <td>
311      &nbsp;
312    </td>
313    <td>
314
315<p>
316Get the optional visual data associated with the class.
317<p>
318
319<p>
320Definition at line <a class="el" href="OgreParticle_8h-source.html#l00127">127</a> of file <a class="el" href="OgreParticle_8h-source.html">OgreParticle.h</a>.    </td>
321  </tr>
322</table>
323<a class="anchor" name="Ogre_1_1Particlea2" doxytag="Ogre::Particle::hasOwnDimensions" ></a><p>
324<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
325  <tr>
326    <td class="mdRow">
327      <table cellpadding="0" cellspacing="0" border="0">
328        <tr>
329          <td class="md" nowrap valign="top"> bool Ogre::Particle::hasOwnDimensions </td>
330          <td class="md" valign="top">(&nbsp;</td>
331          <td class="md" nowrap valign="top">void&nbsp;</td>
332          <td class="mdname1" valign="top" nowrap>          </td>
333          <td class="md" valign="top">&nbsp;)&nbsp;</td>
334          <td class="md" nowrap> const</td>
335        </tr>
336
337      </table>
338    </td>
339  </tr>
340</table>
341<table cellspacing=5 cellpadding=0 border=0>
342  <tr>
343    <td>
344      &nbsp;
345    </td>
346    <td>
347
348<p>
349Returns true if this particle deviates from the ParticleSystem's default dimensions (i.e.
350<p>
351if the particle::setDimensions method has been called for this instance). <dl compact><dt><b>See also:</b></dt><dd>particle::setDimensions </dd></dl>
352
353<p>
354Definition at line <a class="el" href="OgreParticle_8h-source.html#l00105">105</a> of file <a class="el" href="OgreParticle_8h-source.html">OgreParticle.h</a>.    </td>
355  </tr>
356</table>
357<a class="anchor" name="Ogre_1_1Particlea10" doxytag="Ogre::Particle::resetDimensions" ></a><p>
358<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
359  <tr>
360    <td class="mdRow">
361      <table cellpadding="0" cellspacing="0" border="0">
362        <tr>
363          <td class="md" nowrap valign="top"> void Ogre::Particle::resetDimensions </td>
364          <td class="md" valign="top">(&nbsp;</td>
365          <td class="md" nowrap valign="top">void&nbsp;</td>
366          <td class="mdname1" valign="top" nowrap>          </td>
367          <td class="md" valign="top">&nbsp;)&nbsp;</td>
368          <td class="md" nowrap></td>
369        </tr>
370
371      </table>
372    </td>
373  </tr>
374</table>
375<table cellspacing=5 cellpadding=0 border=0>
376  <tr>
377    <td>
378      &nbsp;
379    </td>
380    <td>
381
382<p>
383Utility method to reset this particle.
384<p>
385
386<p>
387Referenced by <a class="el" href="OgreParticleEmitter_8h-source.html#l00360">Ogre::ParticleEmitter::_initParticle()</a>.    </td>
388  </tr>
389</table>
390<a class="anchor" name="Ogre_1_1Particlea1" doxytag="Ogre::Particle::setDimensions" ></a><p>
391<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
392  <tr>
393    <td class="mdRow">
394      <table cellpadding="0" cellspacing="0" border="0">
395        <tr>
396          <td class="md" nowrap valign="top"> void Ogre::Particle::setDimensions </td>
397          <td class="md" valign="top">(&nbsp;</td>
398          <td class="md" nowrap valign="top"><a class="el" href="namespaceOgre.html#a420">Real</a>&nbsp;</td>
399          <td class="mdname" nowrap> <em>width</em>, </td>
400        </tr>
401        <tr>
402          <td class="md" nowrap align="right"></td>
403          <td></td>
404          <td class="md" nowrap><a class="el" href="namespaceOgre.html#a420">Real</a>&nbsp;</td>
405          <td class="mdname" nowrap> <em>height</em></td>
406        </tr>
407        <tr>
408          <td></td>
409          <td class="md">)&nbsp;</td>
410          <td class="md" colspan="2"></td>
411        </tr>
412
413      </table>
414    </td>
415  </tr>
416</table>
417<table cellspacing=5 cellpadding=0 border=0>
418  <tr>
419    <td>
420      &nbsp;
421    </td>
422    <td>
423
424<p>
425Sets the width and height for this particle.
426<p>
427<dl compact><dt><b>Remarks:</b></dt><dd>Note that it is most efficient for every particle in a <a class="el" href="classOgre_1_1ParticleSystem.html">ParticleSystem</a> to have the same dimensions. If you choose to alter the dimensions of an individual particle the set will be less efficient. Do not call this method unless you really need to have different particle dimensions within the same set. Otherwise just call the <a class="el" href="classOgre_1_1ParticleSystem.html#Ogre_1_1ParticleSystema39">ParticleSystem::setDefaultDimensions</a> method instead. </dd></dl>
428    </td>
429  </tr>
430</table>
431<a class="anchor" name="Ogre_1_1Particlea5" doxytag="Ogre::Particle::setRotation" ></a><p>
432<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
433  <tr>
434    <td class="mdRow">
435      <table cellpadding="0" cellspacing="0" border="0">
436        <tr>
437          <td class="md" nowrap valign="top"> void Ogre::Particle::setRotation </td>
438          <td class="md" valign="top">(&nbsp;</td>
439          <td class="md" nowrap valign="top">const <a class="el" href="classOgre_1_1Radian.html">Radian</a> &amp;&nbsp;</td>
440          <td class="mdname1" valign="top" nowrap> <em>rad</em>          </td>
441          <td class="md" valign="top">&nbsp;)&nbsp;</td>
442          <td class="md" nowrap></td>
443        </tr>
444
445      </table>
446    </td>
447  </tr>
448</table>
449<table cellspacing=5 cellpadding=0 border=0>
450  <tr>
451    <td>
452      &nbsp;
453    </td>
454    <td>
455
456<p>
457Sets the current rotation.
458<p>
459    </td>
460  </tr>
461</table>
462<hr><h2>Member Data Documentation</h2>
463<a class="anchor" name="Ogre_1_1Particleo6" doxytag="Ogre::Particle::colour" ></a><p>
464<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
465  <tr>
466    <td class="mdRow">
467      <table cellpadding="0" cellspacing="0" border="0">
468        <tr>
469          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1ColourValue.html">ColourValue</a> <a class="el" href="classOgre_1_1Particle.html#Ogre_1_1Particleo6">Ogre::Particle::colour</a>
470      </table>
471    </td>
472  </tr>
473</table>
474<table cellspacing=5 cellpadding=0 border=0>
475  <tr>
476    <td>
477      &nbsp;
478    </td>
479    <td>
480
481<p>
482Current colour.
483<p>
484
485<p>
486Definition at line <a class="el" href="OgreParticle_8h-source.html#l00074">74</a> of file <a class="el" href="OgreParticle_8h-source.html">OgreParticle.h</a>.    </td>
487  </tr>
488</table>
489<a class="anchor" name="Ogre_1_1Particleo5" doxytag="Ogre::Particle::direction" ></a><p>
490<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
491  <tr>
492    <td class="mdRow">
493      <table cellpadding="0" cellspacing="0" border="0">
494        <tr>
495          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1Vector3.html">Vector3</a> <a class="el" href="classOgre_1_1Particle.html#Ogre_1_1Particleo5">Ogre::Particle::direction</a>
496      </table>
497    </td>
498  </tr>
499</table>
500<table cellspacing=5 cellpadding=0 border=0>
501  <tr>
502    <td>
503      &nbsp;
504    </td>
505    <td>
506
507<p>
508Direction (and speed).
509<p>
510
511<p>
512Definition at line <a class="el" href="OgreParticle_8h-source.html#l00072">72</a> of file <a class="el" href="OgreParticle_8h-source.html">OgreParticle.h</a>.    </td>
513  </tr>
514</table>
515<a class="anchor" name="Ogre_1_1Particleo2" doxytag="Ogre::Particle::mHeight" ></a><p>
516<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
517  <tr>
518    <td class="mdRow">
519      <table cellpadding="0" cellspacing="0" border="0">
520        <tr>
521          <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a420">Real</a> <a class="el" href="classOgre_1_1Particle.html#Ogre_1_1Particleo2">Ogre::Particle::mHeight</a>
522      </table>
523    </td>
524  </tr>
525</table>
526<table cellspacing=5 cellpadding=0 border=0>
527  <tr>
528    <td>
529      &nbsp;
530    </td>
531    <td>
532
533<p>
534Personal height if mOwnDimensions == true.
535<p>
536
537<p>
538Definition at line <a class="el" href="OgreParticle_8h-source.html#l00064">64</a> of file <a class="el" href="OgreParticle_8h-source.html">OgreParticle.h</a>.    </td>
539  </tr>
540</table>
541<a class="anchor" name="Ogre_1_1Particleo0" doxytag="Ogre::Particle::mOwnDimensions" ></a><p>
542<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
543  <tr>
544    <td class="mdRow">
545      <table cellpadding="0" cellspacing="0" border="0">
546        <tr>
547          <td class="md" nowrap valign="top"> bool <a class="el" href="classOgre_1_1Particle.html#Ogre_1_1Particleo0">Ogre::Particle::mOwnDimensions</a>
548      </table>
549    </td>
550  </tr>
551</table>
552<table cellspacing=5 cellpadding=0 border=0>
553  <tr>
554    <td>
555      &nbsp;
556    </td>
557    <td>
558
559<p>
560Does this particle have it's own dimensions?
561<p>
562
563<p>
564Definition at line <a class="el" href="OgreParticle_8h-source.html#l00060">60</a> of file <a class="el" href="OgreParticle_8h-source.html">OgreParticle.h</a>.    </td>
565  </tr>
566</table>
567<a class="anchor" name="Ogre_1_1Particlep0" doxytag="Ogre::Particle::mParentSystem" ></a><p>
568<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
569  <tr>
570    <td class="mdRow">
571      <table cellpadding="0" cellspacing="0" border="0">
572        <tr>
573          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1ParticleSystem.html">ParticleSystem</a>* <a class="el" href="classOgre_1_1Particle.html#Ogre_1_1Particlep0">Ogre::Particle::mParentSystem</a><code> [protected]</code>
574      </table>
575    </td>
576  </tr>
577</table>
578<table cellspacing=5 cellpadding=0 border=0>
579  <tr>
580    <td>
581      &nbsp;
582    </td>
583    <td>
584
585<p>
586Parent <a class="el" href="classOgre_1_1ParticleSystem.html">ParticleSystem</a>.
587<p>
588
589<p>
590Definition at line <a class="el" href="OgreParticle_8h-source.html#l00055">55</a> of file <a class="el" href="OgreParticle_8h-source.html">OgreParticle.h</a>.    </td>
591  </tr>
592</table>
593<a class="anchor" name="Ogre_1_1Particlep1" doxytag="Ogre::Particle::mVisual" ></a><p>
594<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
595  <tr>
596    <td class="mdRow">
597      <table cellpadding="0" cellspacing="0" border="0">
598        <tr>
599          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1ParticleVisualData.html">ParticleVisualData</a>* <a class="el" href="classOgre_1_1Particle.html#Ogre_1_1Particlep1">Ogre::Particle::mVisual</a><code> [protected]</code>
600      </table>
601    </td>
602  </tr>
603</table>
604<table cellspacing=5 cellpadding=0 border=0>
605  <tr>
606    <td>
607      &nbsp;
608    </td>
609    <td>
610
611<p>
612Additional visual data you might want to associate with the <a class="el" href="classOgre_1_1Particle.html">Particle</a>.
613<p>
614
615<p>
616Definition at line <a class="el" href="OgreParticle_8h-source.html#l00057">57</a> of file <a class="el" href="OgreParticle_8h-source.html">OgreParticle.h</a>.    </td>
617  </tr>
618</table>
619<a class="anchor" name="Ogre_1_1Particleo1" doxytag="Ogre::Particle::mWidth" ></a><p>
620<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
621  <tr>
622    <td class="mdRow">
623      <table cellpadding="0" cellspacing="0" border="0">
624        <tr>
625          <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a420">Real</a> <a class="el" href="classOgre_1_1Particle.html#Ogre_1_1Particleo1">Ogre::Particle::mWidth</a>
626      </table>
627    </td>
628  </tr>
629</table>
630<table cellspacing=5 cellpadding=0 border=0>
631  <tr>
632    <td>
633      &nbsp;
634    </td>
635    <td>
636
637<p>
638Personal width if mOwnDimensions == true.
639<p>
640
641<p>
642Definition at line <a class="el" href="OgreParticle_8h-source.html#l00062">62</a> of file <a class="el" href="OgreParticle_8h-source.html">OgreParticle.h</a>.    </td>
643  </tr>
644</table>
645<a class="anchor" name="Ogre_1_1Particleo4" doxytag="Ogre::Particle::position" ></a><p>
646<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
647  <tr>
648    <td class="mdRow">
649      <table cellpadding="0" cellspacing="0" border="0">
650        <tr>
651          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1Vector3.html">Vector3</a> <a class="el" href="classOgre_1_1Particle.html#Ogre_1_1Particleo4">Ogre::Particle::position</a>
652      </table>
653    </td>
654  </tr>
655</table>
656<table cellspacing=5 cellpadding=0 border=0>
657  <tr>
658    <td>
659      &nbsp;
660    </td>
661    <td>
662
663<p>
664World position.
665<p>
666
667<p>
668Definition at line <a class="el" href="OgreParticle_8h-source.html#l00070">70</a> of file <a class="el" href="OgreParticle_8h-source.html">OgreParticle.h</a>.    </td>
669  </tr>
670</table>
671<a class="anchor" name="Ogre_1_1Particleo3" doxytag="Ogre::Particle::rotation" ></a><p>
672<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
673  <tr>
674    <td class="mdRow">
675      <table cellpadding="0" cellspacing="0" border="0">
676        <tr>
677          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1Radian.html">Radian</a> <a class="el" href="classOgre_1_1Particle.html#Ogre_1_1Particleo3">Ogre::Particle::rotation</a>
678      </table>
679    </td>
680  </tr>
681</table>
682<table cellspacing=5 cellpadding=0 border=0>
683  <tr>
684    <td>
685      &nbsp;
686    </td>
687    <td>
688
689<p>
690Current rotation value.
691<p>
692
693<p>
694Definition at line <a class="el" href="OgreParticle_8h-source.html#l00066">66</a> of file <a class="el" href="OgreParticle_8h-source.html">OgreParticle.h</a>.    </td>
695  </tr>
696</table>
697<a class="anchor" name="Ogre_1_1Particleo9" doxytag="Ogre::Particle::rotationSpeed" ></a><p>
698<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
699  <tr>
700    <td class="mdRow">
701      <table cellpadding="0" cellspacing="0" border="0">
702        <tr>
703          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1Radian.html">Radian</a> <a class="el" href="classOgre_1_1Particle.html#Ogre_1_1Particleo9">Ogre::Particle::rotationSpeed</a>
704      </table>
705    </td>
706  </tr>
707</table>
708<table cellspacing=5 cellpadding=0 border=0>
709  <tr>
710    <td>
711      &nbsp;
712    </td>
713    <td>
714
715<p>
716Speed of rotation in radians/sec.
717<p>
718
719<p>
720Definition at line <a class="el" href="OgreParticle_8h-source.html#l00080">80</a> of file <a class="el" href="OgreParticle_8h-source.html">OgreParticle.h</a>.    </td>
721  </tr>
722</table>
723<a class="anchor" name="Ogre_1_1Particleo7" doxytag="Ogre::Particle::timeToLive" ></a><p>
724<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
725  <tr>
726    <td class="mdRow">
727      <table cellpadding="0" cellspacing="0" border="0">
728        <tr>
729          <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a420">Real</a> <a class="el" href="classOgre_1_1Particle.html#Ogre_1_1Particleo7">Ogre::Particle::timeToLive</a>
730      </table>
731    </td>
732  </tr>
733</table>
734<table cellspacing=5 cellpadding=0 border=0>
735  <tr>
736    <td>
737      &nbsp;
738    </td>
739    <td>
740
741<p>
742Time to live, number of seconds left of particles natural life.
743<p>
744
745<p>
746Definition at line <a class="el" href="OgreParticle_8h-source.html#l00076">76</a> of file <a class="el" href="OgreParticle_8h-source.html">OgreParticle.h</a>.    </td>
747  </tr>
748</table>
749<a class="anchor" name="Ogre_1_1Particleo8" doxytag="Ogre::Particle::totalTimeToLive" ></a><p>
750<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
751  <tr>
752    <td class="mdRow">
753      <table cellpadding="0" cellspacing="0" border="0">
754        <tr>
755          <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a420">Real</a> <a class="el" href="classOgre_1_1Particle.html#Ogre_1_1Particleo8">Ogre::Particle::totalTimeToLive</a>
756      </table>
757    </td>
758  </tr>
759</table>
760<table cellspacing=5 cellpadding=0 border=0>
761  <tr>
762    <td>
763      &nbsp;
764    </td>
765    <td>
766
767<p>
768Total Time to live, number of seconds of particles natural life.
769<p>
770
771<p>
772Definition at line <a class="el" href="OgreParticle_8h-source.html#l00078">78</a> of file <a class="el" href="OgreParticle_8h-source.html">OgreParticle.h</a>.    </td>
773  </tr>
774</table>
775<hr>The documentation for this class was generated from the following file:<ul>
776<li><a class="el" href="OgreParticle_8h-source.html">OgreParticle.h</a></ul>
777<hr>
778<p>
779Copyright &copy; 2000-2005 by The OGRE Team<br />
780<!--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/>
781This 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/>
782                <!--/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#">
783                <Work rdf:about="">
784                        <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" />
785        <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" />
786                </Work>
787                <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> -->
788
789Last modified Sun Feb 12 13:01:43 2006
790</p>
791</body>
792</html>
Note: See TracBrowser for help on using the repository browser.