Ogre::ParticleAffector2 Class Reference

Affectors are per ParticleSystemDef. More...

#include <OgreParticleAffector2.h>

Inheritance diagram for Ogre::ParticleAffector2:

Public Member Functions
virtual void	_cloneFrom (const ParticleAffector2 *original)=0
virtual String	getType () const =0
	Returns the name of the type of affector.
virtual void	initEmittedParticles (ParticleCpuData, const EmittedParticle *, size_t) const
	Initializes particles Can be called by multiple threads.
virtual bool	needsInitialization () const
	Returns true if initEmittedParticles() must be called on a particle that has been emitted.
virtual void	oneTimeInit ()
virtual void	run (ParticleCpuData cpuData, size_t numParticles, ArrayReal timeSinceLast) const =0
virtual bool	wantsRotation () const
	Returns true if ParticleSystemDef should default to something else other than ParticleRotationType::None.
Public Member Functions inherited from Ogre::StringInterface
	StringInterface ()
virtual	~StringInterface ()
	Virtual destructor, see Effective C++.
virtual void	copyParametersTo (StringInterface *dest) const
	Method for copying this object's parameters to another object.
ParamDictionary *	getParamDictionary ()
	Retrieves the parameter dictionary for this class.
const ParamDictionary *	getParamDictionary () const
virtual String	getParameter (const String &name) const
	Generic parameter retrieval method.
const ParameterList &	getParameters () const
	Retrieves a list of parameters valid for this object.
virtual bool	setParameter (const String &name, const String &value)
	Generic parameter setting method.
virtual void	setParameterList (const NameValuePairList &paramList)
	Generic multiple parameter setting method.

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.

Detailed Description

Affectors are per ParticleSystemDef.

Member Function Documentation

_cloneFrom()

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

pure virtual

Implemented in Ogre::ColourFaderAffector2FX2, Ogre::ColourFaderAffectorFX2, Ogre::ColourImageAffector2, Ogre::ColourInterpolatorAffector2, Ogre::DeflectorPlaneAffector2, Ogre::DirectionRandomiserAffector2, Ogre::LinearForceAffector2, Ogre::RotationAffector2, Ogre::ScaleAffector2, and Ogre::ScaleInterpolatorAffector2.

getType()

virtual String Ogre::ParticleAffector2::getType ( ) const

pure virtual

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.

Implemented in Ogre::ColourFaderAffector2FX2, Ogre::ColourFaderAffectorFX2, Ogre::ColourImageAffector2, Ogre::ColourInterpolatorAffector2, Ogre::DeflectorPlaneAffector2, Ogre::DirectionRandomiserAffector2, Ogre::LinearForceAffector2, Ogre::RotationAffector2, Ogre::ScaleAffector2, and Ogre::ScaleInterpolatorAffector2.

initEmittedParticles()

virtual void Ogre::ParticleAffector2::initEmittedParticles ( ParticleCpuData  , const EmittedParticle *  , size_t    ) const

inlinevirtual

Initializes particles Can be called by multiple threads.

See also

EmitterDefData::initEmittedParticles

Remarks

If this is overloaded, then needsInitialization() must return true.

Reimplemented in Ogre::RotationAffector2.

needsInitialization()

virtual bool Ogre::ParticleAffector2::needsInitialization ( ) const

inlinevirtual

Returns true if initEmittedParticles() must be called on a particle that has been emitted.

Reimplemented in Ogre::RotationAffector2.

oneTimeInit()

virtual void Ogre::ParticleAffector2::oneTimeInit ( )

inlinevirtual

Reimplemented in Ogre::ColourImageAffector2.

run()

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

pure virtual

Implemented in Ogre::ColourFaderAffector2FX2, Ogre::ColourFaderAffectorFX2, Ogre::ColourImageAffector2, Ogre::ColourInterpolatorAffector2, Ogre::DeflectorPlaneAffector2, Ogre::DirectionRandomiserAffector2, Ogre::LinearForceAffector2, Ogre::RotationAffector2, Ogre::ScaleAffector2, and Ogre::ScaleInterpolatorAffector2.

wantsRotation()

virtual bool Ogre::ParticleAffector2::wantsRotation ( ) const

inlinevirtual

Returns true if ParticleSystemDef should default to something else other than ParticleRotationType::None.

Reimplemented in Ogre::RotationAffector2.

---

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

• OgreParticleAffector2.h