Ogre::ScaleAffector Class Reference

This affector scales particles in flight. More...

#include <OgreScaleAffector.h>

Inheritance diagram for Ogre::ScaleAffector:

Classes
class	CmdScaleAdjust
	Command object for scale adjust (see ParamCommand). More...

Public Member Functions
	ScaleAffector (ParticleSystem *psys)
	Default constructor.
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.
void	_initParticle (Particle *pParticle) override
	Method called to allow the affector to initialize all newly created particles in the system.
Real	getAdjust (void) const
	Gets the scale adjustment to be made per second to particles.
const Vector2 &	getScaleRange () const
void	setAdjust (Real rate)
	Sets the scale adjustment to be made per second to particles.
void	setScaleRange (const Vector2 &range)
Public Member Functions inherited from Ogre::ParticleAffector
	ParticleAffector (ParticleSystem *parent)
virtual	~ParticleAffector ()
	Virtual destructor essential.
const String &	getType (void) const
	Returns the name of the type of affector.
Public Member Functions inherited from Ogre::StringInterface
	StringInterface ()
virtual	~StringInterface ()
	Virtual destructor, see Effective C++.
void	copyParametersTo (StringInterface *dest) const
	Method for copying this object's parameters to another object.
ParamDictionary *	getParamDictionary (void)
	Retrieves the parameter dictionary for this class.
const ParamDictionary *	getParamDictionary (void) const
String	getParameter (const String &name) const
	Generic parameter retrieval method.
const ParameterList &	getParameters (void) const
	Retrieves a list of parameters valid for this object.
bool	setParameter (const String &name, const String &value)
	Generic parameter setting method.
void	setParameterList (const NameValuePairList &paramList)
	Generic multiple parameter setting method.

Static Public Attributes
static CmdScaleAdjust	msScaleCmd

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

This affector scales particles in flight.

Constructor & Destructor Documentation

ScaleAffector()

Ogre::ScaleAffector::ScaleAffector

(

ParticleSystem *

psys

)

Default constructor.

Member Function Documentation

_initParticle()

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

overridevirtual

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

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::ScaleAffector::_affectParticles ( ParticleSystem *  pSystem, Real  timeElapsed  )

overridevirtual

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

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.

setAdjust()

void Ogre::ScaleAffector::setAdjust

(

Real

rate

)

Sets the scale adjustment to be made per second to particles.

Parameters

rate	Sets the adjustment to be made to the x and y scale components per second. These values will be added to the scale of all particles every second, scaled over each frame for a smooth adjustment.

getAdjust()

Real Ogre::ScaleAffector::getAdjust

(

void

)

const

Gets the scale adjustment to be made per second to particles.

getScaleRange()

const Vector2 & Ogre::ScaleAffector::getScaleRange ( ) const

inline

setScaleRange()

void Ogre::ScaleAffector::setScaleRange ( const Vector2 &  range )

inline

Member Data Documentation

msScaleCmd

CmdScaleAdjust Ogre::ScaleAffector::msScaleCmd

static

---

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

• OgreScaleAffector.h