OGRE  2.0
Object-Oriented Graphics Rendering Engine
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups 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:
+ Collaboration 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...
 
virtual 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
 
virtual 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...
 
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...
 
const StringgetType (void) const
 Returns the name of the type of affector. More...
 
void operator delete (void *ptr)
 
void operator delete (void *ptr, void *)
 
void operator delete (void *ptr, const char *, int, const char *)
 
void operator delete[] (void *ptr)
 
void operator delete[] (void *ptr, const char *, int, const char *)
 
void * operator new (size_t sz, const char *file, int line, const char *func)
 operator new, with debug line info More...
 
void * operator new (size_t sz)
 
void * operator new (size_t sz, void *ptr)
 placement operator new More...
 
void * operator new[] (size_t sz, const char *file, int line, const char *func)
 array operator new, with debug line info More...
 
void * operator new[] (size_t sz)
 
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...
 
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...
 

Static Public Member Functions

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...
 

Static Public Attributes

static CmdRotationRangeEnd msRotationRangeEndCmd
 
static CmdRotationRangeStart msRotationRangeStartCmd
 
static CmdRotationSpeedRangeEnd msRotationSpeedRangeEndCmd
 
static CmdRotationSpeedRangeStart msRotationSpeedRangeStartCmd
 

Protected Member Functions

void addBaseParameters (void)
 Internal method for setting up the basic parameter definitions for a subclass. More...
 
bool createParamDictionary (const String &className)
 Internal method for creating a parameter dictionary for the class, if it does not already exist. More...
 

Protected Attributes

ParticleSystemmParent
 
Radian mRotationRangeEnd
 Initial rotation angle of particles (range end) More...
 
Radian mRotationRangeStart
 Initial rotation angle of particles (range start) More...
 
Radian mRotationSpeedRangeEnd
 Initial rotation speed of particles (range end) More...
 
Radian mRotationSpeedRangeStart
 Initial rotation speed of particles (range start) More...
 
String mType
 Name of the type of affector, MUST be initialised by subclasses. 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.

Definition at line 44 of file OgreRotationAffector.h.

Constructor & Destructor Documentation

Ogre::RotationAffector::RotationAffector ( ParticleSystem psys)

Default constructor.

Member Function Documentation

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

See ParticleAffector.

Reimplemented from Ogre::ParticleAffector.

void Ogre::ParticleAffector::addBaseParameters ( void  )
inlineprotectedinherited

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 78 of file OgreParticleAffector.h.

static void Ogre::StringInterface::cleanupDictionary ( )
staticinherited

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.

MaterialManager) initializes.

virtual void Ogre::StringInterface::copyParametersTo ( StringInterface dest) const
inlinevirtualinherited

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
destPointer to object to have it's parameters set the same as this object.

Definition at line 302 of file OgreStringInterface.h.

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

bool Ogre::StringInterface::createParamDictionary ( const String className)
inlineprotectedinherited

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
classNamethe name of the class using the dictionary
Returns
true if a new dictionary was created, false if it was already there

Definition at line 185 of file OgreStringInterface.h.

References OGRE_LOCK_MUTEX.

ParamDictionary* Ogre::StringInterface::getParamDictionary ( void  )
inlineinherited

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 218 of file OgreStringInterface.h.

const ParamDictionary* Ogre::StringInterface::getParamDictionary ( void  ) const
inlineinherited

Definition at line 223 of file OgreStringInterface.h.

virtual String Ogre::StringInterface::getParameter ( const String name) const
inlinevirtualinherited

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
nameThe name of the parameter to get
Returns
String value of parameter, blank if not found

Definition at line 271 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.
const Radian& Ogre::RotationAffector::getRotationRangeEnd ( void  ) const

Gets the maximum rotation of particles to be emitted.

const Radian& Ogre::RotationAffector::getRotationRangeStart ( void  ) const

Gets the minimum rotation of particles to be emitted.

const Radian& Ogre::RotationAffector::getRotationSpeedRangeEnd ( void  ) const

Gets the maximum rotation speed of particles to be emitted.

const Radian& Ogre::RotationAffector::getRotationSpeedRangeStart ( void  ) const

Gets the minimum rotation speed of particles to be emitted.

const String& Ogre::ParticleAffector::getType ( void  ) const
inlineinherited

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 118 of file OgreParticleAffector.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr)
inlineinherited

Definition at line 96 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr,
void *   
)
inlineinherited

Definition at line 102 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr,
const char *  ,
int  ,
const char *   
)
inlineinherited

Definition at line 108 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete[] ( void *  ptr)
inlineinherited

Definition at line 113 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete[] ( void *  ptr,
const char *  ,
int  ,
const char *   
)
inlineinherited

Definition at line 119 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz,
const char *  file,
int  line,
const char *  func 
)
inlineinherited

operator new, with debug line info

Definition at line 68 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz)
inlineinherited

Definition at line 73 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz,
void *  ptr 
)
inlineinherited

placement operator new

Definition at line 79 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new[] ( size_t  sz,
const char *  file,
int  line,
const char *  func 
)
inlineinherited

array operator new, with debug line info

Definition at line 86 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new[] ( size_t  sz)
inlineinherited

Definition at line 91 of file OgreMemoryAllocatedObject.h.

virtual bool Ogre::StringInterface::setParameter ( const String name,
const String value 
)
virtualinherited

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
nameThe name of the parameter to set
valueString 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)

Referenced by Ogre::StringInterface::copyParametersTo().

virtual void Ogre::StringInterface::setParameterList ( const NameValuePairList paramList)
virtualinherited

Generic multiple parameter setting method.

Remarks
Call this method with a list of name / value pairs 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
paramListName/value pair list
void Ogre::RotationAffector::setRotationRangeEnd ( const Radian angle)

Sets the maximum rotation angle of particles to be emitted.

void Ogre::RotationAffector::setRotationRangeStart ( const Radian angle)

Sets the minimum rotation angle of particles to be emitted.

void Ogre::RotationAffector::setRotationSpeedRangeEnd ( const Radian angle)

Sets the maximum rotation speed of particles to be emitted.

void Ogre::RotationAffector::setRotationSpeedRangeStart ( const Radian angle)

Sets the minimum rotation speed of particles to be emitted.

Member Data Documentation

ParticleSystem* Ogre::ParticleAffector::mParent
protectedinherited

Definition at line 80 of file OgreParticleAffector.h.

Radian Ogre::RotationAffector::mRotationRangeEnd
protected

Initial rotation angle of particles (range end)

Definition at line 122 of file OgreRotationAffector.h.

Radian Ogre::RotationAffector::mRotationRangeStart
protected

Initial rotation angle of particles (range start)

Definition at line 120 of file OgreRotationAffector.h.

Radian Ogre::RotationAffector::mRotationSpeedRangeEnd
protected

Initial rotation speed of particles (range end)

Definition at line 118 of file OgreRotationAffector.h.

Radian Ogre::RotationAffector::mRotationSpeedRangeStart
protected

Initial rotation speed of particles (range start)

Definition at line 116 of file OgreRotationAffector.h.

CmdRotationRangeEnd Ogre::RotationAffector::msRotationRangeEndCmd
static

Definition at line 112 of file OgreRotationAffector.h.

CmdRotationRangeStart Ogre::RotationAffector::msRotationRangeStartCmd
static

Definition at line 111 of file OgreRotationAffector.h.

CmdRotationSpeedRangeEnd Ogre::RotationAffector::msRotationSpeedRangeEndCmd
static

Definition at line 110 of file OgreRotationAffector.h.

CmdRotationSpeedRangeStart Ogre::RotationAffector::msRotationSpeedRangeStartCmd
static

Definition at line 109 of file OgreRotationAffector.h.

String Ogre::ParticleAffector::mType
protectedinherited

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

Definition at line 68 of file OgreParticleAffector.h.


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