OGRE  1.9.0
OgreParticleAffector.h
Go to the documentation of this file.
1/*
2-----------------------------------------------------------------------------
3This source file is part of OGRE
4(Object-oriented Graphics Rendering Engine)
5For the latest info, see http://www.ogre3d.org/
6
7Copyright (c) 2000-2014 Torus Knot Software Ltd
8
9Permission is hereby granted, free of charge, to any person obtaining a copy
10of this software and associated documentation files (the "Software"), to deal
11in the Software without restriction, including without limitation the rights
12to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
13copies of the Software, and to permit persons to whom the Software is
14furnished to do so, subject to the following conditions:
15
16The above copyright notice and this permission notice shall be included in
17all copies or substantial portions of the Software.
18
19THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
22AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
24OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
25THE 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
37namespace 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
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
#define _OgreExport
Definition: OgrePlatform.h:260
Superclass for all objects that wish to use custom memory allocators when their new / delete operator...
Abstract class defining the interface to be implemented by particle affectors.
void addBaseParameters(void)
Internal method for setting up the basic parameter definitions for a subclass.
virtual void _initParticle(Particle *pParticle)
Method called to allow the affector to initialize all newly created particles in the system.
virtual void _affectParticles(ParticleSystem *pSystem, Real timeElapsed)=0
Method called to allow the affector to 'do it's stuff' on all active particles in the system.
virtual ~ParticleAffector()
Virtual destructor essential.
ParticleAffector(ParticleSystem *parent)
const String & getType(void) const
Returns the name of the type of affector.
String mType
Name of the type of affector, MUST be initialised by subclasses.
Class defining particle system based special effects.
Class representing a single particle instance.
Definition: OgreParticle.h:62
Class defining the common interface which classes can use to present a reflection-style,...
float Real
Software floating point type.
_StringBase String