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

Ogre::LinearForceAffector Class Reference

This class defines a ParticleAffector which applies a linear force to particles in a system. More...

#include <OgreLinearForceAffector.h>

Inheritance diagram for Ogre::LinearForceAffector:

Ogre::ParticleAffector Ogre::StringInterface List of all members.

Public Types

enum  ForceApplication { FA_AVERAGE, FA_ADD }
 Choice of how to apply the force vector to particles. More...


Public Methods

 LinearForceAffector ()
 Default constructor. More...

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

void setForceVector (const Vector3 &force)
 Sets the force vector to apply to the particles in a system. More...

Vector3 getForceVector (void)
 Gets the force vector to apply to the particles in a system. More...

void setForceApplication (ForceApplication fa)
 Sets how the force vector is applied to a particle. More...

ForceApplication getForceApplication (void)
 Retrieves how the force vector is applied to a particle. More...

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

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

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

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

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

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


Static Public Attributes

CmdForceVector msForceVectorCmd
 Command objects. More...

CmdForceApp msForceAppCmd

Protected Methods

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

Vector3 mForceVector
 Force vector. More...

ForceApplication mForceApplication
 How to apply force. More...

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

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


Static Protected Attributes

ParamDictionaryMap msDictionary
 Dictionary of parameters. More...


Detailed Description

This class defines a ParticleAffector which applies a linear force to particles in a system.

Remarks:
This affector (see ParticleAffector) applies a linear force, such as gravity, to a particle system. This force can be applied in 2 ways: by taking the average of the particle's current momentum and the force vector, or by adding the force vector to the current particle's momentum.

The former approach is self-stabilising i.e. once a particle's momentum is equal to the force vector, no further change is made to it's momentum. It also results in a non-linear acceleration of particles. The latter approach is simpler and applies a constant acceleration to particles. However, it is not self-stabilising and can lead to perpetually increasing particle velocities. You choose the approach by calling the setForceApplication method.


Member Enumeration Documentation

enum Ogre::LinearForceAffector::ForceApplication
 

Choice of how to apply the force vector to particles.

Enumeration values:
FA_AVERAGE  Take the average of the force vector and the particle momentum.
FA_ADD  Add the force vector to the particle momentum.


Constructor & Destructor Documentation

Ogre::LinearForceAffector::LinearForceAffector  
 

Default constructor.


Member Function Documentation

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

See ParticleAffector.

Implements Ogre::ParticleAffector.

void Ogre::ParticleAffector::addBaseParameters void    [inline, 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.

virtual void Ogre::StringInterface::copyParametersTo StringInterface   dest [inline, 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.

bool Ogre::StringInterface::createParamDictionary const String   className [inline, 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

LinearForceAffector::ForceApplication Ogre::LinearForceAffector::getForceApplication void   
 

Retrieves how the force vector is applied to a particle.

Parameters:
fa  A member of the ForceApplication enum.

Vector3 Ogre::LinearForceAffector::getForceVector void   
 

Gets the force vector to apply to the particles in a system.

ParamDictionary* Ogre::StringInterface::getParamDictionary void    [inline, 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.

virtual String Ogre::StringInterface::getParameter const String   name [inline, 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

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

Retrieves a list of parameters valid for this object.

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

String Ogre::ParticleAffector::getType void    [inline, 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.

void Ogre::LinearForceAffector::setForceApplication ForceApplication    fa
 

Sets how the force vector is applied to a particle.

Remarks:
The default is FA_ADD.
Parameters:
fa  A member of the ForceApplication enum.

void Ogre::LinearForceAffector::setForceVector const Vector3   force
 

Sets the force vector to apply to the particles in a system.

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)


Member Data Documentation

ForceApplication Ogre::LinearForceAffector::mForceApplication [protected]
 

How to apply force.

Vector3 Ogre::LinearForceAffector::mForceVector [protected]
 

Force vector.

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

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

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

Dictionary of parameters.

LinearForceAffector::CmdForceApp Ogre::LinearForceAffector::msForceAppCmd [static]
 

LinearForceAffector::CmdForceVector Ogre::LinearForceAffector::msForceVectorCmd [static]
 

Command objects.

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

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

Copyright © 2002 by The OGRE Team