Ogre::DirectionRandomiserAffector2 Class Reference

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

#include <OgreDirectionRandomiserAffector2.h>

Inheritance diagram for Ogre::DirectionRandomiserAffector2:

Public Member Functions
	DirectionRandomiserAffector2 ()
void	_cloneFrom (const ParticleAffector2 *original) override
bool	getKeepVelocity () const
	Gets flag which detemines whether particle speed is changed. More...
Real	getRandomness () const
	Gets the randomness to apply to the particles in a system. More...
Real	getScope () const
	Gets the scope (percentage of particles which are randomised). More...
String	getType () const override
	Returns the name of the type of affector. More...
void	run (ParticleCpuData cpuData, size_t numParticles, ArrayReal timeSinceLast) const override
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::ParticleAffector2
virtual void	initEmittedParticles (ParticleCpuData, const EmittedParticle *, size_t) const
	Initializes particles Can be called by multiple threads. More...
virtual bool	needsInitialization () const
	Returns true if initEmittedParticles() must be called on a particle that has been emitted. More...
virtual void	oneTimeInit ()
virtual bool	wantsRotation () const
	Returns true if ParticleSystemDef should default to something else other than ParticleRotationType::None. More...
Public Member Functions inherited from Ogre::StringInterface
	StringInterface ()
virtual	~StringInterface ()
	Virtual destructor, see Effective C++. More...
virtual void	copyParametersTo (StringInterface *dest) const
	Method for copying this object's parameters to another object. More...
ParamDictionary *	getParamDictionary ()
	Retrieves the parameter dictionary for this class. More...
const ParamDictionary *	getParamDictionary () const
virtual String	getParameter (const String &name) const
	Generic parameter retrieval method. More...
const ParameterList &	getParameters () const
	Retrieves a list of parameters valid for this object. More...
virtual bool	setParameter (const String &name, const String &value)
	Generic parameter setting method. More...
virtual void	setParameterList (const NameValuePairList &paramList)
	Generic multiple parameter setting method. More...

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.

Constructor & Destructor Documentation

DirectionRandomiserAffector2()

Ogre::DirectionRandomiserAffector2::DirectionRandomiserAffector2

(

)

Member Function Documentation

_cloneFrom()

void Ogre::DirectionRandomiserAffector2::_cloneFrom ( const ParticleAffector2 *  original )

overridevirtual

Implements Ogre::ParticleAffector2.

getKeepVelocity()

bool Ogre::DirectionRandomiserAffector2::getKeepVelocity

(

)

const

Gets flag which detemines whether particle speed is changed.

getRandomness()

Real Ogre::DirectionRandomiserAffector2::getRandomness

(

)

const

Gets the randomness to apply to the particles in a system.

getScope()

Real Ogre::DirectionRandomiserAffector2::getScope

(

)

const

Gets the scope (percentage of particles which are randomised).

getType()

String Ogre::DirectionRandomiserAffector2::getType ( ) const

overridevirtual

Returns the name of the type of affector.

Remarks

This property is useful for determining the type of affector procedurally so another can be created.

Implements Ogre::ParticleAffector2.

run()

void Ogre::DirectionRandomiserAffector2::run ( ParticleCpuData  cpuData, size_t  numParticles, ArrayReal  timeSinceLast  ) const

overridevirtual

Implements Ogre::ParticleAffector2.

setKeepVelocity()

void Ogre::DirectionRandomiserAffector2::setKeepVelocity

(

bool

keepVelocity

)

Set flag which detemines whether particle speed is changed.

setRandomness()

void Ogre::DirectionRandomiserAffector2::setRandomness

(

Real

force

)

Sets the randomness to apply to the particles in a system.

setScope()

void Ogre::DirectionRandomiserAffector2::setScope

(

Real

force

)

Sets the scope (percentage of particles which are randomised).

---

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

• OgreDirectionRandomiserAffector2.h