OGRE  2.0
Object-Oriented Graphics Rendering Engine
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Ogre::ParticleIterator Class Reference

Convenience class to make it easy to step through all particles in a ParticleSystem. More...

#include <OgreParticleIterator.h>

+ Collaboration diagram for Ogre::ParticleIterator:

Public Member Functions

bool end (void)
 Returns true when at the end of the particle list. More...
 
ParticlegetNext (void)
 Returns a pointer to the next particle, and moves the iterator on by 1 element. More...
 

Protected Member Functions

 ParticleIterator (list< Particle * >::type::iterator start, list< Particle * >::type::iterator end)
 Protected constructor, only available from ParticleSystem::getIterator. More...
 

Protected Attributes

list< Particle * >::type::iterator mEnd
 
list< Particle * >::type::iterator mPos
 
list< Particle * >::type::iterator mStart
 

Friends

class ParticleSystem
 

Detailed Description

Convenience class to make it easy to step through all particles in a ParticleSystem.

Definition at line 45 of file OgreParticleIterator.h.

Constructor & Destructor Documentation

Ogre::ParticleIterator::ParticleIterator ( list< Particle * >::type::iterator  start,
list< Particle * >::type::iterator  end 
)
protected

Protected constructor, only available from ParticleSystem::getIterator.

Member Function Documentation

bool Ogre::ParticleIterator::end ( void  )

Returns true when at the end of the particle list.

Particle* Ogre::ParticleIterator::getNext ( void  )

Returns a pointer to the next particle, and moves the iterator on by 1 element.

Friends And Related Function Documentation

friend class ParticleSystem
friend

Definition at line 47 of file OgreParticleIterator.h.

Member Data Documentation

list<Particle*>::type::iterator Ogre::ParticleIterator::mEnd
protected

Definition at line 51 of file OgreParticleIterator.h.

list<Particle*>::type::iterator Ogre::ParticleIterator::mPos
protected

Definition at line 49 of file OgreParticleIterator.h.

list<Particle*>::type::iterator Ogre::ParticleIterator::mStart
protected

Definition at line 50 of file OgreParticleIterator.h.


The documentation for this class was generated from the following file: