OgreParticleIterator.h
Go to the documentation of this file.
1 /*
2 -----------------------------------------------------------------------------
3 This source file is part of OGRE
4 (Object-oriented Graphics Rendering Engine)
5 For the latest info, see http://www.ogre3d.org/
6 
7 Copyright (c) 2000-2013 Torus Knot Software Ltd
8 
9 Permission is hereby granted, free of charge, to any person obtaining a copy
10 of this software and associated documentation files (the "Software"), to deal
11 in the Software without restriction, including without limitation the rights
12 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
13 copies of the Software, and to permit persons to whom the Software is
14 furnished to do so, subject to the following conditions:
15 
16 The above copyright notice and this permission notice shall be included in
17 all copies or substantial portions of the Software.
18 
19 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
22 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
24 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
25 THE SOFTWARE.
26 -----------------------------------------------------------------------------
27 */
28 #ifndef __ParticleIterator_H__
29 #define __ParticleIterator_H__
30 
31 #include "OgrePrerequisites.h"
32 #include "OgreHeaderPrefix.h"
33 
34 namespace Ogre {
35 
36 
46  {
47  friend class ParticleSystem;
48  protected:
52 
55 
56  public:
58  bool end(void);
59 
61  Particle* getNext(void);
62  };
65 }
66 
67 #include "OgreHeaderSuffix.h"
68 
69 #endif
70 
OgreHeaderSuffix.h
Ogre::ParticleIterator::ParticleIterator
ParticleIterator(list< Particle * >::type::iterator start, list< Particle * >::type::iterator end)
Protected constructor, only available from ParticleSystem::getIterator.
Ogre
Definition: OgreAndroidLogListener.h:35
Ogre::ParticleIterator::mStart
list< Particle * >::type::iterator mStart
Definition: OgreParticleIterator.h:50
Ogre::ParticleIterator::getNext
Particle * getNext(void)
Returns a pointer to the next particle, and moves the iterator on by 1 element.
Ogre::ParticleIterator
Convenience class to make it easy to step through all particles in a ParticleSystem.
Definition: OgreParticleIterator.h:46
OgreHeaderPrefix.h
Ogre::list
Definition: OgrePrerequisites.h:506
OgrePrerequisites.h
_OgreExport
#define _OgreExport
Definition: OgrePlatform.h:257
Ogre::ParticleIterator::mPos
list< Particle * >::type::iterator mPos
Definition: OgreParticleIterator.h:49
Ogre::Particle
Class representing a single particle instance.
Definition: OgreParticle.h:62
Ogre::ParticleSystem
Class defining particle system based special effects.
Definition: OgreParticleSystem.h:68
Ogre::ParticleIterator::mEnd
list< Particle * >::type::iterator mEnd
Definition: OgreParticleIterator.h:51
Ogre::ParticleIterator::end
bool end(void)
Returns true when at the end of the particle list.

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