Ogre::RotationAffector Class Reference

This affector rotates particles in flight. More...

#include <OgreRotationAffector.h>

Inheritance diagram for Ogre::RotationAffector:

Classes
class	CmdRotationRangeEnd
	Command object for particle emitter - see ParamCommand. More...
class	CmdRotationRangeStart
	Command object for particle emitter - see ParamCommand. More...
class	CmdRotationSpeedRangeEnd
	Command object for particle emitter - see ParamCommand. More...
class	CmdRotationSpeedRangeStart
	Command object for particle emitter - see ParamCommand. More...

Public Member Functions
	RotationAffector (ParticleSystem *psys)
	Default constructor. More...
void	_affectParticles (ParticleSystem *pSystem, Real timeElapsed) override
	Method called to allow the affector to 'do it's stuff' on all active particles in the system. More...
void	_initParticle (Particle *pParticle) override
	Method called to allow the affector to initialize all newly created particles in the system. More...
const Radian &	getRotationRangeEnd (void) const
	Gets the maximum rotation of particles to be emitted. More...
const Radian &	getRotationRangeStart (void) const
	Gets the minimum rotation of particles to be emitted. More...
const Radian &	getRotationSpeedRangeEnd (void) const
	Gets the maximum rotation speed of particles to be emitted. More...
const Radian &	getRotationSpeedRangeStart (void) const
	Gets the minimum rotation speed of particles to be emitted. More...
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...
Public Member Functions inherited from Ogre::ParticleAffector
	ParticleAffector (ParticleSystem *parent)
virtual	~ParticleAffector ()
	Virtual destructor essential. More...
const String &	getType (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...
ParamDictionary *	getParamDictionary (void)
	Retrieves the parameter dictionary for this class. More...
const ParamDictionary *	getParamDictionary (void) const
String	getParameter (const String &name) const
	Generic parameter retrieval method. More...
const ParameterList &	getParameters (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 CmdRotationRangeEnd	msRotationRangeEndCmd
static CmdRotationRangeStart	msRotationRangeStartCmd
static CmdRotationSpeedRangeEnd	msRotationSpeedRangeEndCmd
static CmdRotationSpeedRangeStart	msRotationSpeedRangeStartCmd

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 affector rotates particles in flight.

Constructor & Destructor Documentation

RotationAffector()

Ogre::RotationAffector::RotationAffector

(

ParticleSystem *

psys

)

Default constructor.

Member Function Documentation

_initParticle()

void Ogre::RotationAffector::_initParticle ( Particle *  pParticle )

overridevirtual

Method called to allow the affector to initialize all newly created particles in the system.

Remarks

This is where the affector gets the chance to initialize it's effects to the particles of a system. The affector is expected to initialize some or all of the particles in the system passed to it, depending on the affector's approach.

Parameters

pParticle

Pointer to a Particle to initialize.

Reimplemented from Ogre::ParticleAffector.

_affectParticles()

void Ogre::RotationAffector::_affectParticles ( ParticleSystem *  pSystem, Real  timeElapsed  )

overridevirtual

Method called to allow the affector to 'do it's stuff' on all active particles in the system.

Remarks

This is where the affector gets the chance to apply it's effects to the particles of a system. The affector is expected to apply it's effect to some or all of the particles in the system passed to it, depending on the affector's approach.

Parameters

pSystem	Pointer to a ParticleSystem to affect.
timeElapsed	The number of seconds which have elapsed since the last call.

Implements Ogre::ParticleAffector.

setRotationSpeedRangeStart()

void Ogre::RotationAffector::setRotationSpeedRangeStart

(

const Radian &

angle

)

Sets the minimum rotation speed of particles to be emitted.

setRotationSpeedRangeEnd()

void Ogre::RotationAffector::setRotationSpeedRangeEnd

(

const Radian &

angle

)

Sets the maximum rotation speed of particles to be emitted.

getRotationSpeedRangeStart()

const Radian& Ogre::RotationAffector::getRotationSpeedRangeStart

(

void

)

const

Gets the minimum rotation speed of particles to be emitted.

getRotationSpeedRangeEnd()

const Radian& Ogre::RotationAffector::getRotationSpeedRangeEnd

(

void

)

const

Gets the maximum rotation speed of particles to be emitted.

setRotationRangeStart()

void Ogre::RotationAffector::setRotationRangeStart

(

const Radian &

angle

)

Sets the minimum rotation angle of particles to be emitted.

setRotationRangeEnd()

void Ogre::RotationAffector::setRotationRangeEnd

(

const Radian &

angle

)

Sets the maximum rotation angle of particles to be emitted.

getRotationRangeStart()

const Radian& Ogre::RotationAffector::getRotationRangeStart

(

void

)

const

Gets the minimum rotation of particles to be emitted.

getRotationRangeEnd()

const Radian& Ogre::RotationAffector::getRotationRangeEnd

(

void

)

const

Gets the maximum rotation of particles to be emitted.

Member Data Documentation

msRotationSpeedRangeStartCmd

CmdRotationSpeedRangeStart Ogre::RotationAffector::msRotationSpeedRangeStartCmd

static

msRotationSpeedRangeEndCmd

CmdRotationSpeedRangeEnd Ogre::RotationAffector::msRotationSpeedRangeEndCmd

static

msRotationRangeStartCmd

CmdRotationRangeStart Ogre::RotationAffector::msRotationRangeStartCmd

static

msRotationRangeEndCmd

CmdRotationRangeEnd Ogre::RotationAffector::msRotationRangeEndCmd

static

---

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

• OgreRotationAffector.h