Ogre::RotationAffector2 Class Reference

This plugin subclass of ParticleAffector allows you to alter the rotation of particles. More...

#include <OgreRotationAffector2.h>

Inheritance diagram for Ogre::RotationAffector2:

Public Member Functions
	RotationAffector2 ()
void	_cloneFrom (const ParticleAffector2 *original) override
const Radian &	getRotationRangeEnd () const
	Gets the maximum rotation of particles to be emitted. More...
const Radian &	getRotationRangeStart () const
	Gets the minimum rotation of particles to be emitted. More...
const Radian &	getRotationSpeedRangeEnd () const
	Gets the maximum rotation speed of particles to be emitted. More...
const Radian &	getRotationSpeedRangeStart () const
	Gets the minimum rotation speed of particles to be emitted. More...
String	getType () const override
	Returns the name of the type of affector. More...
void	initEmittedParticles (ParticleCpuData cpuData, const EmittedParticle *newHandles, size_t numParticles) const override
	Initializes particles Can be called by multiple threads. More...
bool	needsInitialization () const override
	Returns true if initEmittedParticles() must be called on a particle that has been emitted. More...
void	run (ParticleCpuData cpuData, size_t numParticles, ArrayReal timeSinceLast) const override
void	setRotationRangeEnd (const Radian &angle)
	Sets the maximum rotation angle of particles to be emitted. More...
void	setRotationRangeStart (const Radian &angle)
	Sets the minimum rotation angle of particles to be emitted. More...
void	setRotationSpeedRangeEnd (const Radian &angle)
	Sets the maximum rotation speed of particles to be emitted. More...
void	setRotationSpeedRangeStart (const Radian &angle)
	Sets the minimum rotation speed of particles to be emitted. More...
bool	wantsRotation () const override
	Returns true if ParticleSystemDef should default to something else other than ParticleRotationType::None. More...
Public Member Functions inherited from Ogre::ParticleAffector2
virtual void	oneTimeInit ()
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 plugin subclass of ParticleAffector allows you to alter the rotation of particles.

Remarks

This class supplies the ParticleAffector implementation required to make the particle expand or contract in mid-flight.

Constructor & Destructor Documentation

RotationAffector2()

Ogre::RotationAffector2::RotationAffector2

(

)

Member Function Documentation

_cloneFrom()

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

overridevirtual

Implements Ogre::ParticleAffector2.

getRotationRangeEnd()

const Radian& Ogre::RotationAffector2::getRotationRangeEnd

(

)

const

Gets the maximum rotation of particles to be emitted.

getRotationRangeStart()

const Radian& Ogre::RotationAffector2::getRotationRangeStart

(

)

const

Gets the minimum rotation of particles to be emitted.

getRotationSpeedRangeEnd()

const Radian& Ogre::RotationAffector2::getRotationSpeedRangeEnd

(

)

const

Gets the maximum rotation speed of particles to be emitted.

getRotationSpeedRangeStart()

const Radian& Ogre::RotationAffector2::getRotationSpeedRangeStart

(

)

const

Gets the minimum rotation speed of particles to be emitted.

getType()

String Ogre::RotationAffector2::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.

initEmittedParticles()

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

overridevirtual

Initializes particles Can be called by multiple threads.

See also

EmitterDefData::initEmittedParticles

Remarks

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

Reimplemented from Ogre::ParticleAffector2.

needsInitialization()

bool Ogre::RotationAffector2::needsInitialization ( ) const

overridevirtual

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

Reimplemented from Ogre::ParticleAffector2.

run()

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

overridevirtual

Implements Ogre::ParticleAffector2.

setRotationRangeEnd()

void Ogre::RotationAffector2::setRotationRangeEnd

(

const Radian &

angle

)

Sets the maximum rotation angle of particles to be emitted.

setRotationRangeStart()

void Ogre::RotationAffector2::setRotationRangeStart

(

const Radian &

angle

)

Sets the minimum rotation angle of particles to be emitted.

setRotationSpeedRangeEnd()

void Ogre::RotationAffector2::setRotationSpeedRangeEnd

(

const Radian &

angle

)

Sets the maximum rotation speed of particles to be emitted.

setRotationSpeedRangeStart()

void Ogre::RotationAffector2::setRotationSpeedRangeStart

(

const Radian &

angle

)

Sets the minimum rotation speed of particles to be emitted.

wantsRotation()

bool Ogre::RotationAffector2::wantsRotation ( ) const

overridevirtual

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

Reimplemented from Ogre::ParticleAffector2.

---

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

• OgreRotationAffector2.h