OGRE  1.12.8
Object-Oriented Graphics Rendering Engine
Ogre::RotationAffector Class Reference

This plugin subclass of ParticleAffector allows you to alter the rotation of particles. 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)
 See ParticleAffector. More...
 
void _initParticle (Particle *pParticle)
 See ParticleAffector. More...
 
const RadiangetRotationRangeEnd (void) const
 Gets the maximum rotation of particles to be emitted. More...
 
const RadiangetRotationRangeStart (void) const
 Gets the minimum rotation of particles to be emitted. More...
 
const RadiangetRotationSpeedRangeEnd (void) const
 Gets the maximum rotation speed of particles to be emitted. More...
 
const RadiangetRotationSpeedRangeStart (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 StringgetType (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...
 
ParamDictionarygetParamDictionary (void)
 Retrieves the parameter dictionary for this class. More...
 
const ParamDictionarygetParamDictionary (void) const
 
String getParameter (const String &name) const
 Generic parameter retrieval method. More...
 
const ParameterListgetParameters (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 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

◆ RotationAffector()

Ogre::RotationAffector::RotationAffector ( ParticleSystem psys)

Default constructor.

Member Function Documentation

◆ _initParticle()

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

See ParticleAffector.

Reimplemented from Ogre::ParticleAffector.

◆ _affectParticles()

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

◆ 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: