Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Related Pages  

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:

Inheritance graph
[legend]
List of all members.

Public Methods

 RotationAffector ()
 Default constructor.

void _initParticle (Particle *pParticle)
 See ParticleAffector.

void _affectParticles (ParticleSystem *pSystem, Real timeElapsed)
 See ParticleAffector.

void setRotationSpeedRangeStart (Real angle)
 Sets the minimum rotation speed of particles to be emitted.

void setRotationSpeedRangeEnd (Real angle)
 Sets the maximum rotation speed of particles to be emitted.

Real getRotationSpeedRangeStart (void) const
 Gets the minimum rotation speed of particles to be emitted.

Real getRotationSpeedRangeEnd (void) const
 Gets the maximum rotation speed of particles to be emitted.

void setRotationRangeStart (Real angle)
 Sets the minimum rotation angle of particles to be emitted.

void setRotationRangeEnd (Real angle)
 Sets the maximum rotation angle of particles to be emitted.

Real getRotationRangeStart (void) const
 Gets the minimum rotation of particles to be emitted.

Real getRotationRangeEnd (void) const
 Gets the maximum rotation of particles to be emitted.

String getType (void) const
 Returns the name of the type of affector.

ParamDictionarygetParamDictionary (void)
 Retrieves the parameter dictionary for this class.

const ParamDictionarygetParamDictionary (void) const
const ParameterListgetParameters (void) const
 Retrieves a list of parameters valid for this object.

virtual bool setParameter (const String &name, const String &value)
 Generic parameter setting method.

virtual String getParameter (const String &name) const
 Generic parameter retrieval method.

virtual void copyParametersTo (StringInterface *dest) const
 Method for copying this object's parameters to another object.


Static Public Attributes

CmdRotationSpeedRangeStart msRotationSpeedRangeStartCmd
CmdRotationSpeedRangeEnd msRotationSpeedRangeEndCmd
CmdRotationRangeStart msRotationRangeStartCmd
CmdRotationRangeEnd msRotationRangeEndCmd

Protected Methods

void addBaseParameters (void)
 Internal method for setting up the basic parameter definitions for a subclass.

bool createParamDictionary (const String &className)
 Internal method for creating a parameter dictionary for the class, if it does not already exist.


Protected Attributes

Real mRotationSpeedRangeStart
 Initial rotation speed of particles (range start).

Real mRotationSpeedRangeEnd
 Initial rotation speed of particles (range end).

Real mRotationRangeStart
 Initial rotation angle of particles (range start).

Real mRotationRangeEnd
 Initial rotation angle of particles (range end).

String mType
 Name of the type of affector, MUST be initialised by subclasses.

String mParamDictName
 Class name for this instance to be used as a lookup (must be initialised by subclasses).


Static Protected Attributes

ParamDictionaryMap msDictionary
 Dictionary of parameters.


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.

Definition at line 40 of file OgreRotationAffector.h.


Constructor & Destructor Documentation

Ogre::RotationAffector::RotationAffector  
 

Default constructor.

Definition at line 40 of file OgreRotationAffector.cpp.

References Ogre::ParamDictionary::addParameter(), Ogre::StringInterface::createParamDictionary(), Ogre::StringInterface::getParamDictionary(), msRotationRangeEndCmd, msRotationRangeStartCmd, msRotationSpeedRangeEndCmd, msRotationSpeedRangeStartCmd, Ogre::ParticleAffector::mType, and Ogre::PT_REAL.


Member Function Documentation

void Ogre::RotationAffector::_affectParticles ParticleSystem   pSystem,
Real    timeElapsed
[virtual]
 

See ParticleAffector.

Implements Ogre::ParticleAffector.

Definition at line 85 of file OgreRotationAffector.cpp.

References Ogre::ParticleSystem::_getIterator(), Ogre::ParticleIterator::end(), Ogre::ParticleIterator::getNext(), Ogre::Billboard::getRotation(), Ogre::Particle::getRotationSpeed(), Ogre::Real, and Ogre::Billboard::setRotation().

void Ogre::RotationAffector::_initParticle Particle   pParticle [virtual]
 

See ParticleAffector.

Reimplemented from Ogre::ParticleAffector.

Definition at line 72 of file OgreRotationAffector.cpp.

References mRotationRangeEnd, mRotationRangeStart, mRotationSpeedRangeEnd, mRotationSpeedRangeStart, Ogre::Billboard::setRotation(), and Ogre::Particle::setRotationSpeed().

void Ogre::ParticleAffector::addBaseParameters void    [protected, inherited]
 

Internal method for setting up the basic parameter definitions for a subclass.

Remarks:
Because StringInterface holds a dictionary of parameters per class, subclasses need to call this to ask the base class to add it's parameters to their dictionary as well. Can't do this in the constructor because that runs in a non-virtual context.

The subclass must have called it's own createParamDictionary before calling this method.

Definition at line 68 of file OgreParticleAffector.h.

Referenced by Ogre::LinearForceAffector::LinearForceAffector().

virtual void Ogre::StringInterface::copyParametersTo StringInterface   dest const [virtual, inherited]
 

Method for copying this object's parameters to another object.

Remarks:
This method takes the values of all the object's parameters and tries to set the same values on the destination object. This provides a completely type independent way to copy parameters to other objects. Note that because of the String manipulation involved, this should not be regarded as an efficient process and should be saved for times outside of the rendering loop.

Any unrecognised parameters will be ignored as with setParameter method.

Parameters:
dest  Pointer to object to have it's parameters set the same as this object.

Definition at line 293 of file OgreStringInterface.h.

References Ogre::ParamDictionary::mParamDefs, and Ogre::StringInterface::setParameter().

Referenced by Ogre::GuiElement::clone(), Ogre::GuiElement::copyFromTemplate(), Ogre::GuiContainer::copyFromTemplate(), and Ogre::ParticleSystem::operator=().

bool Ogre::StringInterface::createParamDictionary const String   className [protected, inherited]
 

Internal method for creating a parameter dictionary for the class, if it does not already exist.

Remarks:
This method will check to see if a parameter dictionary exist for this class yet, and if not will create one. NB you must supply the name of the class (RTTI is not used or performance).
Parameters:
className  the name of the class using the dictionary
Returns:
true if a new dictionary was created, false if it was already there

Definition at line 169 of file OgreStringInterface.h.

Referenced by Ogre::ExternalTextureSource::addBaseParams(), Ogre::BorderButtonGuiElement::BorderButtonGuiElement(), Ogre::BorderPanelGuiElement::BorderPanelGuiElement(), Ogre::ButtonGuiElement::ButtonGuiElement(), Ogre::CgProgram::CgProgram(), Ogre::ColourFaderAffector::ColourFaderAffector(), Ogre::ColourFaderAffector2::ColourFaderAffector2(), Ogre::ColourImageAffector::ColourImageAffector(), Ogre::ColourInterpolatorAffector::ColourInterpolatorAffector(), Ogre::CursorGuiElement::CursorGuiElement(), Ogre::D3D9HLSLProgram::D3D9HLSLProgram(), Ogre::AreaEmitter::initDefaults(), Ogre::ParticleSystem::initParameters(), Ogre::LinearForceAffector::LinearForceAffector(), Ogre::ListGuiElement::ListGuiElement(), Ogre::PanelGuiElement::PanelGuiElement(), Ogre::PointEmitter::PointEmitter(), Ogre::PopupMenuGuiElement::PopupMenuGuiElement(), RotationAffector(), Ogre::ScaleAffector::ScaleAffector(), Ogre::ScrollBarGuiElement::ScrollBarGuiElement(), Ogre::TextAreaGuiElement::TextAreaGuiElement(), Ogre::TextBoxGuiElement::TextBoxGuiElement(), and Ogre::TTYGuiElement::TTYGuiElement().

const ParamDictionary* Ogre::StringInterface::getParamDictionary void    const [inherited]
 

Definition at line 206 of file OgreStringInterface.h.

ParamDictionary* Ogre::StringInterface::getParamDictionary void    [inherited]
 

Retrieves the parameter dictionary for this class.

Remarks:
Only valid to call this after createParamDictionary.
Returns:
Pointer to ParamDictionary shared by all instances of this class which you can add parameters to, retrieve parameters etc.

Definition at line 193 of file OgreStringInterface.h.

Referenced by Ogre::TTYGuiElement::addBaseParameters(), Ogre::TextBoxGuiElement::addBaseParameters(), Ogre::TextAreaGuiElement::addBaseParameters(), Ogre::ScrollBarGuiElement::addBaseParameters(), Ogre::PopupMenuGuiElement::addBaseParameters(), Ogre::ParticleEmitter::addBaseParameters(), Ogre::PanelGuiElement::addBaseParameters(), Ogre::ListGuiElement::addBaseParameters(), Ogre::GuiElement::addBaseParameters(), Ogre::CursorGuiElement::addBaseParameters(), Ogre::ButtonGuiElement::addBaseParameters(), Ogre::BorderPanelGuiElement::addBaseParameters(), Ogre::BorderButtonGuiElement::addBaseParameters(), Ogre::ExternalTextureSource::addBaseParams(), Ogre::CgProgram::CgProgram(), Ogre::ColourFaderAffector::ColourFaderAffector(), Ogre::ColourFaderAffector2::ColourFaderAffector2(), Ogre::ColourImageAffector::ColourImageAffector(), Ogre::ColourInterpolatorAffector::ColourInterpolatorAffector(), Ogre::D3D9HLSLProgram::D3D9HLSLProgram(), Ogre::HollowEllipsoidEmitter::HollowEllipsoidEmitter(), Ogre::AreaEmitter::initDefaults(), Ogre::ParticleSystem::initParameters(), Ogre::LinearForceAffector::LinearForceAffector(), Ogre::RingEmitter::RingEmitter(), RotationAffector(), Ogre::ScaleAffector::ScaleAffector(), and Ogre::StringInterface::setParameter().

virtual String Ogre::StringInterface::getParameter const String   name const [virtual, inherited]
 

Generic parameter retrieval method.

Remarks:
Call this method with the name of a parameter to retrieve a string-format value of the parameter in question. If in doubt, check the parameter definition in the list returned from getParameters for the type of this parameter. If you like you can use StringConverter to convert this string back into a native type.
Parameters:
name  The name of the parameter to get
Returns:
String value of parameter, blank if not found

Definition at line 262 of file OgreStringInterface.h.

References Ogre::ParamCommand::doGet(), and Ogre::ParamDictionary::getParamCommand().

const ParameterList& Ogre::StringInterface::getParameters void    const [inherited]
 

Retrieves a list of parameters valid for this object.

Returns:
A reference to a static list of ParameterDef objects.

Definition at line 224 of file OgreStringInterface.h.

References Ogre::ParamDictionary::getParameters(), and Ogre::ParameterList.

Real Ogre::RotationAffector::getRotationRangeEnd void    const
 

Gets the maximum rotation of particles to be emitted.

Definition at line 131 of file OgreRotationAffector.cpp.

References mRotationRangeEnd, and Ogre::Real.

Referenced by Ogre::RotationAffector::CmdRotationRangeEnd::doGet().

Real Ogre::RotationAffector::getRotationRangeStart void    const
 

Gets the minimum rotation of particles to be emitted.

Definition at line 126 of file OgreRotationAffector.cpp.

References mRotationRangeStart, and Ogre::Real.

Referenced by Ogre::RotationAffector::CmdRotationRangeStart::doGet().

Real Ogre::RotationAffector::getRotationSpeedRangeEnd void    const
 

Gets the maximum rotation speed of particles to be emitted.

Definition at line 111 of file OgreRotationAffector.cpp.

References mRotationSpeedRangeEnd, and Ogre::Real.

Referenced by Ogre::RotationAffector::CmdRotationSpeedRangeEnd::doGet().

Real Ogre::RotationAffector::getRotationSpeedRangeStart void    const
 

Gets the minimum rotation speed of particles to be emitted.

Definition at line 106 of file OgreRotationAffector.cpp.

References mRotationSpeedRangeStart, and Ogre::Real.

Referenced by Ogre::RotationAffector::CmdRotationSpeedRangeStart::doGet().

String Ogre::ParticleAffector::getType void    const [inherited]
 

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.

Definition at line 100 of file OgreParticleAffector.h.

Referenced by Ogre::ParticleSystemManager::_destroyAffector(), Ogre::ParticleSystem::operator=(), and Ogre::ParticleSystemManager::parseAffectorAttrib().

bool Ogre::StringInterface::setParameter const String   name,
const String   value
[virtual, inherited]
 

Generic parameter setting method.

Remarks:
Call this method with the name of a parameter and a string version of the value to set. The implementor will convert the string to a native type internally. If in doubt, check the parameter definition in the list returned from StringInterface::getParameters.
Parameters:
name  The name of the parameter to set
value  String value. Must be in the right format for the type specified in the parameter definition. See the StringConverter class for more information.
Returns:
true if set was successful, false otherwise (NB no exceptions thrown - tolerant method)

Definition at line 33 of file OgreStringInterface.cpp.

References Ogre::ParamCommand::doSet(), Ogre::ParamDictionary::getParamCommand(), and Ogre::StringInterface::getParamDictionary().

Referenced by Ogre::StringInterface::copyParametersTo(), Ogre::Profiler::createContainer(), Ogre::Profiler::createTextArea(), Ogre::MaterialSerializer::finishProgramDefinition(), Ogre::ParticleSystemManager::parseAffectorAttrib(), Ogre::ParticleSystemManager::parseAttrib(), Ogre::OverlayManager::parseElementAttrib(), and Ogre::ParticleSystemManager::parseEmitterAttrib().

void Ogre::RotationAffector::setRotationRangeEnd Real    angle
 

Sets the maximum rotation angle of particles to be emitted.

Definition at line 141 of file OgreRotationAffector.cpp.

References mRotationRangeEnd, and Ogre::Real.

void Ogre::RotationAffector::setRotationRangeStart Real    angle
 

Sets the minimum rotation angle of particles to be emitted.

Definition at line 136 of file OgreRotationAffector.cpp.

References mRotationRangeStart, and Ogre::Real.

void Ogre::RotationAffector::setRotationSpeedRangeEnd Real    angle
 

Sets the maximum rotation speed of particles to be emitted.

Definition at line 121 of file OgreRotationAffector.cpp.

References mRotationSpeedRangeEnd, and Ogre::Real.

void Ogre::RotationAffector::setRotationSpeedRangeStart Real    angle
 

Sets the minimum rotation speed of particles to be emitted.

Definition at line 116 of file OgreRotationAffector.cpp.

References mRotationSpeedRangeStart, and Ogre::Real.


Member Data Documentation

String Ogre::StringInterface::mParamDictName [protected, inherited]
 

Class name for this instance to be used as a lookup (must be initialised by subclasses).

Definition at line 157 of file OgreStringInterface.h.

Real Ogre::RotationAffector::mRotationRangeEnd [protected]
 

Initial rotation angle of particles (range end).

Definition at line 118 of file OgreRotationAffector.h.

Referenced by _initParticle(), getRotationRangeEnd(), and setRotationRangeEnd().

Real Ogre::RotationAffector::mRotationRangeStart [protected]
 

Initial rotation angle of particles (range start).

Definition at line 116 of file OgreRotationAffector.h.

Referenced by _initParticle(), getRotationRangeStart(), and setRotationRangeStart().

Real Ogre::RotationAffector::mRotationSpeedRangeEnd [protected]
 

Initial rotation speed of particles (range end).

Definition at line 114 of file OgreRotationAffector.h.

Referenced by _initParticle(), getRotationSpeedRangeEnd(), and setRotationSpeedRangeEnd().

Real Ogre::RotationAffector::mRotationSpeedRangeStart [protected]
 

Initial rotation speed of particles (range start).

Definition at line 112 of file OgreRotationAffector.h.

Referenced by _initParticle(), getRotationSpeedRangeStart(), and setRotationSpeedRangeStart().

ParamDictionaryMap Ogre::StringInterface::msDictionary [static, protected, inherited]
 

Dictionary of parameters.

Definition at line 30 of file OgreStringInterface.cpp.

RotationAffector::CmdRotationRangeEnd Ogre::RotationAffector::msRotationRangeEndCmd [static]
 

Definition at line 37 of file OgreRotationAffector.cpp.

Referenced by RotationAffector().

RotationAffector::CmdRotationRangeStart Ogre::RotationAffector::msRotationRangeStartCmd [static]
 

Definition at line 36 of file OgreRotationAffector.cpp.

Referenced by RotationAffector().

RotationAffector::CmdRotationSpeedRangeEnd Ogre::RotationAffector::msRotationSpeedRangeEndCmd [static]
 

Definition at line 35 of file OgreRotationAffector.cpp.

Referenced by RotationAffector().

RotationAffector::CmdRotationSpeedRangeStart Ogre::RotationAffector::msRotationSpeedRangeStartCmd [static]
 

Definition at line 34 of file OgreRotationAffector.cpp.

Referenced by RotationAffector().

String Ogre::ParticleAffector::mType [protected, inherited]
 

Name of the type of affector, MUST be initialised by subclasses.

Definition at line 58 of file OgreParticleAffector.h.

Referenced by Ogre::ColourFaderAffector::ColourFaderAffector(), Ogre::ColourFaderAffector2::ColourFaderAffector2(), Ogre::ColourImageAffector::ColourImageAffector(), Ogre::ColourInterpolatorAffector::ColourInterpolatorAffector(), Ogre::LinearForceAffector::LinearForceAffector(), RotationAffector(), and Ogre::ScaleAffector::ScaleAffector().


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

Copyright © 2002-2003 by The OGRE Team
Last modified Fri May 14 23:24:40 2004