<html>
<head>
<title>Ogre::LinearForceAffector class Reference - OGRE Documentation</title> <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<link type="text/css" rel="stylesheet" href="style.css">
</head>
<body>
<!-- Generated by Doxygen 1.2.16 -->
<center>
<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="namespaces.html">Namespace List</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="namespacemembers.html">Namespace Members</a> <a class="qindex" href="functions.html">Compound Members</a> <a class="qindex" href="globals.html">File Members</a> <a class="qindex" href="pages.html">Related Pages</a> </center>
<hr><h1>Ogre::LinearForceAffector Class Reference</h1>This class defines a <a class="el" href="classOgre_1_1ParticleAffector.html">ParticleAffector</a> which applies a linear force to particles in a system.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="OgreLinearForceAffector_8h-source.html">OgreLinearForceAffector.h</a>></code>
<p>
Inheritance diagram for Ogre::LinearForceAffector:<p><center><img src="classOgre_1_1LinearForceAffector__inherit__graph.png" border="0" usemap="#Ogre_1_1LinearForceAffector__inherit__map" alt="Inheritance graph"></center>
<map name="Ogre_1_1LinearForceAffector__inherit__map">
<area href="classOgre_1_1ParticleAffector.html" shape="rect" coords="20,105,156,86" alt="">
<area href="classOgre_1_1StringInterface.html" shape="rect" coords="21,36,155,17" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center>Collaboration diagram for Ogre::LinearForceAffector:<p><center><img src="classOgre_1_1LinearForceAffector__coll__graph.png" border="0" usemap="#Ogre_1_1LinearForceAffector__coll__map" alt="Collaboration graph"></center>
<map name="Ogre_1_1LinearForceAffector__coll__map">
<area href="classOgre_1_1ParticleAffector.html" shape="rect" coords="84,28,220,9" alt="">
<area href="classOgre_1_1Vector3.html" shape="rect" coords="105,173,199,154" alt="">
<area href="classOgre_1_1LinearForceAffector_1_1CmdForceVector.html" shape="rect" coords="17,228,287,209" alt="">
<area href="classOgre_1_1LinearForceAffector_1_1CmdForceApp.html" shape="rect" coords="25,296,279,277" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classOgre_1_1LinearForceAffector-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
<tr><td colspan=2><br><h2>Public Types</h2></td></tr>
<tr><td nowrap align=right valign=top>enum </td><td valign=bottom><a class="el" href="classOgre_1_1LinearForceAffector.html#Ogre_1_1LinearForceAffectors2">ForceApplication</a> { <a class="el" href="classOgre_1_1LinearForceAffector.html#Ogre_1_1LinearForceAffectors2Ogre_1_1LinearForceAffectors0">FA_AVERAGE</a>,
<a class="el" href="classOgre_1_1LinearForceAffector.html#Ogre_1_1LinearForceAffectors2Ogre_1_1LinearForceAffectors1">FA_ADD</a>
}</td></tr>
<tr><td> </td><td><font size=-1><em>Choice of how to apply the force vector to particles.</em> <a href="#Ogre_1_1LinearForceAffectors2">More...</a><em></em></font><br><br></td></tr>
<tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classOgre_1_1LinearForceAffector.html#Ogre_1_1LinearForceAffectora0">LinearForceAffector</a> ()</td></tr>
<tr><td> </td><td><font size=-1><em>Default constructor.</em> <a href="#Ogre_1_1LinearForceAffectora0"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classOgre_1_1LinearForceAffector.html#Ogre_1_1LinearForceAffectora1">_affectParticles</a> (<a class="el" href="classOgre_1_1ParticleSystem.html">ParticleSystem</a> *pSystem, <a class="el" href="namespaceOgre.html#a349">Real</a> timeElapsed)</td></tr>
<tr><td> </td><td><font size=-1><em>See <a class="el" href="classOgre_1_1ParticleAffector.html">ParticleAffector</a>.</em> <a href="#Ogre_1_1LinearForceAffectora1"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classOgre_1_1LinearForceAffector.html#Ogre_1_1LinearForceAffectora2">setForceVector</a> (const <a class="el" href="classOgre_1_1Vector3.html">Vector3</a> &force)</td></tr>
<tr><td> </td><td><font size=-1><em>Sets the force vector to apply to the particles in a system.</em> <a href="#Ogre_1_1LinearForceAffectora2"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="classOgre_1_1Vector3.html">Vector3</a> </td><td valign=bottom><a class="el" href="classOgre_1_1LinearForceAffector.html#Ogre_1_1LinearForceAffectora3">getForceVector</a> (void) const</td></tr>
<tr><td> </td><td><font size=-1><em>Gets the force vector to apply to the particles in a system.</em> <a href="#Ogre_1_1LinearForceAffectora3"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classOgre_1_1LinearForceAffector.html#Ogre_1_1LinearForceAffectora4">setForceApplication</a> (<a class="el" href="classOgre_1_1LinearForceAffector.html#Ogre_1_1LinearForceAffectors2">ForceApplication</a> fa)</td></tr>
<tr><td> </td><td><font size=-1><em>Sets how the force vector is applied to a particle.</em> <a href="#Ogre_1_1LinearForceAffectora4"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="classOgre_1_1LinearForceAffector.html#Ogre_1_1LinearForceAffectors2">ForceApplication</a> </td><td valign=bottom><a class="el" href="classOgre_1_1LinearForceAffector.html#Ogre_1_1LinearForceAffectora5">getForceApplication</a> (void) const</td></tr>
<tr><td> </td><td><font size=-1><em>Retrieves how the force vector is applied to a particle.</em> <a href="#Ogre_1_1LinearForceAffectora5"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classOgre_1_1LinearForceAffector.html#Ogre_1_1ScaleAffectora4">_initParticle</a> (<a class="el" href="classOgre_1_1Particle.html">Particle</a> *pParticle)</td></tr>
<tr><td> </td><td><font size=-1><em>Method called to allow the affector to initialize all newly created particles in the system.</em> <a href="#Ogre_1_1ScaleAffectora4"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="classOgre_1_1String.html">String</a> </td><td valign=bottom><a class="el" href="classOgre_1_1LinearForceAffector.html#Ogre_1_1ScaleAffectora5">getType</a> (void) const</td></tr>
<tr><td> </td><td><font size=-1><em>Returns the name of the type of affector.</em> <a href="#Ogre_1_1ScaleAffectora5"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="classOgre_1_1ParamDictionary.html">ParamDictionary</a> * </td><td valign=bottom><a class="el" href="classOgre_1_1LinearForceAffector.html#Ogre_1_1TTYGuiElementa79">getParamDictionary</a> (void)</td></tr>
<tr><td> </td><td><font size=-1><em>Retrieves the parameter dictionary for this class.</em> <a href="#Ogre_1_1TTYGuiElementa79"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>const <a class="el" href="classOgre_1_1ParamDictionary.html">ParamDictionary</a> * </td><td valign=bottom><a class="el" href="classOgre_1_1LinearForceAffector.html#Ogre_1_1TTYGuiElementa80">getParamDictionary</a> (void) const</td></tr>
<tr><td nowrap align=right valign=top>const <a class="el" href="namespaceOgre.html#a419">ParameterList</a> & </td><td valign=bottom><a class="el" href="classOgre_1_1LinearForceAffector.html#Ogre_1_1TTYGuiElementa81">getParameters</a> (void) const</td></tr>
<tr><td> </td><td><font size=-1><em>Retrieves a list of parameters valid for this object.</em> <a href="#Ogre_1_1TTYGuiElementa81"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>virtual bool </td><td valign=bottom><a class="el" href="classOgre_1_1LinearForceAffector.html#Ogre_1_1TTYGuiElementa82">setParameter</a> (const <a class="el" href="classOgre_1_1String.html">String</a> &name, const <a class="el" href="classOgre_1_1String.html">String</a> &value)</td></tr>
<tr><td> </td><td><font size=-1><em>Generic parameter setting method.</em> <a href="#Ogre_1_1TTYGuiElementa82"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>virtual <a class="el" href="classOgre_1_1String.html">String</a> </td><td valign=bottom><a class="el" href="classOgre_1_1LinearForceAffector.html#Ogre_1_1TTYGuiElementa83">getParameter</a> (const <a class="el" href="classOgre_1_1String.html">String</a> &name) const</td></tr>
<tr><td> </td><td><font size=-1><em>Generic parameter retrieval method.</em> <a href="#Ogre_1_1TTYGuiElementa83"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classOgre_1_1LinearForceAffector.html#Ogre_1_1TTYGuiElementa84">copyParametersTo</a> (<a class="el" href="classOgre_1_1StringInterface.html">StringInterface</a> *dest) const</td></tr>
<tr><td> </td><td><font size=-1><em>Method for copying this object's parameters to another object.</em> <a href="#Ogre_1_1TTYGuiElementa84"></a><em></em></font><br><br></td></tr>
<tr><td colspan=2><br><h2>Static Public Attributes</h2></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="classOgre_1_1LinearForceAffector_1_1CmdForceVector.html">CmdForceVector</a> </td><td valign=bottom><a class="el" href="classOgre_1_1LinearForceAffector.html#Ogre_1_1LinearForceAffectorp0">msForceVectorCmd</a></td></tr>
<tr><td> </td><td><font size=-1><em>Command objects.</em> <a href="#Ogre_1_1LinearForceAffectorp0"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="classOgre_1_1LinearForceAffector_1_1CmdForceApp.html">CmdForceApp</a> </td><td valign=bottom><a class="el" href="classOgre_1_1LinearForceAffector.html#Ogre_1_1LinearForceAffectorp1">msForceAppCmd</a></td></tr>
<tr><td colspan=2><br><h2>Protected Methods</h2></td></tr>
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classOgre_1_1LinearForceAffector.html#Ogre_1_1ScaleAffectorb0">addBaseParameters</a> (void)</td></tr>
<tr><td> </td><td><font size=-1><em>Internal method for setting up the basic parameter definitions for a subclass.</em> <a href="#Ogre_1_1ScaleAffectorb0"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classOgre_1_1LinearForceAffector.html#Ogre_1_1TTYGuiElementb10">createParamDictionary</a> (const <a class="el" href="classOgre_1_1String.html">String</a> &className)</td></tr>
<tr><td> </td><td><font size=-1><em>Internal method for creating a parameter dictionary for the class, if it does not already exist.</em> <a href="#Ogre_1_1TTYGuiElementb10"></a><em></em></font><br><br></td></tr>
<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="classOgre_1_1Vector3.html">Vector3</a> </td><td valign=bottom><a class="el" href="classOgre_1_1LinearForceAffector.html#Ogre_1_1LinearForceAffectorn0">mForceVector</a></td></tr>
<tr><td> </td><td><font size=-1><em>Force vector.</em> <a href="#Ogre_1_1LinearForceAffectorn0"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="classOgre_1_1LinearForceAffector.html#Ogre_1_1LinearForceAffectors2">ForceApplication</a> </td><td valign=bottom><a class="el" href="classOgre_1_1LinearForceAffector.html#Ogre_1_1LinearForceAffectorn1">mForceApplication</a></td></tr>
<tr><td> </td><td><font size=-1><em>How to apply force.</em> <a href="#Ogre_1_1LinearForceAffectorn1"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="classOgre_1_1String.html">String</a> </td><td valign=bottom><a class="el" href="classOgre_1_1LinearForceAffector.html#Ogre_1_1ScaleAffectorn1">mType</a></td></tr>
<tr><td> </td><td><font size=-1><em>Name of the type of affector, MUST be initialised by subclasses.</em> <a href="#Ogre_1_1ScaleAffectorn1"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="classOgre_1_1String.html">String</a> </td><td valign=bottom><a class="el" href="classOgre_1_1LinearForceAffector.html#Ogre_1_1TTYGuiElementn48">mParamDictName</a></td></tr>
<tr><td> </td><td><font size=-1><em>Class name for this instance to be used as a lookup (must be initialised by subclasses).</em> <a href="#Ogre_1_1TTYGuiElementn48"></a><em></em></font><br><br></td></tr>
<tr><td colspan=2><br><h2>Static Protected Attributes</h2></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a421">ParamDictionaryMap</a> </td><td valign=bottom><a class="el" href="classOgre_1_1LinearForceAffector.html#Ogre_1_1TTYGuiElementq19">msDictionary</a></td></tr>
<tr><td> </td><td><font size=-1><em>Dictionary of parameters.</em> <a href="#Ogre_1_1TTYGuiElementq19"></a><em></em></font><br><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
This class defines a <a class="el" href="classOgre_1_1ParticleAffector.html">ParticleAffector</a> which applies a linear force to particles in a system.
<p>
<dl compact><dt><b>
Remarks: </b><dd>
This affector (see <a class="el" href="classOgre_1_1ParticleAffector.html">ParticleAffector</a>) 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.
<p>
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. </dl>
<p>
<p>
Definition at line <a class="el" href="OgreLinearForceAffector_8h-source.html#l00048">48</a> of file <a class="el" href="OgreLinearForceAffector_8h-source.html">OgreLinearForceAffector.h</a>.<hr><h2>Member Enumeration Documentation</h2>
<a name="Ogre_1_1LinearForceAffectors2" doxytag="Ogre::LinearForceAffector::ForceApplication"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> enum Ogre::LinearForceAffector::ForceApplication
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Choice of how to apply the force vector to particles.
<p>
<dl compact><dt><b>
Enumeration values:</b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em><a name="Ogre_1_1LinearForceAffectors2Ogre_1_1LinearForceAffectors0" doxytag="FA_AVERAGE"></a><em>FA_AVERAGE</em></em> </td><td>
Take the average of the force vector and the particle momentum.</td></tr>
<tr><td valign=top><em><a name="Ogre_1_1LinearForceAffectors2Ogre_1_1LinearForceAffectors1" doxytag="FA_ADD"></a><em>FA_ADD</em></em> </td><td>
Add the force vector to the particle momentum.</td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="OgreLinearForceAffector_8h-source.html#l00067">67</a> of file <a class="el" href="OgreLinearForceAffector_8h-source.html">OgreLinearForceAffector.h</a>. </td>
</tr>
</table>
<hr><h2>Constructor & Destructor Documentation</h2>
<a name="Ogre_1_1LinearForceAffectora0" doxytag="Ogre::LinearForceAffector::LinearForceAffector"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> Ogre::LinearForceAffector::LinearForceAffector </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Default constructor.
<p>
<p>
Definition at line <a class="el" href="OgreLinearForceAffector_8cpp-source.html#l00039">39</a> of file <a class="el" href="OgreLinearForceAffector_8cpp-source.html">OgreLinearForceAffector.cpp</a>.
<p>
References <a class="el" href="OgreParticleAffector_8h-source.html#l00068">Ogre::ParticleAffector::addBaseParameters</a>(), <a class="el" href="OgreStringInterface_8h-source.html#l00120">Ogre::ParamDictionary::addParameter</a>(), <a class="el" href="OgreStringInterface_8h-source.html#l00169">Ogre::StringInterface::createParamDictionary</a>(), <a class="el" href="classOgre_1_1LinearForceAffector.html#Ogre_1_1LinearForceAffectors2Ogre_1_1LinearForceAffectors1">FA_ADD</a>, <a class="el" href="OgreStringInterface_8h-source.html#l00193">Ogre::StringInterface::getParamDictionary</a>(), <a class="el" href="OgreLinearForceAffector_8h-source.html#l00108">mForceApplication</a>, <a class="el" href="OgreLinearForceAffector_8h-source.html#l00105">mForceVector</a>, <a class="el" href="OgreLinearForceAffector_8cpp-source.html#l00035">msForceAppCmd</a>, <a class="el" href="OgreLinearForceAffector_8cpp-source.html#l00034">msForceVectorCmd</a>, <a class="el" href="OgreParticleAffector_8h-source.html#l00058">Ogre::ParticleAffector::mType</a>, <a class="el" href="namespaceOgre.html#a646a425">Ogre::PT_UNSIGNED_INT</a>, <a class="el" href="namespaceOgre.html#a646a431">Ogre::PT_VECTOR3</a>, <a class="el" href="OgreVector3_8h-source.html#l00047">Ogre::Vector3::x</a>, <a class="el" href="OgreVector3_8h-source.html#l00047">Ogre::Vector3::y</a>, and <a class="el" href="OgreVector3_8h-source.html#l00047">Ogre::Vector3::z</a>. </td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a name="Ogre_1_1LinearForceAffectora1" doxytag="Ogre::LinearForceAffector::_affectParticles"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void Ogre::LinearForceAffector::_affectParticles </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1ParticleSystem.html">ParticleSystem</a> * </td>
<td class="mdname" nowrap> <em>pSystem</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap><a class="el" href="namespaceOgre.html#a349">Real</a> </td>
<td class="mdname" nowrap> <em>timeElapsed</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
See <a class="el" href="classOgre_1_1ParticleAffector.html">ParticleAffector</a>.
<p>
<p>
Implements <a class="el" href="classOgre_1_1ParticleAffector.html#Ogre_1_1ParticleAffectora2">Ogre::ParticleAffector</a>.
<p>
Definition at line <a class="el" href="OgreLinearForceAffector_8cpp-source.html#l00065">65</a> of file <a class="el" href="OgreLinearForceAffector_8cpp-source.html">OgreLinearForceAffector.cpp</a>.
<p>
References <a class="el" href="OgreParticleSystem_8cpp-source.html#l00375">Ogre::ParticleSystem::_getIterator</a>(), <a class="el" href="OgreParticleIterator_8cpp-source.html#l00038">Ogre::ParticleIterator::end</a>(), <a class="el" href="classOgre_1_1LinearForceAffector.html#Ogre_1_1LinearForceAffectors2Ogre_1_1LinearForceAffectors1">FA_ADD</a>, <a class="el" href="OgreParticleIterator_8cpp-source.html#l00043">Ogre::ParticleIterator::getNext</a>(), <a class="el" href="OgreBillboard_8h-source.html#l00069">Ogre::Billboard::mDirection</a>, <a class="el" href="OgreLinearForceAffector_8h-source.html#l00108">mForceApplication</a>, <a class="el" href="OgreLinearForceAffector_8h-source.html#l00105">mForceVector</a>, and <a class="el" href="OgrePrerequisites_8h-source.html#l00086">Ogre::Real</a>. </td>
</tr>
</table>
<a name="Ogre_1_1ScaleAffectora4" doxytag="Ogre::LinearForceAffector::_initParticle"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> virtual void Ogre::ParticleAffector::_initParticle </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1Particle.html">Particle</a> * </td>
<td class="mdname1" valign="top" nowrap> <em>pParticle</em> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap><code> [virtual, inherited]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Method called to allow the affector to initialize all newly created particles in the system.
<p>
<dl compact><dt><b>
Remarks: </b><dd>
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. </dl><dl compact><dt><b>
Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>pParticle</em> </td><td>
Pointer to a <a class="el" href="classOgre_1_1Particle.html">Particle</a> to initialize. </td></tr>
</table>
</dl>
<p>
Reimplemented in <a class="el" href="classOgre_1_1ColourImageAffector.html#Ogre_1_1ColourImageAffectora1">Ogre::ColourImageAffector</a>, and <a class="el" href="classOgre_1_1RotationAffector.html#Ogre_1_1RotationAffectora1">Ogre::RotationAffector</a>.
<p>
Definition at line <a class="el" href="OgreParticleAffector_8h-source.html#l00081">81</a> of file <a class="el" href="OgreParticleAffector_8h-source.html">OgreParticleAffector.h</a>. </td>
</tr>
</table>
<a name="Ogre_1_1ScaleAffectorb0" doxytag="Ogre::LinearForceAffector::addBaseParameters"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void Ogre::ParticleAffector::addBaseParameters </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap><code> [protected, inherited]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Internal method for setting up the basic parameter definitions for a subclass.
<p>
<dl compact><dt><b>
Remarks: </b><dd>
Because <a class="el" href="classOgre_1_1StringInterface.html">StringInterface</a> 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.
<p>
The subclass must have called it's own createParamDictionary before calling this method. </dl>
<p>
Definition at line <a class="el" href="OgreParticleAffector_8h-source.html#l00068">68</a> of file <a class="el" href="OgreParticleAffector_8h-source.html">OgreParticleAffector.h</a>.
<p>
Referenced by <a class="el" href="OgreLinearForceAffector_8cpp-source.html#l00039">LinearForceAffector</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1TTYGuiElementa84" doxytag="Ogre::LinearForceAffector::copyParametersTo"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> virtual void Ogre::StringInterface::copyParametersTo </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1StringInterface.html">StringInterface</a> * </td>
<td class="mdname1" valign="top" nowrap> <em>dest</em> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap> const<code> [virtual, inherited]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Method for copying this object's parameters to another object.
<p>
<dl compact><dt><b>
Remarks: </b><dd>
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 <a class="el" href="classOgre_1_1String.html">String</a> manipulation involved, this should not be regarded as an efficient process and should be saved for times outside of the rendering loop.
<p>
Any unrecognised parameters will be ignored as with setParameter method. </dl><dl compact><dt><b>
Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>dest</em> </td><td>
Pointer to object to have it's parameters set the same as this object. </td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="OgreStringInterface_8h-source.html#l00293">293</a> of file <a class="el" href="OgreStringInterface_8h-source.html">OgreStringInterface.h</a>.
<p>
References <a class="el" href="OgreStringInterface_8h-source.html#l00081">Ogre::ParamDictionary::mParamDefs</a>, and <a class="el" href="OgreStringInterface_8cpp-source.html#l00033">Ogre::StringInterface::setParameter</a>().
<p>
Referenced by <a class="el" href="OgreGuiElement_8cpp-source.html#l00590">Ogre::GuiElement::copyFromTemplate</a>(), <a class="el" href="OgreGuiContainer_8cpp-source.html#l00244">Ogre::GuiContainer::copyFromTemplate</a>(), and <a class="el" href="OgreParticleSystem_8cpp-source.html#l00170">Ogre::ParticleSystem::operator=</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1TTYGuiElementb10" doxytag="Ogre::LinearForceAffector::createParamDictionary"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> bool Ogre::StringInterface::createParamDictionary </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="classOgre_1_1String.html">String</a> & </td>
<td class="mdname1" valign="top" nowrap> <em>className</em> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap><code> [protected, inherited]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Internal method for creating a parameter dictionary for the class, if it does not already exist.
<p>
<dl compact><dt><b>
Remarks: </b><dd>
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). </dl><dl compact><dt><b>
Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>className</em> </td><td>
the name of the class using the dictionary </td></tr>
</table>
</dl><dl compact><dt><b>
Returns: </b><dd>
true if a new dictionary was created, false if it was already there </dl>
<p>
Definition at line <a class="el" href="OgreStringInterface_8h-source.html#l00169">169</a> of file <a class="el" href="OgreStringInterface_8h-source.html">OgreStringInterface.h</a>.
<p>
Referenced by <a class="el" href="OgreBorderButtonGuiElement_8cpp-source.html#l00044">Ogre::BorderButtonGuiElement::BorderButtonGuiElement</a>(), <a class="el" href="OgreBorderPanelGuiElement_8cpp-source.html#l00055">Ogre::BorderPanelGuiElement::BorderPanelGuiElement</a>(), <a class="el" href="OgreButtonGuiElement_8cpp-source.html#l00044">Ogre::ButtonGuiElement::ButtonGuiElement</a>(), <a class="el" href="OgreCgProgram_8cpp-source.html#l00216">Ogre::CgProgram::CgProgram</a>(), <a class="el" href="OgreColourFaderAffector_8cpp-source.html#l00040">Ogre::ColourFaderAffector::ColourFaderAffector</a>(), <a class="el" href="OgreColourFaderAffector2_8cpp-source.html#l00050">Ogre::ColourFaderAffector2::ColourFaderAffector2</a>(), <a class="el" href="OgreColourImageAffector_8cpp-source.html#l00038">Ogre::ColourImageAffector::ColourImageAffector</a>(), <a class="el" href="OgreColourInterpolatorAffector_8cpp-source.html#l00038">Ogre::ColourInterpolatorAffector::ColourInterpolatorAffector</a>(), <a class="el" href="OgreCursorGuiElement_8cpp-source.html#l00041">Ogre::CursorGuiElement::CursorGuiElement</a>(), <a class="el" href="OgreD3D9HLSLProgram_8cpp-source.html#l00167">Ogre::D3D9HLSLProgram::D3D9HLSLProgram</a>(), <a class="el" href="OgreAreaEmitter_8cpp-source.html#l00041">Ogre::AreaEmitter::initDefaults</a>(), <a class="el" href="OgreParticleSystem_8cpp-source.html#l00447">Ogre::ParticleSystem::initParameters</a>(), <a class="el" href="OgreLinearForceAffector_8cpp-source.html#l00039">LinearForceAffector</a>(), <a class="el" href="OgreListGuiElement_8cpp-source.html#l00045">Ogre::ListGuiElement::ListGuiElement</a>(), <a class="el" href="OgrePanelGuiElement_8cpp-source.html#l00044">Ogre::PanelGuiElement::PanelGuiElement</a>(), <a class="el" href="OgrePointEmitter_8cpp-source.html#l00033">Ogre::PointEmitter::PointEmitter</a>(), <a class="el" href="OgrePopupMenuGuiElement_8cpp-source.html#l00043">Ogre::PopupMenuGuiElement::PopupMenuGuiElement</a>(), <a class="el" href="OgreRotationAffector_8cpp-source.html#l00040">Ogre::RotationAffector::RotationAffector</a>(), <a class="el" href="OgreScaleAffector_8cpp-source.html#l00037">Ogre::ScaleAffector::ScaleAffector</a>(), <a class="el" href="OgreScrollBarGuiElement_8cpp-source.html#l00040">Ogre::ScrollBarGuiElement::ScrollBarGuiElement</a>(), <a class="el" href="OgreTextAreaGuiElement_8cpp-source.html#l00050">Ogre::TextAreaGuiElement::TextAreaGuiElement</a>(), <a class="el" href="OgreTextBoxGuiElement_8cpp-source.html#l00039">Ogre::TextBoxGuiElement::TextBoxGuiElement</a>(), and <a class="el" href="OgreTTYGuiElement_8cpp-source.html#l00052">Ogre::TTYGuiElement::TTYGuiElement</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1LinearForceAffectora5" doxytag="Ogre::LinearForceAffector::getForceApplication"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1LinearForceAffector.html#Ogre_1_1LinearForceAffectors2">LinearForceAffector::ForceApplication</a> Ogre::LinearForceAffector::getForceApplication </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Retrieves how the force vector is applied to a particle.
<p>
<dl compact><dt><b>
Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>fa</em> </td><td>
A member of the ForceApplication enum. </td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="OgreLinearForceAffector_8cpp-source.html#l00109">109</a> of file <a class="el" href="OgreLinearForceAffector_8cpp-source.html">OgreLinearForceAffector.cpp</a>.
<p>
References <a class="el" href="OgreLinearForceAffector_8h-source.html#l00108">mForceApplication</a>. </td>
</tr>
</table>
<a name="Ogre_1_1LinearForceAffectora3" doxytag="Ogre::LinearForceAffector::getForceVector"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1Vector3.html">Vector3</a> Ogre::LinearForceAffector::getForceVector </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Gets the force vector to apply to the particles in a system.
<p>
<p>
Definition at line <a class="el" href="OgreLinearForceAffector_8cpp-source.html#l00104">104</a> of file <a class="el" href="OgreLinearForceAffector_8cpp-source.html">OgreLinearForceAffector.cpp</a>.
<p>
References <a class="el" href="OgreLinearForceAffector_8h-source.html#l00105">mForceVector</a>.
<p>
Referenced by <a class="el" href="OgreLinearForceAffector_8cpp-source.html#l00119">Ogre::LinearForceAffector::CmdForceVector::doGet</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1TTYGuiElementa80" doxytag="Ogre::LinearForceAffector::getParamDictionary"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> const <a class="el" href="classOgre_1_1ParamDictionary.html">ParamDictionary</a>* Ogre::StringInterface::getParamDictionary </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap> const<code> [inherited]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<p>
Definition at line <a class="el" href="OgreStringInterface_8h-source.html#l00206">206</a> of file <a class="el" href="OgreStringInterface_8h-source.html">OgreStringInterface.h</a>. </td>
</tr>
</table>
<a name="Ogre_1_1TTYGuiElementa79" doxytag="Ogre::LinearForceAffector::getParamDictionary"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1ParamDictionary.html">ParamDictionary</a>* Ogre::StringInterface::getParamDictionary </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap><code> [inherited]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Retrieves the parameter dictionary for this class.
<p>
<dl compact><dt><b>
Remarks: </b><dd>
Only valid to call this after createParamDictionary. </dl><dl compact><dt><b>
Returns: </b><dd>
Pointer to <a class="el" href="classOgre_1_1ParamDictionary.html">ParamDictionary</a> shared by all instances of this class which you can add parameters to, retrieve parameters etc. </dl>
<p>
Definition at line <a class="el" href="OgreStringInterface_8h-source.html#l00193">193</a> of file <a class="el" href="OgreStringInterface_8h-source.html">OgreStringInterface.h</a>.
<p>
Referenced by <a class="el" href="OgreTTYGuiElement_8cpp-source.html#l00671">Ogre::TTYGuiElement::addBaseParameters</a>(), <a class="el" href="OgreTextBoxGuiElement_8cpp-source.html#l00064">Ogre::TextBoxGuiElement::addBaseParameters</a>(), <a class="el" href="OgreTextAreaGuiElement_8cpp-source.html#l00414">Ogre::TextAreaGuiElement::addBaseParameters</a>(), <a class="el" href="OgreScrollBarGuiElement_8cpp-source.html#l00059">Ogre::ScrollBarGuiElement::addBaseParameters</a>(), <a class="el" href="OgrePopupMenuGuiElement_8cpp-source.html#l00074">Ogre::PopupMenuGuiElement::addBaseParameters</a>(), <a class="el" href="OgreParticleEmitter_8cpp-source.html#l00273">Ogre::ParticleEmitter::addBaseParameters</a>(), <a class="el" href="OgrePanelGuiElement_8cpp-source.html#l00303">Ogre::PanelGuiElement::addBaseParameters</a>(), <a class="el" href="OgreListGuiElement_8cpp-source.html#l00071">Ogre::ListGuiElement::addBaseParameters</a>(), <a class="el" href="OgreGuiElement_8cpp-source.html#l00419">Ogre::GuiElement::addBaseParameters</a>(), <a class="el" href="OgreCursorGuiElement_8cpp-source.html#l00108">Ogre::CursorGuiElement::addBaseParameters</a>(), <a class="el" href="OgreButtonGuiElement_8cpp-source.html#l00159">Ogre::ButtonGuiElement::addBaseParameters</a>(), <a class="el" href="OgreBorderPanelGuiElement_8cpp-source.html#l00163">Ogre::BorderPanelGuiElement::addBaseParameters</a>(), <a class="el" href="OgreBorderButtonGuiElement_8cpp-source.html#l00135">Ogre::BorderButtonGuiElement::addBaseParameters</a>(), <a class="el" href="OgreCgProgram_8cpp-source.html#l00216">Ogre::CgProgram::CgProgram</a>(), <a class="el" href="OgreColourFaderAffector_8cpp-source.html#l00040">Ogre::ColourFaderAffector::ColourFaderAffector</a>(), <a class="el" href="OgreColourFaderAffector2_8cpp-source.html#l00050">Ogre::ColourFaderAffector2::ColourFaderAffector2</a>(), <a class="el" href="OgreColourImageAffector_8cpp-source.html#l00038">Ogre::ColourImageAffector::ColourImageAffector</a>(), <a class="el" href="OgreColourInterpolatorAffector_8cpp-source.html#l00038">Ogre::ColourInterpolatorAffector::ColourInterpolatorAffector</a>(), <a class="el" href="OgreD3D9HLSLProgram_8cpp-source.html#l00167">Ogre::D3D9HLSLProgram::D3D9HLSLProgram</a>(), <a class="el" href="OgreHollowEllipsoidEmitter_8cpp-source.html#l00048">Ogre::HollowEllipsoidEmitter::HollowEllipsoidEmitter</a>(), <a class="el" href="OgreAreaEmitter_8cpp-source.html#l00041">Ogre::AreaEmitter::initDefaults</a>(), <a class="el" href="OgreParticleSystem_8cpp-source.html#l00447">Ogre::ParticleSystem::initParameters</a>(), <a class="el" href="OgreLinearForceAffector_8cpp-source.html#l00039">LinearForceAffector</a>(), <a class="el" href="OgreRingEmitter_8cpp-source.html#l00040">Ogre::RingEmitter::RingEmitter</a>(), <a class="el" href="OgreRotationAffector_8cpp-source.html#l00040">Ogre::RotationAffector::RotationAffector</a>(), <a class="el" href="OgreScaleAffector_8cpp-source.html#l00037">Ogre::ScaleAffector::ScaleAffector</a>(), and <a class="el" href="OgreStringInterface_8cpp-source.html#l00033">Ogre::StringInterface::setParameter</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1TTYGuiElementa83" doxytag="Ogre::LinearForceAffector::getParameter"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> virtual <a class="el" href="classOgre_1_1String.html">String</a> Ogre::StringInterface::getParameter </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="classOgre_1_1String.html">String</a> & </td>
<td class="mdname1" valign="top" nowrap> <em>name</em> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap> const<code> [virtual, inherited]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Generic parameter retrieval method.
<p>
<dl compact><dt><b>
Remarks: </b><dd>
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 <a class="el" href="classOgre_1_1StringConverter.html">StringConverter</a> to convert this string back into a native type. </dl><dl compact><dt><b>
Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>name</em> </td><td>
The name of the parameter to get </td></tr>
</table>
</dl><dl compact><dt><b>
Returns: </b><dd>
<a class="el" href="classOgre_1_1String.html">String</a> value of parameter, blank if not found </dl>
<p>
Definition at line <a class="el" href="OgreStringInterface_8h-source.html#l00262">262</a> of file <a class="el" href="OgreStringInterface_8h-source.html">OgreStringInterface.h</a>.
<p>
References <a class="el" href="classOgre_1_1ParamCommand.html#Ogre_1_1ParamCommanda0">Ogre::ParamCommand::doGet</a>(), and <a class="el" href="OgreStringInterface_8h-source.html#l00087">Ogre::ParamDictionary::getParamCommand</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1TTYGuiElementa81" doxytag="Ogre::LinearForceAffector::getParameters"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> const <a class="el" href="namespaceOgre.html#a419">ParameterList</a>& Ogre::StringInterface::getParameters </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap> const<code> [inherited]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Retrieves a list of parameters valid for this object.
<p>
<dl compact><dt><b>
Returns: </b><dd>
A reference to a static list of <a class="el" href="classOgre_1_1ParameterDef.html">ParameterDef</a> objects. </dl>
<p>
Definition at line <a class="el" href="OgreStringInterface_8h-source.html#l00224">224</a> of file <a class="el" href="OgreStringInterface_8h-source.html">OgreStringInterface.h</a>.
<p>
References <a class="el" href="OgreStringInterface_8h-source.html#l00130">Ogre::ParamDictionary::getParameters</a>(), and <a class="el" href="OgreStringInterface_8h-source.html#l00064">Ogre::ParameterList</a>. </td>
</tr>
</table>
<a name="Ogre_1_1ScaleAffectora5" doxytag="Ogre::LinearForceAffector::getType"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1String.html">String</a> Ogre::ParticleAffector::getType </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap> const<code> [inherited]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Returns the name of the type of affector.
<p>
<dl compact><dt><b>
Remarks: </b><dd>
This property is useful for determining the type of affector procedurally so another can be created. </dl>
<p>
Definition at line <a class="el" href="OgreParticleAffector_8h-source.html#l00100">100</a> of file <a class="el" href="OgreParticleAffector_8h-source.html">OgreParticleAffector.h</a>.
<p>
Referenced by <a class="el" href="OgreParticleSystemManager_8cpp-source.html#l00300">Ogre::ParticleSystemManager::_destroyAffector</a>(), <a class="el" href="OgreParticleSystem_8cpp-source.html#l00170">Ogre::ParticleSystem::operator=</a>(), and <a class="el" href="OgreParticleSystemManager_8cpp-source.html#l00438">Ogre::ParticleSystemManager::parseAffectorAttrib</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1LinearForceAffectora4" doxytag="Ogre::LinearForceAffector::setForceApplication"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void Ogre::LinearForceAffector::setForceApplication </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1LinearForceAffector.html#Ogre_1_1LinearForceAffectors2">ForceApplication</a> </td>
<td class="mdname1" valign="top" nowrap> <em>fa</em> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Sets how the force vector is applied to a particle.
<p>
<dl compact><dt><b>
Remarks: </b><dd>
The default is FA_ADD. </dl><dl compact><dt><b>
Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>fa</em> </td><td>
A member of the ForceApplication enum. </td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="OgreLinearForceAffector_8cpp-source.html#l00099">99</a> of file <a class="el" href="OgreLinearForceAffector_8cpp-source.html">OgreLinearForceAffector.cpp</a>.
<p>
References <a class="el" href="OgreLinearForceAffector_8h-source.html#l00108">mForceApplication</a>. </td>
</tr>
</table>
<a name="Ogre_1_1LinearForceAffectora2" doxytag="Ogre::LinearForceAffector::setForceVector"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void Ogre::LinearForceAffector::setForceVector </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="classOgre_1_1Vector3.html">Vector3</a> & </td>
<td class="mdname1" valign="top" nowrap> <em>force</em> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Sets the force vector to apply to the particles in a system.
<p>
<p>
Definition at line <a class="el" href="OgreLinearForceAffector_8cpp-source.html#l00094">94</a> of file <a class="el" href="OgreLinearForceAffector_8cpp-source.html">OgreLinearForceAffector.cpp</a>.
<p>
References <a class="el" href="OgreLinearForceAffector_8h-source.html#l00105">mForceVector</a>. </td>
</tr>
</table>
<a name="Ogre_1_1TTYGuiElementa82" doxytag="Ogre::LinearForceAffector::setParameter"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> bool Ogre::StringInterface::setParameter </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="classOgre_1_1String.html">String</a> & </td>
<td class="mdname" nowrap> <em>name</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>const <a class="el" href="classOgre_1_1String.html">String</a> & </td>
<td class="mdname" nowrap> <em>value</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [virtual, inherited]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Generic parameter setting method.
<p>
<dl compact><dt><b>
Remarks: </b><dd>
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 <a class="el" href="classOgre_1_1StringInterface.html#Ogre_1_1TTYGuiElementa81">StringInterface::getParameters</a>. </dl><dl compact><dt><b>
Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>name</em> </td><td>
The name of the parameter to set </td></tr>
<tr><td valign=top><em>value</em> </td><td>
<a class="el" href="classOgre_1_1String.html">String</a> value. Must be in the right format for the type specified in the parameter definition. See the <a class="el" href="classOgre_1_1StringConverter.html">StringConverter</a> class for more information. </td></tr>
</table>
</dl><dl compact><dt><b>
Returns: </b><dd>
true if set was successful, false otherwise (NB no exceptions thrown - tolerant method) </dl>
<p>
Definition at line <a class="el" href="OgreStringInterface_8cpp-source.html#l00033">33</a> of file <a class="el" href="OgreStringInterface_8cpp-source.html">OgreStringInterface.cpp</a>.
<p>
References <a class="el" href="classOgre_1_1ParamCommand.html#Ogre_1_1ParamCommanda1">Ogre::ParamCommand::doSet</a>(), <a class="el" href="OgreStringInterface_8h-source.html#l00087">Ogre::ParamDictionary::getParamCommand</a>(), and <a class="el" href="OgreStringInterface_8h-source.html#l00193">Ogre::StringInterface::getParamDictionary</a>().
<p>
Referenced by <a class="el" href="OgreStringInterface_8h-source.html#l00293">Ogre::StringInterface::copyParametersTo</a>(), <a class="el" href="OgreProfiler_8cpp-source.html#l00761">Ogre::Profiler::createContainer</a>(), <a class="el" href="OgreProfiler_8cpp-source.html#l00785">Ogre::Profiler::createTextArea</a>(), <a class="el" href="OgreMaterialSerializer_8cpp-source.html#l01881">Ogre::MaterialSerializer::finishProgramDefinition</a>(), <a class="el" href="OgreParticleSystemManager_8cpp-source.html#l00438">Ogre::ParticleSystemManager::parseAffectorAttrib</a>(), <a class="el" href="OgreParticleSystemManager_8cpp-source.html#l00406">Ogre::ParticleSystemManager::parseAttrib</a>(), <a class="el" href="OgreOverlayManager_8cpp-source.html#l00414">Ogre::OverlayManager::parseElementAttrib</a>(), and <a class="el" href="OgreParticleSystemManager_8cpp-source.html#l00422">Ogre::ParticleSystemManager::parseEmitterAttrib</a>(). </td>
</tr>
</table>
<hr><h2>Member Data Documentation</h2>
<a name="Ogre_1_1LinearForceAffectorn1" doxytag="Ogre::LinearForceAffector::mForceApplication"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1LinearForceAffector.html#Ogre_1_1LinearForceAffectors2">ForceApplication</a> Ogre::LinearForceAffector::mForceApplication<code> [protected]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
How to apply force.
<p>
<p>
Definition at line <a class="el" href="OgreLinearForceAffector_8h-source.html#l00108">108</a> of file <a class="el" href="OgreLinearForceAffector_8h-source.html">OgreLinearForceAffector.h</a>.
<p>
Referenced by <a class="el" href="OgreLinearForceAffector_8cpp-source.html#l00065">_affectParticles</a>(), <a class="el" href="OgreLinearForceAffector_8cpp-source.html#l00109">getForceApplication</a>(), <a class="el" href="OgreLinearForceAffector_8cpp-source.html#l00039">LinearForceAffector</a>(), and <a class="el" href="OgreLinearForceAffector_8cpp-source.html#l00099">setForceApplication</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1LinearForceAffectorn0" doxytag="Ogre::LinearForceAffector::mForceVector"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1Vector3.html">Vector3</a> Ogre::LinearForceAffector::mForceVector<code> [protected]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Force vector.
<p>
<p>
Definition at line <a class="el" href="OgreLinearForceAffector_8h-source.html#l00105">105</a> of file <a class="el" href="OgreLinearForceAffector_8h-source.html">OgreLinearForceAffector.h</a>.
<p>
Referenced by <a class="el" href="OgreLinearForceAffector_8cpp-source.html#l00065">_affectParticles</a>(), <a class="el" href="OgreLinearForceAffector_8cpp-source.html#l00104">getForceVector</a>(), <a class="el" href="OgreLinearForceAffector_8cpp-source.html#l00039">LinearForceAffector</a>(), and <a class="el" href="OgreLinearForceAffector_8cpp-source.html#l00094">setForceVector</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1TTYGuiElementn48" doxytag="Ogre::LinearForceAffector::mParamDictName"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1String.html">String</a> Ogre::StringInterface::mParamDictName<code> [protected, inherited]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Class name for this instance to be used as a lookup (must be initialised by subclasses).
<p>
<p>
Definition at line <a class="el" href="OgreStringInterface_8h-source.html#l00157">157</a> of file <a class="el" href="OgreStringInterface_8h-source.html">OgreStringInterface.h</a>. </td>
</tr>
</table>
<a name="Ogre_1_1TTYGuiElementq19" doxytag="Ogre::LinearForceAffector::msDictionary"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a421">ParamDictionaryMap</a> Ogre::StringInterface::msDictionary<code> [static, protected, inherited]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Dictionary of parameters.
<p>
<p>
Definition at line <a class="el" href="OgreStringInterface_8cpp-source.html#l00030">30</a> of file <a class="el" href="OgreStringInterface_8cpp-source.html">OgreStringInterface.cpp</a>. </td>
</tr>
</table>
<a name="Ogre_1_1LinearForceAffectorp1" doxytag="Ogre::LinearForceAffector::msForceAppCmd"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1LinearForceAffector_1_1CmdForceApp.html">LinearForceAffector::CmdForceApp</a> Ogre::LinearForceAffector::msForceAppCmd<code> [static]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<p>
Definition at line <a class="el" href="OgreLinearForceAffector_8cpp-source.html#l00035">35</a> of file <a class="el" href="OgreLinearForceAffector_8cpp-source.html">OgreLinearForceAffector.cpp</a>.
<p>
Referenced by <a class="el" href="OgreLinearForceAffector_8cpp-source.html#l00039">LinearForceAffector</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1LinearForceAffectorp0" doxytag="Ogre::LinearForceAffector::msForceVectorCmd"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1LinearForceAffector_1_1CmdForceVector.html">LinearForceAffector::CmdForceVector</a> Ogre::LinearForceAffector::msForceVectorCmd<code> [static]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Command objects.
<p>
<p>
Definition at line <a class="el" href="OgreLinearForceAffector_8cpp-source.html#l00034">34</a> of file <a class="el" href="OgreLinearForceAffector_8cpp-source.html">OgreLinearForceAffector.cpp</a>.
<p>
Referenced by <a class="el" href="OgreLinearForceAffector_8cpp-source.html#l00039">LinearForceAffector</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1ScaleAffectorn1" doxytag="Ogre::LinearForceAffector::mType"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1String.html">String</a> Ogre::ParticleAffector::mType<code> [protected, inherited]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Name of the type of affector, MUST be initialised by subclasses.
<p>
<p>
Definition at line <a class="el" href="OgreParticleAffector_8h-source.html#l00058">58</a> of file <a class="el" href="OgreParticleAffector_8h-source.html">OgreParticleAffector.h</a>.
<p>
Referenced by <a class="el" href="OgreColourFaderAffector_8cpp-source.html#l00040">Ogre::ColourFaderAffector::ColourFaderAffector</a>(), <a class="el" href="OgreColourFaderAffector2_8cpp-source.html#l00050">Ogre::ColourFaderAffector2::ColourFaderAffector2</a>(), <a class="el" href="OgreColourImageAffector_8cpp-source.html#l00038">Ogre::ColourImageAffector::ColourImageAffector</a>(), <a class="el" href="OgreColourInterpolatorAffector_8cpp-source.html#l00038">Ogre::ColourInterpolatorAffector::ColourInterpolatorAffector</a>(), <a class="el" href="OgreLinearForceAffector_8cpp-source.html#l00039">LinearForceAffector</a>(), <a class="el" href="OgreRotationAffector_8cpp-source.html#l00040">Ogre::RotationAffector::RotationAffector</a>(), and <a class="el" href="OgreScaleAffector_8cpp-source.html#l00037">Ogre::ScaleAffector::ScaleAffector</a>(). </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="OgreLinearForceAffector_8h-source.html">OgreLinearForceAffector.h</a><li><a class="el" href="OgreLinearForceAffector_8cpp-source.html">OgreLinearForceAffector.cpp</a></ul>
<p>
Copyright © 2002-2003 by The OGRE Team<br />
Last modified Wed Jan 21 00:13:10 2004
</p>
</body>
</html>
