<html>
<head>
<title>Ogre::ParticleIterator class Reference - OGRE Documentation</title> <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<link type="text/css" rel="stylesheet" href="style.css">
</head>
<body>
<!-- Generated by Doxygen 1.2.16 -->
<center>
<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="namespaces.html">Namespace List</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="namespacemembers.html">Namespace Members</a> <a class="qindex" href="functions.html">Compound Members</a> <a class="qindex" href="globals.html">File Members</a> <a class="qindex" href="pages.html">Related Pages</a> </center>
<hr><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>.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="OgreParticleIterator_8h-source.html">OgreParticleIterator.h</a>></code>
<p>
<a href="classOgre_1_1ParticleIterator-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
<tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classOgre_1_1ParticleIterator.html#Ogre_1_1ParticleIteratora0">end</a> (void)</td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="classOgre_1_1Particle.html">Particle</a> * </td><td valign=bottom><a class="el" href="classOgre_1_1ParticleIterator.html#Ogre_1_1ParticleIteratora1">getNext</a> (void)</td></tr>
<tr><td> </td><td><font size=-1><em>Returns a pointer to the next particle, and moves the iterator on by 1 element.</em> <a href="#Ogre_1_1ParticleIteratora1"></a><em></em></font><br><br></td></tr>
<tr><td colspan=2><br><h2>Protected Methods</h2></td></tr>
<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classOgre_1_1ParticleIterator.html#Ogre_1_1ParticleIteratorb0">ParticleIterator</a> (std::list< <a class="el" href="classOgre_1_1Billboard.html">Billboard</a> * >::iterator start, std::list< <a class="el" href="classOgre_1_1Billboard.html">Billboard</a> * >::iterator end)</td></tr>
<tr><td> </td><td><font size=-1><em>Protected constructor, only available from ParticleSystem::getIterator.</em> <a href="#Ogre_1_1ParticleIteratorb0"></a><em></em></font><br><br></td></tr>
<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr>
<tr><td nowrap align=right valign=top>std::list< <a class="el" href="classOgre_1_1Billboard.html">Billboard</a> <br>
* >::iterator </td><td valign=bottom><a class="el" href="classOgre_1_1ParticleIterator.html#Ogre_1_1ParticleIteratorn0">mPos</a></td></tr>
<tr><td nowrap align=right valign=top>std::list< <a class="el" href="classOgre_1_1Billboard.html">Billboard</a> <br>
* >::iterator </td><td valign=bottom><a class="el" href="classOgre_1_1ParticleIterator.html#Ogre_1_1ParticleIteratorn1">mStart</a></td></tr>
<tr><td nowrap align=right valign=top>std::list< <a class="el" href="classOgre_1_1Billboard.html">Billboard</a> <br>
* >::iterator </td><td valign=bottom><a class="el" href="classOgre_1_1ParticleIterator.html#Ogre_1_1ParticleIteratorn2">mEnd</a></td></tr>
<tr><td colspan=2><br><h2>Friends</h2></td></tr>
<tr><td nowrap align=right valign=top>class </td><td valign=bottom><a class="el" href="classOgre_1_1ParticleIterator.html#Ogre_1_1ParticleIteratorl0">ParticleSystem</a></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Convenience class to make it easy to step through all particles in a <a class="el" href="classOgre_1_1ParticleSystem.html">ParticleSystem</a>.
<p>
<p>
Definition 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 & Destructor Documentation</h2>
<a name="Ogre_1_1ParticleIteratorb0" doxytag="Ogre::ParticleIterator::ParticleIterator"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> Ogre::ParticleIterator::ParticleIterator </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">std::list< <a class="el" href="classOgre_1_1Billboard.html">Billboard</a> * >::iterator </td>
<td class="mdname" nowrap> <em>start</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>std::list< <a class="el" href="classOgre_1_1Billboard.html">Billboard</a> * >::iterator </td>
<td class="mdname" nowrap> <em>end</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [protected]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Protected constructor, only available from ParticleSystem::getIterator.
<p>
<p>
Definition at line <a class="el" href="OgreParticleIterator_8cpp-source.html#l00032">32</a> of file <a class="el" href="OgreParticleIterator_8cpp-source.html">OgreParticleIterator.cpp</a>.
<p>
References <a class="el" href="OgreParticleIterator_8cpp-source.html#l00038">end</a>(), <a class="el" href="OgreParticleIterator_8h-source.html#l00041">mEnd</a>, <a class="el" href="OgreParticleIterator_8h-source.html#l00039">mPos</a>, and <a class="el" href="OgreParticleIterator_8h-source.html#l00040">mStart</a>. </td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a name="Ogre_1_1ParticleIteratora0" doxytag="Ogre::ParticleIterator::end"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> bool Ogre::ParticleIterator::end </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<p>
Definition at line <a class="el" href="OgreParticleIterator_8cpp-source.html#l00038">38</a> of file <a class="el" href="OgreParticleIterator_8cpp-source.html">OgreParticleIterator.cpp</a>.
<p>
References <a class="el" href="OgreParticleIterator_8h-source.html#l00041">mEnd</a>, and <a class="el" href="OgreParticleIterator_8h-source.html#l00039">mPos</a>.
<p>
Referenced by <a class="el" href="OgreScaleAffector_8cpp-source.html#l00053">Ogre::ScaleAffector::_affectParticles</a>(), <a class="el" href="OgreRotationAffector_8cpp-source.html#l00085">Ogre::RotationAffector::_affectParticles</a>(), <a class="el" href="OgreLinearForceAffector_8cpp-source.html#l00065">Ogre::LinearForceAffector::_affectParticles</a>(), <a class="el" href="OgreColourInterpolatorAffector_8cpp-source.html#l00071">Ogre::ColourInterpolatorAffector::_affectParticles</a>(), <a class="el" href="OgreColourImageAffector_8cpp-source.html#l00063">Ogre::ColourImageAffector::_affectParticles</a>(), <a class="el" href="OgreColourFaderAffector2_8cpp-source.html#l00098">Ogre::ColourFaderAffector2::_affectParticles</a>(), <a class="el" href="OgreColourFaderAffector_8cpp-source.html#l00067">Ogre::ColourFaderAffector::_affectParticles</a>(), and <a class="el" href="OgreParticleIterator_8cpp-source.html#l00032">ParticleIterator</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1ParticleIteratora1" doxytag="Ogre::ParticleIterator::getNext"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1Particle.html">Particle</a> * Ogre::ParticleIterator::getNext </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Returns a pointer to the next particle, and moves the iterator on by 1 element.
<p>
<p>
Definition at line <a class="el" href="OgreParticleIterator_8cpp-source.html#l00043">43</a> of file <a class="el" href="OgreParticleIterator_8cpp-source.html">OgreParticleIterator.cpp</a>.
<p>
References <a class="el" href="OgreParticleIterator_8h-source.html#l00039">mPos</a>.
<p>
Referenced by <a class="el" href="OgreScaleAffector_8cpp-source.html#l00053">Ogre::ScaleAffector::_affectParticles</a>(), <a class="el" href="OgreRotationAffector_8cpp-source.html#l00085">Ogre::RotationAffector::_affectParticles</a>(), <a class="el" href="OgreLinearForceAffector_8cpp-source.html#l00065">Ogre::LinearForceAffector::_affectParticles</a>(), <a class="el" href="OgreColourInterpolatorAffector_8cpp-source.html#l00071">Ogre::ColourInterpolatorAffector::_affectParticles</a>(), <a class="el" href="OgreColourImageAffector_8cpp-source.html#l00063">Ogre::ColourImageAffector::_affectParticles</a>(), <a class="el" href="OgreColourFaderAffector2_8cpp-source.html#l00098">Ogre::ColourFaderAffector2::_affectParticles</a>(), and <a class="el" href="OgreColourFaderAffector_8cpp-source.html#l00067">Ogre::ColourFaderAffector::_affectParticles</a>(). </td>
</tr>
</table>
<hr><h2>Friends And Related Function Documentation</h2>
<a name="Ogre_1_1ParticleIteratorl0" doxytag="Ogre::ParticleIterator::ParticleSystem"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> friend class ParticleSystem<code> [friend]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<p>
Definition 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>
</tr>
</table>
<hr><h2>Member Data Documentation</h2>
<a name="Ogre_1_1ParticleIteratorn2" doxytag="Ogre::ParticleIterator::mEnd"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> std::list<<a class="el" href="classOgre_1_1Billboard.html">Billboard</a>*>::iterator Ogre::ParticleIterator::mEnd<code> [protected]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<p>
Definition 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>.
<p>
Referenced by <a class="el" href="OgreParticleIterator_8cpp-source.html#l00038">end</a>(), and <a class="el" href="OgreParticleIterator_8cpp-source.html#l00032">ParticleIterator</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1ParticleIteratorn0" doxytag="Ogre::ParticleIterator::mPos"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> std::list<<a class="el" href="classOgre_1_1Billboard.html">Billboard</a>*>::iterator Ogre::ParticleIterator::mPos<code> [protected]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<p>
Definition 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>.
<p>
Referenced by <a class="el" href="OgreParticleIterator_8cpp-source.html#l00038">end</a>(), <a class="el" href="OgreParticleIterator_8cpp-source.html#l00043">getNext</a>(), and <a class="el" href="OgreParticleIterator_8cpp-source.html#l00032">ParticleIterator</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1ParticleIteratorn1" doxytag="Ogre::ParticleIterator::mStart"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> std::list<<a class="el" href="classOgre_1_1Billboard.html">Billboard</a>*>::iterator Ogre::ParticleIterator::mStart<code> [protected]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<p>
Definition 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>.
<p>
Referenced by <a class="el" href="OgreParticleIterator_8cpp-source.html#l00032">ParticleIterator</a>(). </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="OgreParticleIterator_8h-source.html">OgreParticleIterator.h</a><li><a class="el" href="OgreParticleIterator_8cpp-source.html">OgreParticleIterator.cpp</a></ul>
<p>
Copyright © 2002-2003 by The OGRE Team<br />
Last modified Wed Jan 21 00:18:57 2004
</p>
</body>
</html>
