OGRE  1.12.8
Object-Oriented Graphics Rendering Engine
Ogre::DirectionRandomiserAffector Class Reference

This class defines a ParticleAffector which applies randomness to the movement of the particles. More...

#include <OgreDirectionRandomiserAffector.h>

+ Inheritance diagram for Ogre::DirectionRandomiserAffector:

Classes

class  CmdKeepVelocity
 Command object for keep_velocity (see ParamCommand). More...
 
class  CmdRandomness
 Command object for randomness (see ParamCommand). More...
 
class  CmdScope
 Command object for scope (see ParamCommand). More...
 

Public Member Functions

 DirectionRandomiserAffector (ParticleSystem *psys)
 Default constructor. More...
 
void _affectParticles (ParticleSystem *pSystem, Real timeElapsed)
 See ParticleAffector. More...
 
bool getKeepVelocity (void) const
 Gets flag which detemines whether particle speed is changed. More...
 
Real getRandomness (void) const
 Gets the randomness to apply to the particles in a system. More...
 
Real getScope (void) const
 Gets the scope (percentage of particles which are randomised). More...
 
void setKeepVelocity (bool keepVelocity)
 Set flag which detemines whether particle speed is changed. More...
 
void setRandomness (Real force)
 Sets the randomness to apply to the particles in a system. More...
 
void setScope (Real force)
 Sets the scope (percentage of particles which are randomised). More...
 
- Public Member Functions inherited from Ogre::ParticleAffector
 ParticleAffector (ParticleSystem *parent)
 
virtual ~ParticleAffector ()
 Virtual destructor essential. More...
 
virtual void _initParticle (Particle *pParticle)
 Method called to allow the affector to initialize all newly created particles in the system. More...
 
const StringgetType (void) const
 Returns the name of the type of affector. More...
 
- Public Member Functions inherited from Ogre::StringInterface
 StringInterface ()
 
virtual ~StringInterface ()
 Virtual destructor, see Effective C++. More...
 
void copyParametersTo (StringInterface *dest) const
 Method for copying this object's parameters to another object. More...
 
ParamDictionarygetParamDictionary (void)
 Retrieves the parameter dictionary for this class. More...
 
const ParamDictionarygetParamDictionary (void) const
 
String getParameter (const String &name) const
 Generic parameter retrieval method. More...
 
const ParameterListgetParameters (void) const
 Retrieves a list of parameters valid for this object. More...
 
bool setParameter (const String &name, const String &value)
 Generic parameter setting method. More...
 
void setParameterList (const NameValuePairList &paramList)
 Generic multiple parameter setting method. More...
 

Static Public Attributes

static CmdKeepVelocity msKeepVelocityCmd
 
static CmdRandomness msRandomnessCmd
 Command objects. More...
 
static CmdScope msScopeCmd
 

Additional Inherited Members

- Static Public Member Functions inherited from Ogre::StringInterface
static void cleanupDictionary ()
 Cleans up the static 'msDictionary' required to reset Ogre, otherwise the containers are left with invalid pointers, which will lead to a crash as soon as one of the ResourceManager implementers (e.g. More...
 

Detailed Description

This class defines a ParticleAffector which applies randomness to the movement of the particles.

Remarks
This affector (see ParticleAffector) applies randomness to the movement of the particles by changing the direction vectors.
The most important parameter to control the effect is randomness. It controls the range in which changes are applied to each axis of the direction vector. The parameter scope can be used to limit the effect to a certain percentage of the particles.

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