Ogre::ParticleIterator Class Reference
Core » Effects

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

`#include <OgreParticleIterator.h>`

## Public Member Functions

bool | end (void)
| Returns true when at the end of the particle list. More...
Particle * | getNext (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

## ParticleIterator()

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

protected

Protected constructor, only available from ParticleSystem::getIterator.

## Member Function Documentation

## end()

bool Ogre::ParticleIterator::end | ( | void |  | ) |

Returns true when at the end of the particle list.

## getNext()

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

## ParticleSystem

friend class ParticleSystem

friend

Definition at line 47 of file OgreParticleIterator.h.

## Member Data Documentation

## mEnd

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

protected

Definition at line 51 of file OgreParticleIterator.h.

## mPos

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

protected

Definition at line 49 of file OgreParticleIterator.h.

## mStart

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:

- OgreParticleIterator.h

Copyright © 2012 Torus Knot Software Ltd
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.