OGRE  1.9
Object-Oriented Graphics Rendering Engine
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
OgreParticleAffector.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-2014 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 __ParticleAffector_H__
29 #define __ParticleAffector_H__
30 
31 #include "OgrePrerequisites.h"
32 #include "OgreString.h"
33 #include "OgreStringInterface.h"
34 #include "OgreHeaderPrefix.h"
35 
36 
37 namespace Ogre {
38 
65  {
66  protected:
69 
78  void addBaseParameters(void) { /* actually do nothing - for future possible use */ }
79 
81  public:
82  ParticleAffector(ParticleSystem* parent): mParent(parent) {}
83 
85  virtual ~ParticleAffector();
86 
95  virtual void _initParticle(Particle* pParticle)
96  {
97  /* by default do nothing */
98  (void)pParticle;
99  }
100 
111  virtual void _affectParticles(ParticleSystem* pSystem, Real timeElapsed) = 0;
112 
118  const String &getType(void) const { return mType; }
119 
120  };
124 }
125 
126 #include "OgreHeaderSuffix.h"
127 
128 #endif
129 
Class defining particle system based special effects.
float Real
Software floating point type.
#define _OgreExport
Definition: OgrePlatform.h:260
const String & getType(void) const
Returns the name of the type of affector.
virtual void _initParticle(Particle *pParticle)
Method called to allow the affector to initialize all newly created particles in the system...
void addBaseParameters(void)
Internal method for setting up the basic parameter definitions for a subclass.
String mType
Name of the type of affector, MUST be initialised by subclasses.
Class defining the common interface which classes can use to present a reflection-style, self-defining parameter set to callers.
Class representing a single particle instance.
Definition: OgreParticle.h:61
Superclass for all objects that wish to use custom memory allocators when their new / delete operator...
ParticleAffector(ParticleSystem *parent)
Abstract class defining the interface to be implemented by particle affectors.
_StringBase String