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

Revision 657, 12.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::ParticleIterator 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::ParticleIterator Class Reference</h1>Convenience class to make it easy to step through all particles in a <a class="el" href="classOgre_1_1ParticleSystem.html">ParticleSystem</a>. 
11<a href="#_details">More...</a>
12<p>
13<code>#include &lt;<a class="el" href="OgreParticleIterator_8h-source.html">OgreParticleIterator.h</a>&gt;</code>
14<p>
15<a href="classOgre_1_1ParticleIterator-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>bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ParticleIterator.html#Ogre_1_1ParticleIteratora0">end</a> (void)</td></tr>
19
20<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1Particle.html">Particle</a> *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ParticleIterator.html#Ogre_1_1ParticleIteratora1">getNext</a> (void)</td></tr>
21
22<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns a pointer to the next particle, and moves the iterator on by 1 element.  <a href="#Ogre_1_1ParticleIteratora1"></a><br><br></td></tr>
23<tr><td colspan=2><br><h2>Protected Member Functions</h2></td></tr>
24<tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ParticleIterator.html#Ogre_1_1ParticleIteratorb0">ParticleIterator</a> (std::list&lt; <a class="el" href="classOgre_1_1Particle.html">Particle</a> * &gt;::iterator start, std::list&lt; <a class="el" href="classOgre_1_1Particle.html">Particle</a> * &gt;::iterator end)</td></tr>
25
26<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Protected constructor, only available from ParticleSystem::getIterator.  <a href="#Ogre_1_1ParticleIteratorb0"></a><br><br></td></tr>
27<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr>
28<tr><td class="memItemLeft" nowrap align=right valign=top>std::list&lt; <a class="el" href="classOgre_1_1Particle.html">Particle</a> * &gt;::iterator&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ParticleIterator.html#Ogre_1_1ParticleIteratorp0">mPos</a></td></tr>
29
30<tr><td class="memItemLeft" nowrap align=right valign=top>std::list&lt; <a class="el" href="classOgre_1_1Particle.html">Particle</a> * &gt;::iterator&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ParticleIterator.html#Ogre_1_1ParticleIteratorp1">mStart</a></td></tr>
31
32<tr><td class="memItemLeft" nowrap align=right valign=top>std::list&lt; <a class="el" href="classOgre_1_1Particle.html">Particle</a> * &gt;::iterator&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ParticleIterator.html#Ogre_1_1ParticleIteratorp2">mEnd</a></td></tr>
33
34<tr><td colspan=2><br><h2>Friends</h2></td></tr>
35<tr><td class="memItemLeft" nowrap align=right valign=top>class&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ParticleIterator.html#Ogre_1_1ParticleIteratorn0">ParticleSystem</a></td></tr>
36
37</table>
38<hr><a name="_details"></a><h2>Detailed Description</h2>
39Convenience class to make it easy to step through all particles in a <a class="el" href="classOgre_1_1ParticleSystem.html">ParticleSystem</a>.
40<p>
41
42<p>
43Definition at line <a class="el" href="OgreParticleIterator_8h-source.html#l00035">35</a> of file <a class="el" href="OgreParticleIterator_8h-source.html">OgreParticleIterator.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
44<a class="anchor" name="Ogre_1_1ParticleIteratorb0" doxytag="Ogre::ParticleIterator::ParticleIterator" ></a><p>
45<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
46  <tr>
47    <td class="mdRow">
48      <table cellpadding="0" cellspacing="0" border="0">
49        <tr>
50          <td class="md" nowrap valign="top"> Ogre::ParticleIterator::ParticleIterator </td>
51          <td class="md" valign="top">(&nbsp;</td>
52          <td class="md" nowrap valign="top">std::list&lt; <a class="el" href="classOgre_1_1Particle.html">Particle</a> * &gt;::iterator&nbsp;</td>
53          <td class="mdname" nowrap> <em>start</em>, </td>
54        </tr>
55        <tr>
56          <td class="md" nowrap align="right"></td>
57          <td></td>
58          <td class="md" nowrap>std::list&lt; <a class="el" href="classOgre_1_1Particle.html">Particle</a> * &gt;::iterator&nbsp;</td>
59          <td class="mdname" nowrap> <em>end</em></td>
60        </tr>
61        <tr>
62          <td></td>
63          <td class="md">)&nbsp;</td>
64          <td class="md" colspan="2"><code> [protected]</code></td>
65        </tr>
66
67      </table>
68    </td>
69  </tr>
70</table>
71<table cellspacing=5 cellpadding=0 border=0>
72  <tr>
73    <td>
74      &nbsp;
75    </td>
76    <td>
77
78<p>
79Protected constructor, only available from ParticleSystem::getIterator.
80<p>
81    </td>
82  </tr>
83</table>
84<hr><h2>Member Function Documentation</h2>
85<a class="anchor" name="Ogre_1_1ParticleIteratora0" doxytag="Ogre::ParticleIterator::end" ></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"> bool Ogre::ParticleIterator::end </td>
92          <td class="md" valign="top">(&nbsp;</td>
93          <td class="md" nowrap valign="top">void&nbsp;</td>
94          <td class="mdname1" valign="top" nowrap>          </td>
95          <td class="md" valign="top">&nbsp;)&nbsp;</td>
96          <td class="md" nowrap></td>
97        </tr>
98
99      </table>
100    </td>
101  </tr>
102</table>
103<table cellspacing=5 cellpadding=0 border=0>
104  <tr>
105    <td>
106      &nbsp;
107    </td>
108    <td>
109
110<p>
111    </td>
112  </tr>
113</table>
114<a class="anchor" name="Ogre_1_1ParticleIteratora1" doxytag="Ogre::ParticleIterator::getNext" ></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"> <a class="el" href="classOgre_1_1Particle.html">Particle</a>* Ogre::ParticleIterator::getNext </td>
121          <td class="md" valign="top">(&nbsp;</td>
122          <td class="md" nowrap valign="top">void&nbsp;</td>
123          <td class="mdname1" valign="top" nowrap>          </td>
124          <td class="md" valign="top">&nbsp;)&nbsp;</td>
125          <td class="md" nowrap></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>
140Returns a pointer to the next particle, and moves the iterator on by 1 element.
141<p>
142    </td>
143  </tr>
144</table>
145<hr><h2>Friends And Related Function Documentation</h2>
146<a class="anchor" name="Ogre_1_1ParticleIteratorn0" doxytag="Ogre::ParticleIterator::ParticleSystem" ></a><p>
147<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
148  <tr>
149    <td class="mdRow">
150      <table cellpadding="0" cellspacing="0" border="0">
151        <tr>
152          <td class="md" nowrap valign="top"> friend class <a class="el" href="classOgre_1_1ParticleSystem.html">ParticleSystem</a><code> [friend]</code>
153      </table>
154    </td>
155  </tr>
156</table>
157<table cellspacing=5 cellpadding=0 border=0>
158  <tr>
159    <td>
160      &nbsp;
161    </td>
162    <td>
163
164<p>
165
166<p>
167Definition at line <a class="el" href="OgreParticleIterator_8h-source.html#l00037">37</a> of file <a class="el" href="OgreParticleIterator_8h-source.html">OgreParticleIterator.h</a>.    </td>
168  </tr>
169</table>
170<hr><h2>Member Data Documentation</h2>
171<a class="anchor" name="Ogre_1_1ParticleIteratorp2" doxytag="Ogre::ParticleIterator::mEnd" ></a><p>
172<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
173  <tr>
174    <td class="mdRow">
175      <table cellpadding="0" cellspacing="0" border="0">
176        <tr>
177          <td class="md" nowrap valign="top"> std::list&lt;<a class="el" href="classOgre_1_1Particle.html">Particle</a>*&gt;::iterator <a class="el" href="classOgre_1_1ParticleIterator.html#Ogre_1_1ParticleIteratorp2">Ogre::ParticleIterator::mEnd</a><code> [protected]</code>
178      </table>
179    </td>
180  </tr>
181</table>
182<table cellspacing=5 cellpadding=0 border=0>
183  <tr>
184    <td>
185      &nbsp;
186    </td>
187    <td>
188
189<p>
190
191<p>
192Definition at line <a class="el" href="OgreParticleIterator_8h-source.html#l00041">41</a> of file <a class="el" href="OgreParticleIterator_8h-source.html">OgreParticleIterator.h</a>.    </td>
193  </tr>
194</table>
195<a class="anchor" name="Ogre_1_1ParticleIteratorp0" doxytag="Ogre::ParticleIterator::mPos" ></a><p>
196<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
197  <tr>
198    <td class="mdRow">
199      <table cellpadding="0" cellspacing="0" border="0">
200        <tr>
201          <td class="md" nowrap valign="top"> std::list&lt;<a class="el" href="classOgre_1_1Particle.html">Particle</a>*&gt;::iterator <a class="el" href="classOgre_1_1ParticleIterator.html#Ogre_1_1ParticleIteratorp0">Ogre::ParticleIterator::mPos</a><code> [protected]</code>
202      </table>
203    </td>
204  </tr>
205</table>
206<table cellspacing=5 cellpadding=0 border=0>
207  <tr>
208    <td>
209      &nbsp;
210    </td>
211    <td>
212
213<p>
214
215<p>
216Definition at line <a class="el" href="OgreParticleIterator_8h-source.html#l00039">39</a> of file <a class="el" href="OgreParticleIterator_8h-source.html">OgreParticleIterator.h</a>.    </td>
217  </tr>
218</table>
219<a class="anchor" name="Ogre_1_1ParticleIteratorp1" doxytag="Ogre::ParticleIterator::mStart" ></a><p>
220<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
221  <tr>
222    <td class="mdRow">
223      <table cellpadding="0" cellspacing="0" border="0">
224        <tr>
225          <td class="md" nowrap valign="top"> std::list&lt;<a class="el" href="classOgre_1_1Particle.html">Particle</a>*&gt;::iterator <a class="el" href="classOgre_1_1ParticleIterator.html#Ogre_1_1ParticleIteratorp1">Ogre::ParticleIterator::mStart</a><code> [protected]</code>
226      </table>
227    </td>
228  </tr>
229</table>
230<table cellspacing=5 cellpadding=0 border=0>
231  <tr>
232    <td>
233      &nbsp;
234    </td>
235    <td>
236
237<p>
238
239<p>
240Definition at line <a class="el" href="OgreParticleIterator_8h-source.html#l00040">40</a> of file <a class="el" href="OgreParticleIterator_8h-source.html">OgreParticleIterator.h</a>.    </td>
241  </tr>
242</table>
243<hr>The documentation for this class was generated from the following file:<ul>
244<li><a class="el" href="OgreParticleIterator_8h-source.html">OgreParticleIterator.h</a></ul>
245<hr>
246<p>
247Copyright &copy; 2000-2005 by The OGRE Team<br />
248<!--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/>
249This 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/>
250                <!--/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#">
251                <Work rdf:about="">
252                        <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" />
253        <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" />
254                </Work>
255                <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> -->
256
257Last modified Sun Feb 12 13:01:48 2006
258</p>
259</body>
260</html>
Note: See TracBrowser for help on using the repository browser.