source: OGRE/trunk/ogrenew/Docs/api/html/classOgre_1_1LinearForceAffector.html @ 657

Revision 657, 53.3 KB checked in by mattausch, 18 years ago (diff)

added ogre dependencies and patched ogre sources
Line 
1<html>
2<head>
3<title>Ogre::LinearForceAffector class Reference - OGRE Documentation</title> <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
4<link type="text/css" rel="stylesheet" href="style.css">
5</head>
6
7<body>
8<!-- Generated by Doxygen 1.3.6 -->
9<div class="qindex"><a class="qindex" href="index.html">Main&nbsp;Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class&nbsp;Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical&nbsp;List</a> | <a class="qindex" href="annotated.html">Class&nbsp;List</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="namespacemembers.html">Namespace&nbsp;Members</a> | <a class="qindex" href="functions.html">Class&nbsp;Members</a> | <a class="qindex" href="globals.html">File&nbsp;Members</a> | <a class="qindex" href="pages.html">Related&nbsp;Pages</a></div>
10<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. 
11<a href="#_details">More...</a>
12<p>
13<code>#include &lt;<a class="el" href="OgreLinearForceAffector_8h-source.html">OgreLinearForceAffector.h</a>&gt;</code>
14<p>
15<p>Inheritance diagram for Ogre::LinearForceAffector:
16<p><center><img src="classOgre_1_1LinearForceAffector.png" usemap="#Ogre::LinearForceAffector_map" border="0" alt=""></center>
17<map name="Ogre::LinearForceAffector_map">
18<area href="classOgre_1_1ParticleAffector.html" alt="Ogre::ParticleAffector" shape="rect" coords="0,56,163,80">
19<area href="classOgre_1_1StringInterface.html" alt="Ogre::StringInterface" shape="rect" coords="0,0,163,24">
20</map>
21<a href="classOgre_1_1LinearForceAffector-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
22<tr><td></td></tr>
23<tr><td colspan=2><br><h2>Public Types</h2></td></tr>
24<tr><td class="memItemLeft" nowrap align=right valign=top>enum &nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1LinearForceAffector.html#Ogre_1_1LinearForceAffectorw2">ForceApplication</a> { <a class="el" href="classOgre_1_1LinearForceAffector.html#Ogre_1_1LinearForceAffectorw2Ogre_1_1LinearForceAffectorw0">FA_AVERAGE</a>,
25<a class="el" href="classOgre_1_1LinearForceAffector.html#Ogre_1_1LinearForceAffectorw2Ogre_1_1LinearForceAffectorw1">FA_ADD</a>
26 }</td></tr>
27
28<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Choice of how to apply the force vector to particles.  <a href="#Ogre_1_1LinearForceAffectorw2">More...</a><br><br></td></tr>
29<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
30<tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1LinearForceAffector.html#Ogre_1_1LinearForceAffectora0">LinearForceAffector</a> (<a class="el" href="classOgre_1_1ParticleSystem.html">ParticleSystem</a> *psys)</td></tr>
31
32<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor.  <a href="#Ogre_1_1LinearForceAffectora0"></a><br><br></td></tr>
33<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" 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#a420">Real</a> timeElapsed)</td></tr>
34
35<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">See <a class="el" href="classOgre_1_1ParticleAffector.html">ParticleAffector</a>.  <a href="#Ogre_1_1LinearForceAffectora1"></a><br><br></td></tr>
36<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" 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> &amp;force)</td></tr>
37
38<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets the force vector to apply to the particles in a system.  <a href="#Ogre_1_1LinearForceAffectora2"></a><br><br></td></tr>
39<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1Vector3.html">Vector3</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1LinearForceAffector.html#Ogre_1_1LinearForceAffectora3">getForceVector</a> (void) const </td></tr>
40
41<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Gets the force vector to apply to the particles in a system.  <a href="#Ogre_1_1LinearForceAffectora3"></a><br><br></td></tr>
42<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" 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_1LinearForceAffectorw2">ForceApplication</a> fa)</td></tr>
43
44<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets how the force vector is applied to a particle.  <a href="#Ogre_1_1LinearForceAffectora4"></a><br><br></td></tr>
45<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1LinearForceAffector.html#Ogre_1_1LinearForceAffectorw2">ForceApplication</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1LinearForceAffector.html#Ogre_1_1LinearForceAffectora5">getForceApplication</a> (void) const </td></tr>
46
47<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves how the force vector is applied to a particle.  <a href="#Ogre_1_1LinearForceAffectora5"></a><br><br></td></tr>
48<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ParticleAffector.html#Ogre_1_1ScaleAffectora4">_initParticle</a> (<a class="el" href="classOgre_1_1Particle.html">Particle</a> *pParticle)</td></tr>
49
50<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Method called to allow the affector to initialize all newly created particles in the system.  <a href="#Ogre_1_1ScaleAffectora4"></a><br><br></td></tr>
51<tr><td class="memItemLeft" nowrap align=right valign=top>const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ParticleAffector.html#Ogre_1_1ScaleAffectora5">getType</a> (void) const </td></tr>
52
53<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the name of the type of affector.  <a href="#Ogre_1_1ScaleAffectora5"></a><br><br></td></tr>
54<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1ParamDictionary.html">ParamDictionary</a> *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1StringInterface.html#Ogre_1_1Texturea44">getParamDictionary</a> (void)</td></tr>
55
56<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves the parameter dictionary for this class.  <a href="#Ogre_1_1Texturea44"></a><br><br></td></tr>
57<tr><td class="memItemLeft" nowrap align=right valign=top>const <a class="el" href="classOgre_1_1ParamDictionary.html">ParamDictionary</a> *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1StringInterface.html#Ogre_1_1Texturea45">getParamDictionary</a> (void) const </td></tr>
58
59<tr><td class="memItemLeft" nowrap align=right valign=top>const <a class="el" href="namespaceOgre.html#a518">ParameterList</a> &amp;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1StringInterface.html#Ogre_1_1Texturea46">getParameters</a> (void) const </td></tr>
60
61<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves a list of parameters valid for this object.  <a href="#Ogre_1_1Texturea46"></a><br><br></td></tr>
62<tr><td class="memItemLeft" nowrap align=right valign=top>virtual bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1StringInterface.html#Ogre_1_1Texturea47">setParameter</a> (const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;name, const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;value)</td></tr>
63
64<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Generic parameter setting method.  <a href="#Ogre_1_1Texturea47"></a><br><br></td></tr>
65<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1StringInterface.html#Ogre_1_1Texturea48">setParameterList</a> (const <a class="el" href="namespaceOgre.html#a62">NameValuePairList</a> &amp;paramList)</td></tr>
66
67<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Generic multiple parameter setting method.  <a href="#Ogre_1_1Texturea48"></a><br><br></td></tr>
68<tr><td class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="namespaceOgre.html#a426">String</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1StringInterface.html#Ogre_1_1Texturea49">getParameter</a> (const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;name) const </td></tr>
69
70<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Generic parameter retrieval method.  <a href="#Ogre_1_1Texturea49"></a><br><br></td></tr>
71<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1StringInterface.html#Ogre_1_1Texturea50">copyParametersTo</a> (<a class="el" href="classOgre_1_1StringInterface.html">StringInterface</a> *dest) const </td></tr>
72
73<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Method for copying this object's parameters to another object.  <a href="#Ogre_1_1Texturea50"></a><br><br></td></tr>
74<tr><td colspan=2><br><h2>Static Public Member Functions</h2></td></tr>
75<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1StringInterface.html#Ogre_1_1Texturee0">cleanupDictionary</a> ()</td></tr>
76
77<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Cleans up the static 'msDictionary' required to reset <a class="el" href="namespaceOgre.html">Ogre</a>, otherwise the containers are left with invalid pointers, which will lead to a crash as soon as one of the <a class="el" href="classOgre_1_1ResourceManager.html">ResourceManager</a> implementers (e.g.  <a href="#Ogre_1_1Texturee0"></a><br><br></td></tr>
78<tr><td colspan=2><br><h2>Static Public Attributes</h2></td></tr>
79<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1LinearForceAffector_1_1CmdForceVector.html">CmdForceVector</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1LinearForceAffector.html#Ogre_1_1LinearForceAffectors0">msForceVectorCmd</a></td></tr>
80
81<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Command objects.  <a href="#Ogre_1_1LinearForceAffectors0"></a><br><br></td></tr>
82<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1LinearForceAffector_1_1CmdForceApp.html">CmdForceApp</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1LinearForceAffector.html#Ogre_1_1LinearForceAffectors1">msForceAppCmd</a></td></tr>
83
84<tr><td colspan=2><br><h2>Protected Member Functions</h2></td></tr>
85<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ParticleAffector.html#Ogre_1_1ScaleAffectorb0">addBaseParameters</a> (void)</td></tr>
86
87<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Internal method for setting up the basic parameter definitions for a subclass.  <a href="#Ogre_1_1ScaleAffectorb0"></a><br><br></td></tr>
88<tr><td class="memItemLeft" nowrap align=right valign=top>bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1StringInterface.html#Ogre_1_1Textureb6">createParamDictionary</a> (const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;className)</td></tr>
89
90<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Internal method for creating a parameter dictionary for the class, if it does not already exist.  <a href="#Ogre_1_1Textureb6"></a><br><br></td></tr>
91<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr>
92<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1Vector3.html">Vector3</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1LinearForceAffector.html#Ogre_1_1LinearForceAffectorp0">mForceVector</a></td></tr>
93
94<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Force vector.  <a href="#Ogre_1_1LinearForceAffectorp0"></a><br><br></td></tr>
95<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1LinearForceAffector.html#Ogre_1_1LinearForceAffectorw2">ForceApplication</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1LinearForceAffector.html#Ogre_1_1LinearForceAffectorp1">mForceApplication</a></td></tr>
96
97<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">How to apply force.  <a href="#Ogre_1_1LinearForceAffectorp1"></a><br><br></td></tr>
98<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a426">String</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ParticleAffector.html#Ogre_1_1ScaleAffectorp1">mType</a></td></tr>
99
100<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Name of the type of affector, MUST be initialised by subclasses.  <a href="#Ogre_1_1ScaleAffectorp1"></a><br><br></td></tr>
101<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1ParticleSystem.html">ParticleSystem</a> *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ParticleAffector.html#Ogre_1_1ScaleAffectorp2">mParent</a></td></tr>
102
103<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a426">String</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1StringInterface.html#Ogre_1_1Texturep26">mParamDictName</a></td></tr>
104
105<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Class name for this instance to be used as a lookup (must be initialised by subclasses).  <a href="#Ogre_1_1Texturep26"></a><br><br></td></tr>
106<tr><td colspan=2><br><h2>Static Protected Attributes</h2></td></tr>
107<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a520">ParamDictionaryMap</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1StringInterface.html#Ogre_1_1Texturet0">msDictionary</a></td></tr>
108
109<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Dictionary of parameters.  <a href="#Ogre_1_1Texturet0"></a><br><br></td></tr>
110</table>
111<hr><a name="_details"></a><h2>Detailed Description</h2>
112This class defines a <a class="el" href="classOgre_1_1ParticleAffector.html">ParticleAffector</a> which applies a linear force to particles in a system.
113<p>
114<dl compact><dt><b>Remarks:</b></dt><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. </dd></dl>
115<dl compact><dt><b></b></dt><dd>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. </dd></dl>
116
117<p>
118
119<p>
120Definition 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>
121<a class="anchor" name="Ogre_1_1LinearForceAffectorw2" doxytag="Ogre::LinearForceAffector::ForceApplication" ></a><p>
122<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
123  <tr>
124    <td class="mdRow">
125      <table cellpadding="0" cellspacing="0" border="0">
126        <tr>
127          <td class="md" nowrap valign="top"> enum <a class="el" href="classOgre_1_1LinearForceAffector.html#Ogre_1_1LinearForceAffectorw2">Ogre::LinearForceAffector::ForceApplication</a>
128      </table>
129    </td>
130  </tr>
131</table>
132<table cellspacing=5 cellpadding=0 border=0>
133  <tr>
134    <td>
135      &nbsp;
136    </td>
137    <td>
138
139<p>
140Choice of how to apply the force vector to particles.
141<p>
142<dl compact><dt><b>Enumeration values: </b></dt><dd>
143<table border=0 cellspacing=2 cellpadding=0>
144<tr><td valign=top><em><a class="anchor" name="Ogre_1_1LinearForceAffectorw2Ogre_1_1LinearForceAffectorw0" doxytag="FA_AVERAGE" ></a>FA_AVERAGE</em>&nbsp;</td><td>
145Take the average of the force vector and the particle momentum. </td></tr>
146<tr><td valign=top><em><a class="anchor" name="Ogre_1_1LinearForceAffectorw2Ogre_1_1LinearForceAffectorw1" doxytag="FA_ADD" ></a>FA_ADD</em>&nbsp;</td><td>
147Add the force vector to the particle momentum. </td></tr>
148</table>
149</dl>
150
151<p>
152Definition 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>
153  </tr>
154</table>
155<hr><h2>Constructor &amp; Destructor Documentation</h2>
156<a class="anchor" name="Ogre_1_1LinearForceAffectora0" doxytag="Ogre::LinearForceAffector::LinearForceAffector" ></a><p>
157<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
158  <tr>
159    <td class="mdRow">
160      <table cellpadding="0" cellspacing="0" border="0">
161        <tr>
162          <td class="md" nowrap valign="top"> Ogre::LinearForceAffector::LinearForceAffector </td>
163          <td class="md" valign="top">(&nbsp;</td>
164          <td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1ParticleSystem.html">ParticleSystem</a> *&nbsp;</td>
165          <td class="mdname1" valign="top" nowrap> <em>psys</em>          </td>
166          <td class="md" valign="top">&nbsp;)&nbsp;</td>
167          <td class="md" nowrap></td>
168        </tr>
169
170      </table>
171    </td>
172  </tr>
173</table>
174<table cellspacing=5 cellpadding=0 border=0>
175  <tr>
176    <td>
177      &nbsp;
178    </td>
179    <td>
180
181<p>
182Default constructor.
183<p>
184    </td>
185  </tr>
186</table>
187<hr><h2>Member Function Documentation</h2>
188<a class="anchor" name="Ogre_1_1LinearForceAffectora1" doxytag="Ogre::LinearForceAffector::_affectParticles" ></a><p>
189<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
190  <tr>
191    <td class="mdRow">
192      <table cellpadding="0" cellspacing="0" border="0">
193        <tr>
194          <td class="md" nowrap valign="top"> void Ogre::LinearForceAffector::_affectParticles </td>
195          <td class="md" valign="top">(&nbsp;</td>
196          <td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1ParticleSystem.html">ParticleSystem</a> *&nbsp;</td>
197          <td class="mdname" nowrap> <em>pSystem</em>, </td>
198        </tr>
199        <tr>
200          <td class="md" nowrap align="right"></td>
201          <td></td>
202          <td class="md" nowrap><a class="el" href="namespaceOgre.html#a420">Real</a>&nbsp;</td>
203          <td class="mdname" nowrap> <em>timeElapsed</em></td>
204        </tr>
205        <tr>
206          <td></td>
207          <td class="md">)&nbsp;</td>
208          <td class="md" colspan="2"><code> [virtual]</code></td>
209        </tr>
210
211      </table>
212    </td>
213  </tr>
214</table>
215<table cellspacing=5 cellpadding=0 border=0>
216  <tr>
217    <td>
218      &nbsp;
219    </td>
220    <td>
221
222<p>
223See <a class="el" href="classOgre_1_1ParticleAffector.html">ParticleAffector</a>.
224<p>
225
226<p>
227Implements <a class="el" href="classOgre_1_1ParticleAffector.html#Ogre_1_1ParticleAffectora3">Ogre::ParticleAffector</a>.    </td>
228  </tr>
229</table>
230<a class="anchor" name="Ogre_1_1ScaleAffectora4" doxytag="Ogre::LinearForceAffector::_initParticle" ></a><p>
231<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
232  <tr>
233    <td class="mdRow">
234      <table cellpadding="0" cellspacing="0" border="0">
235        <tr>
236          <td class="md" nowrap valign="top"> virtual void Ogre::ParticleAffector::_initParticle </td>
237          <td class="md" valign="top">(&nbsp;</td>
238          <td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1Particle.html">Particle</a> *&nbsp;</td>
239          <td class="mdname1" valign="top" nowrap> <em>pParticle</em>          </td>
240          <td class="md" valign="top">&nbsp;)&nbsp;</td>
241          <td class="md" nowrap><code> [virtual, inherited]</code></td>
242        </tr>
243
244      </table>
245    </td>
246  </tr>
247</table>
248<table cellspacing=5 cellpadding=0 border=0>
249  <tr>
250    <td>
251      &nbsp;
252    </td>
253    <td>
254
255<p>
256Method called to allow the affector to initialize all newly created particles in the system.
257<p>
258<dl compact><dt><b>Remarks:</b></dt><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. </dd></dl>
259<dl compact><dt><b>Parameters:</b></dt><dd>
260  <table border="0" cellspacing="2" cellpadding="0">
261    <tr><td valign=top><em>pParticle</em>&nbsp;</td><td>Pointer to a <a class="el" href="classOgre_1_1Particle.html">Particle</a> to initialize. </td></tr>
262  </table>
263</dl>
264
265<p>
266Reimplemented 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>.
267<p>
268Definition at line <a class="el" href="OgreParticleAffector_8h-source.html#l00085">85</a> of file <a class="el" href="OgreParticleAffector_8h-source.html">OgreParticleAffector.h</a>.    </td>
269  </tr>
270</table>
271<a class="anchor" name="Ogre_1_1ScaleAffectorb0" doxytag="Ogre::LinearForceAffector::addBaseParameters" ></a><p>
272<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
273  <tr>
274    <td class="mdRow">
275      <table cellpadding="0" cellspacing="0" border="0">
276        <tr>
277          <td class="md" nowrap valign="top"> void Ogre::ParticleAffector::addBaseParameters </td>
278          <td class="md" valign="top">(&nbsp;</td>
279          <td class="md" nowrap valign="top">void&nbsp;</td>
280          <td class="mdname1" valign="top" nowrap>          </td>
281          <td class="md" valign="top">&nbsp;)&nbsp;</td>
282          <td class="md" nowrap><code> [protected, inherited]</code></td>
283        </tr>
284
285      </table>
286    </td>
287  </tr>
288</table>
289<table cellspacing=5 cellpadding=0 border=0>
290  <tr>
291    <td>
292      &nbsp;
293    </td>
294    <td>
295
296<p>
297Internal method for setting up the basic parameter definitions for a subclass.
298<p>
299<dl compact><dt><b>Remarks:</b></dt><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. </dd></dl>
300<dl compact><dt><b></b></dt><dd>The subclass must have called it's own createParamDictionary before calling this method. </dd></dl>
301
302<p>
303Definition 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>.    </td>
304  </tr>
305</table>
306<a class="anchor" name="Ogre_1_1Texturee0" doxytag="Ogre::LinearForceAffector::cleanupDictionary" ></a><p>
307<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
308  <tr>
309    <td class="mdRow">
310      <table cellpadding="0" cellspacing="0" border="0">
311        <tr>
312          <td class="md" nowrap valign="top"> void Ogre::StringInterface::cleanupDictionary </td>
313          <td class="md" valign="top">(&nbsp;</td>
314          <td class="mdname1" valign="top" nowrap>          </td>
315          <td class="md" valign="top">&nbsp;)&nbsp;</td>
316          <td class="md" nowrap><code> [static, inherited]</code></td>
317        </tr>
318
319      </table>
320    </td>
321  </tr>
322</table>
323<table cellspacing=5 cellpadding=0 border=0>
324  <tr>
325    <td>
326      &nbsp;
327    </td>
328    <td>
329
330<p>
331Cleans up the static 'msDictionary' required to reset <a class="el" href="namespaceOgre.html">Ogre</a>, otherwise the containers are left with invalid pointers, which will lead to a crash as soon as one of the <a class="el" href="classOgre_1_1ResourceManager.html">ResourceManager</a> implementers (e.g.
332<p>
333<a class="el" href="classOgre_1_1MaterialManager.html">MaterialManager</a>) initializes.     </td>
334  </tr>
335</table>
336<a class="anchor" name="Ogre_1_1Texturea50" doxytag="Ogre::LinearForceAffector::copyParametersTo" ></a><p>
337<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
338  <tr>
339    <td class="mdRow">
340      <table cellpadding="0" cellspacing="0" border="0">
341        <tr>
342          <td class="md" nowrap valign="top"> virtual void Ogre::StringInterface::copyParametersTo </td>
343          <td class="md" valign="top">(&nbsp;</td>
344          <td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1StringInterface.html">StringInterface</a> *&nbsp;</td>
345          <td class="mdname1" valign="top" nowrap> <em>dest</em>          </td>
346          <td class="md" valign="top">&nbsp;)&nbsp;</td>
347          <td class="md" nowrap> const<code> [virtual, inherited]</code></td>
348        </tr>
349
350      </table>
351    </td>
352  </tr>
353</table>
354<table cellspacing=5 cellpadding=0 border=0>
355  <tr>
356    <td>
357      &nbsp;
358    </td>
359    <td>
360
361<p>
362Method for copying this object's parameters to another object.
363<p>
364<dl compact><dt><b>Remarks:</b></dt><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 String manipulation involved, this should not be regarded as an efficient process and should be saved for times outside of the rendering loop. </dd></dl>
365<dl compact><dt><b></b></dt><dd>Any unrecognised parameters will be ignored as with setParameter method. </dd></dl>
366<dl compact><dt><b>Parameters:</b></dt><dd>
367  <table border="0" cellspacing="2" cellpadding="0">
368    <tr><td valign=top><em>dest</em>&nbsp;</td><td>Pointer to object to have it's parameters set the same as this object. </td></tr>
369  </table>
370</dl>
371
372<p>
373Definition at line <a class="el" href="OgreStringInterface_8h-source.html#l00296">296</a> of file <a class="el" href="OgreStringInterface_8h-source.html">OgreStringInterface.h</a>.
374<p>
375References <a class="el" href="OgreStringInterface_8h-source.html#l00084">Ogre::ParamDictionary::mParamDefs</a>, and <a class="el" href="classOgre_1_1StringInterface.html#Ogre_1_1Texturea47">Ogre::StringInterface::setParameter()</a>.    </td>
376  </tr>
377</table>
378<a class="anchor" name="Ogre_1_1Textureb6" doxytag="Ogre::LinearForceAffector::createParamDictionary" ></a><p>
379<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
380  <tr>
381    <td class="mdRow">
382      <table cellpadding="0" cellspacing="0" border="0">
383        <tr>
384          <td class="md" nowrap valign="top"> bool Ogre::StringInterface::createParamDictionary </td>
385          <td class="md" valign="top">(&nbsp;</td>
386          <td class="md" nowrap valign="top">const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;&nbsp;</td>
387          <td class="mdname1" valign="top" nowrap> <em>className</em>          </td>
388          <td class="md" valign="top">&nbsp;)&nbsp;</td>
389          <td class="md" nowrap><code> [protected, inherited]</code></td>
390        </tr>
391
392      </table>
393    </td>
394  </tr>
395</table>
396<table cellspacing=5 cellpadding=0 border=0>
397  <tr>
398    <td>
399      &nbsp;
400    </td>
401    <td>
402
403<p>
404Internal method for creating a parameter dictionary for the class, if it does not already exist.
405<p>
406<dl compact><dt><b>Remarks:</b></dt><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). </dd></dl>
407<dl compact><dt><b>Parameters:</b></dt><dd>
408  <table border="0" cellspacing="2" cellpadding="0">
409    <tr><td valign=top><em>className</em>&nbsp;</td><td>the name of the class using the dictionary </td></tr>
410  </table>
411</dl>
412<dl compact><dt><b>Returns:</b></dt><dd>true if a new dictionary was created, false if it was already there </dd></dl>
413
414<p>
415Definition at line <a class="el" href="OgreStringInterface_8h-source.html#l00172">172</a> of file <a class="el" href="OgreStringInterface_8h-source.html">OgreStringInterface.h</a>.
416<p>
417References <a class="el" href="OgrePrerequisites_8h-source.html#l00154">Ogre::String</a>.    </td>
418  </tr>
419</table>
420<a class="anchor" name="Ogre_1_1LinearForceAffectora5" doxytag="Ogre::LinearForceAffector::getForceApplication" ></a><p>
421<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
422  <tr>
423    <td class="mdRow">
424      <table cellpadding="0" cellspacing="0" border="0">
425        <tr>
426          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1LinearForceAffector.html#Ogre_1_1LinearForceAffectorw2">ForceApplication</a> Ogre::LinearForceAffector::getForceApplication </td>
427          <td class="md" valign="top">(&nbsp;</td>
428          <td class="md" nowrap valign="top">void&nbsp;</td>
429          <td class="mdname1" valign="top" nowrap>          </td>
430          <td class="md" valign="top">&nbsp;)&nbsp;</td>
431          <td class="md" nowrap> const</td>
432        </tr>
433
434      </table>
435    </td>
436  </tr>
437</table>
438<table cellspacing=5 cellpadding=0 border=0>
439  <tr>
440    <td>
441      &nbsp;
442    </td>
443    <td>
444
445<p>
446Retrieves how the force vector is applied to a particle.
447<p>
448<dl compact><dt><b>Parameters:</b></dt><dd>
449  <table border="0" cellspacing="2" cellpadding="0">
450    <tr><td valign=top><em>fa</em>&nbsp;</td><td>A member of the ForceApplication enum. </td></tr>
451  </table>
452</dl>
453    </td>
454  </tr>
455</table>
456<a class="anchor" name="Ogre_1_1LinearForceAffectora3" doxytag="Ogre::LinearForceAffector::getForceVector" ></a><p>
457<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
458  <tr>
459    <td class="mdRow">
460      <table cellpadding="0" cellspacing="0" border="0">
461        <tr>
462          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1Vector3.html">Vector3</a> Ogre::LinearForceAffector::getForceVector </td>
463          <td class="md" valign="top">(&nbsp;</td>
464          <td class="md" nowrap valign="top">void&nbsp;</td>
465          <td class="mdname1" valign="top" nowrap>          </td>
466          <td class="md" valign="top">&nbsp;)&nbsp;</td>
467          <td class="md" nowrap> const</td>
468        </tr>
469
470      </table>
471    </td>
472  </tr>
473</table>
474<table cellspacing=5 cellpadding=0 border=0>
475  <tr>
476    <td>
477      &nbsp;
478    </td>
479    <td>
480
481<p>
482Gets the force vector to apply to the particles in a system.
483<p>
484    </td>
485  </tr>
486</table>
487<a class="anchor" name="Ogre_1_1Texturea45" doxytag="Ogre::LinearForceAffector::getParamDictionary" ></a><p>
488<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
489  <tr>
490    <td class="mdRow">
491      <table cellpadding="0" cellspacing="0" border="0">
492        <tr>
493          <td class="md" nowrap valign="top"> const <a class="el" href="classOgre_1_1ParamDictionary.html">ParamDictionary</a>* Ogre::StringInterface::getParamDictionary </td>
494          <td class="md" valign="top">(&nbsp;</td>
495          <td class="md" nowrap valign="top">void&nbsp;</td>
496          <td class="mdname1" valign="top" nowrap>          </td>
497          <td class="md" valign="top">&nbsp;)&nbsp;</td>
498          <td class="md" nowrap> const<code> [inherited]</code></td>
499        </tr>
500
501      </table>
502    </td>
503  </tr>
504</table>
505<table cellspacing=5 cellpadding=0 border=0>
506  <tr>
507    <td>
508      &nbsp;
509    </td>
510    <td>
511
512<p>
513
514<p>
515Definition at line <a class="el" href="OgreStringInterface_8h-source.html#l00209">209</a> of file <a class="el" href="OgreStringInterface_8h-source.html">OgreStringInterface.h</a>.    </td>
516  </tr>
517</table>
518<a class="anchor" name="Ogre_1_1Texturea44" doxytag="Ogre::LinearForceAffector::getParamDictionary" ></a><p>
519<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
520  <tr>
521    <td class="mdRow">
522      <table cellpadding="0" cellspacing="0" border="0">
523        <tr>
524          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1ParamDictionary.html">ParamDictionary</a>* Ogre::StringInterface::getParamDictionary </td>
525          <td class="md" valign="top">(&nbsp;</td>
526          <td class="md" nowrap valign="top">void&nbsp;</td>
527          <td class="mdname1" valign="top" nowrap>          </td>
528          <td class="md" valign="top">&nbsp;)&nbsp;</td>
529          <td class="md" nowrap><code> [inherited]</code></td>
530        </tr>
531
532      </table>
533    </td>
534  </tr>
535</table>
536<table cellspacing=5 cellpadding=0 border=0>
537  <tr>
538    <td>
539      &nbsp;
540    </td>
541    <td>
542
543<p>
544Retrieves the parameter dictionary for this class.
545<p>
546<dl compact><dt><b>Remarks:</b></dt><dd>Only valid to call this after createParamDictionary. </dd></dl>
547<dl compact><dt><b>Returns:</b></dt><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. </dd></dl>
548
549<p>
550Definition at line <a class="el" href="OgreStringInterface_8h-source.html#l00196">196</a> of file <a class="el" href="OgreStringInterface_8h-source.html">OgreStringInterface.h</a>.    </td>
551  </tr>
552</table>
553<a class="anchor" name="Ogre_1_1Texturea49" doxytag="Ogre::LinearForceAffector::getParameter" ></a><p>
554<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
555  <tr>
556    <td class="mdRow">
557      <table cellpadding="0" cellspacing="0" border="0">
558        <tr>
559          <td class="md" nowrap valign="top"> virtual <a class="el" href="namespaceOgre.html#a426">String</a> Ogre::StringInterface::getParameter </td>
560          <td class="md" valign="top">(&nbsp;</td>
561          <td class="md" nowrap valign="top">const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;&nbsp;</td>
562          <td class="mdname1" valign="top" nowrap> <em>name</em>          </td>
563          <td class="md" valign="top">&nbsp;)&nbsp;</td>
564          <td class="md" nowrap> const<code> [virtual, inherited]</code></td>
565        </tr>
566
567      </table>
568    </td>
569  </tr>
570</table>
571<table cellspacing=5 cellpadding=0 border=0>
572  <tr>
573    <td>
574      &nbsp;
575    </td>
576    <td>
577
578<p>
579Generic parameter retrieval method.
580<p>
581<dl compact><dt><b>Remarks:</b></dt><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. </dd></dl>
582<dl compact><dt><b>Parameters:</b></dt><dd>
583  <table border="0" cellspacing="2" cellpadding="0">
584    <tr><td valign=top><em>name</em>&nbsp;</td><td>The name of the parameter to get </td></tr>
585  </table>
586</dl>
587<dl compact><dt><b>Returns:</b></dt><dd>String value of parameter, blank if not found </dd></dl>
588
589<p>
590Definition at line <a class="el" href="OgreStringInterface_8h-source.html#l00265">265</a> of file <a class="el" href="OgreStringInterface_8h-source.html">OgreStringInterface.h</a>.
591<p>
592References <a class="el" href="classOgre_1_1ParamCommand.html#Ogre_1_1ParamCommanda0">Ogre::ParamCommand::doGet()</a>, <a class="el" href="OgreStringInterface_8h-source.html#l00090">Ogre::ParamDictionary::getParamCommand()</a>, and <a class="el" href="OgrePrerequisites_8h-source.html#l00154">Ogre::String</a>.    </td>
593  </tr>
594</table>
595<a class="anchor" name="Ogre_1_1Texturea46" doxytag="Ogre::LinearForceAffector::getParameters" ></a><p>
596<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
597  <tr>
598    <td class="mdRow">
599      <table cellpadding="0" cellspacing="0" border="0">
600        <tr>
601          <td class="md" nowrap valign="top"> const <a class="el" href="namespaceOgre.html#a518">ParameterList</a>&amp; Ogre::StringInterface::getParameters </td>
602          <td class="md" valign="top">(&nbsp;</td>
603          <td class="md" nowrap valign="top">void&nbsp;</td>
604          <td class="mdname1" valign="top" nowrap>          </td>
605          <td class="md" valign="top">&nbsp;)&nbsp;</td>
606          <td class="md" nowrap> const<code> [inherited]</code></td>
607        </tr>
608
609      </table>
610    </td>
611  </tr>
612</table>
613<table cellspacing=5 cellpadding=0 border=0>
614  <tr>
615    <td>
616      &nbsp;
617    </td>
618    <td>
619
620<p>
621Retrieves a list of parameters valid for this object.
622<p>
623<dl compact><dt><b>Returns:</b></dt><dd>A reference to a static list of <a class="el" href="classOgre_1_1ParameterDef.html">ParameterDef</a> objects. </dd></dl>
624    </td>
625  </tr>
626</table>
627<a class="anchor" name="Ogre_1_1ScaleAffectora5" doxytag="Ogre::LinearForceAffector::getType" ></a><p>
628<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
629  <tr>
630    <td class="mdRow">
631      <table cellpadding="0" cellspacing="0" border="0">
632        <tr>
633          <td class="md" nowrap valign="top"> const <a class="el" href="namespaceOgre.html#a426">String</a>&amp; Ogre::ParticleAffector::getType </td>
634          <td class="md" valign="top">(&nbsp;</td>
635          <td class="md" nowrap valign="top">void&nbsp;</td>
636          <td class="mdname1" valign="top" nowrap>          </td>
637          <td class="md" valign="top">&nbsp;)&nbsp;</td>
638          <td class="md" nowrap> const<code> [inherited]</code></td>
639        </tr>
640
641      </table>
642    </td>
643  </tr>
644</table>
645<table cellspacing=5 cellpadding=0 border=0>
646  <tr>
647    <td>
648      &nbsp;
649    </td>
650    <td>
651
652<p>
653Returns the name of the type of affector.
654<p>
655<dl compact><dt><b>Remarks:</b></dt><dd>This property is useful for determining the type of affector procedurally so another can be created. </dd></dl>
656
657<p>
658Definition at line <a class="el" href="OgreParticleAffector_8h-source.html#l00104">104</a> of file <a class="el" href="OgreParticleAffector_8h-source.html">OgreParticleAffector.h</a>.
659<p>
660References <a class="el" href="OgrePrerequisites_8h-source.html#l00154">Ogre::String</a>.    </td>
661  </tr>
662</table>
663<a class="anchor" name="Ogre_1_1LinearForceAffectora4" doxytag="Ogre::LinearForceAffector::setForceApplication" ></a><p>
664<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
665  <tr>
666    <td class="mdRow">
667      <table cellpadding="0" cellspacing="0" border="0">
668        <tr>
669          <td class="md" nowrap valign="top"> void Ogre::LinearForceAffector::setForceApplication </td>
670          <td class="md" valign="top">(&nbsp;</td>
671          <td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1LinearForceAffector.html#Ogre_1_1LinearForceAffectorw2">ForceApplication</a>&nbsp;</td>
672          <td class="mdname1" valign="top" nowrap> <em>fa</em>          </td>
673          <td class="md" valign="top">&nbsp;)&nbsp;</td>
674          <td class="md" nowrap></td>
675        </tr>
676
677      </table>
678    </td>
679  </tr>
680</table>
681<table cellspacing=5 cellpadding=0 border=0>
682  <tr>
683    <td>
684      &nbsp;
685    </td>
686    <td>
687
688<p>
689Sets how the force vector is applied to a particle.
690<p>
691<dl compact><dt><b>Remarks:</b></dt><dd>The default is FA_ADD. </dd></dl>
692<dl compact><dt><b>Parameters:</b></dt><dd>
693  <table border="0" cellspacing="2" cellpadding="0">
694    <tr><td valign=top><em>fa</em>&nbsp;</td><td>A member of the ForceApplication enum. </td></tr>
695  </table>
696</dl>
697    </td>
698  </tr>
699</table>
700<a class="anchor" name="Ogre_1_1LinearForceAffectora2" doxytag="Ogre::LinearForceAffector::setForceVector" ></a><p>
701<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
702  <tr>
703    <td class="mdRow">
704      <table cellpadding="0" cellspacing="0" border="0">
705        <tr>
706          <td class="md" nowrap valign="top"> void Ogre::LinearForceAffector::setForceVector </td>
707          <td class="md" valign="top">(&nbsp;</td>
708          <td class="md" nowrap valign="top">const <a class="el" href="classOgre_1_1Vector3.html">Vector3</a> &amp;&nbsp;</td>
709          <td class="mdname1" valign="top" nowrap> <em>force</em>          </td>
710          <td class="md" valign="top">&nbsp;)&nbsp;</td>
711          <td class="md" nowrap></td>
712        </tr>
713
714      </table>
715    </td>
716  </tr>
717</table>
718<table cellspacing=5 cellpadding=0 border=0>
719  <tr>
720    <td>
721      &nbsp;
722    </td>
723    <td>
724
725<p>
726Sets the force vector to apply to the particles in a system.
727<p>
728    </td>
729  </tr>
730</table>
731<a class="anchor" name="Ogre_1_1Texturea47" doxytag="Ogre::LinearForceAffector::setParameter" ></a><p>
732<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
733  <tr>
734    <td class="mdRow">
735      <table cellpadding="0" cellspacing="0" border="0">
736        <tr>
737          <td class="md" nowrap valign="top"> virtual bool Ogre::StringInterface::setParameter </td>
738          <td class="md" valign="top">(&nbsp;</td>
739          <td class="md" nowrap valign="top">const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;&nbsp;</td>
740          <td class="mdname" nowrap> <em>name</em>, </td>
741        </tr>
742        <tr>
743          <td class="md" nowrap align="right"></td>
744          <td></td>
745          <td class="md" nowrap>const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;&nbsp;</td>
746          <td class="mdname" nowrap> <em>value</em></td>
747        </tr>
748        <tr>
749          <td></td>
750          <td class="md">)&nbsp;</td>
751          <td class="md" colspan="2"><code> [virtual, inherited]</code></td>
752        </tr>
753
754      </table>
755    </td>
756  </tr>
757</table>
758<table cellspacing=5 cellpadding=0 border=0>
759  <tr>
760    <td>
761      &nbsp;
762    </td>
763    <td>
764
765<p>
766Generic parameter setting method.
767<p>
768<dl compact><dt><b>Remarks:</b></dt><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_1Texturea46">StringInterface::getParameters</a>. </dd></dl>
769<dl compact><dt><b>Parameters:</b></dt><dd>
770  <table border="0" cellspacing="2" cellpadding="0">
771    <tr><td valign=top><em>name</em>&nbsp;</td><td>The name of the parameter to set </td></tr>
772    <tr><td valign=top><em>value</em>&nbsp;</td><td>String 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>
773  </table>
774</dl>
775<dl compact><dt><b>Returns:</b></dt><dd>true if set was successful, false otherwise (NB no exceptions thrown - tolerant method) </dd></dl>
776
777<p>
778Referenced by <a class="el" href="OgreStringInterface_8h-source.html#l00296">Ogre::StringInterface::copyParametersTo()</a>.    </td>
779  </tr>
780</table>
781<a class="anchor" name="Ogre_1_1Texturea48" doxytag="Ogre::LinearForceAffector::setParameterList" ></a><p>
782<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
783  <tr>
784    <td class="mdRow">
785      <table cellpadding="0" cellspacing="0" border="0">
786        <tr>
787          <td class="md" nowrap valign="top"> virtual void Ogre::StringInterface::setParameterList </td>
788          <td class="md" valign="top">(&nbsp;</td>
789          <td class="md" nowrap valign="top">const <a class="el" href="namespaceOgre.html#a62">NameValuePairList</a> &amp;&nbsp;</td>
790          <td class="mdname1" valign="top" nowrap> <em>paramList</em>          </td>
791          <td class="md" valign="top">&nbsp;)&nbsp;</td>
792          <td class="md" nowrap><code> [virtual, inherited]</code></td>
793        </tr>
794
795      </table>
796    </td>
797  </tr>
798</table>
799<table cellspacing=5 cellpadding=0 border=0>
800  <tr>
801    <td>
802      &nbsp;
803    </td>
804    <td>
805
806<p>
807Generic multiple parameter setting method.
808<p>
809<dl compact><dt><b>Remarks:</b></dt><dd>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 <a class="el" href="classOgre_1_1StringInterface.html#Ogre_1_1Texturea46">StringInterface::getParameters</a>. </dd></dl>
810<dl compact><dt><b>Parameters:</b></dt><dd>
811  <table border="0" cellspacing="2" cellpadding="0">
812    <tr><td valign=top><em>paramList</em>&nbsp;</td><td>Name/value pair list </td></tr>
813  </table>
814</dl>
815    </td>
816  </tr>
817</table>
818<hr><h2>Member Data Documentation</h2>
819<a class="anchor" name="Ogre_1_1LinearForceAffectorp1" doxytag="Ogre::LinearForceAffector::mForceApplication" ></a><p>
820<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
821  <tr>
822    <td class="mdRow">
823      <table cellpadding="0" cellspacing="0" border="0">
824        <tr>
825          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1LinearForceAffector.html#Ogre_1_1LinearForceAffectorw2">ForceApplication</a> <a class="el" href="classOgre_1_1LinearForceAffector.html#Ogre_1_1LinearForceAffectorp1">Ogre::LinearForceAffector::mForceApplication</a><code> [protected]</code>
826      </table>
827    </td>
828  </tr>
829</table>
830<table cellspacing=5 cellpadding=0 border=0>
831  <tr>
832    <td>
833      &nbsp;
834    </td>
835    <td>
836
837<p>
838How to apply force.
839<p>
840
841<p>
842Definition 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>.    </td>
843  </tr>
844</table>
845<a class="anchor" name="Ogre_1_1LinearForceAffectorp0" doxytag="Ogre::LinearForceAffector::mForceVector" ></a><p>
846<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
847  <tr>
848    <td class="mdRow">
849      <table cellpadding="0" cellspacing="0" border="0">
850        <tr>
851          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1Vector3.html">Vector3</a> <a class="el" href="classOgre_1_1LinearForceAffector.html#Ogre_1_1LinearForceAffectorp0">Ogre::LinearForceAffector::mForceVector</a><code> [protected]</code>
852      </table>
853    </td>
854  </tr>
855</table>
856<table cellspacing=5 cellpadding=0 border=0>
857  <tr>
858    <td>
859      &nbsp;
860    </td>
861    <td>
862
863<p>
864Force vector.
865<p>
866
867<p>
868Definition 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>.    </td>
869  </tr>
870</table>
871<a class="anchor" name="Ogre_1_1Texturep26" doxytag="Ogre::LinearForceAffector::mParamDictName" ></a><p>
872<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
873  <tr>
874    <td class="mdRow">
875      <table cellpadding="0" cellspacing="0" border="0">
876        <tr>
877          <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a426">String</a> <a class="el" href="classOgre_1_1StringInterface.html#Ogre_1_1Texturep26">Ogre::StringInterface::mParamDictName</a><code> [protected, inherited]</code>
878      </table>
879    </td>
880  </tr>
881</table>
882<table cellspacing=5 cellpadding=0 border=0>
883  <tr>
884    <td>
885      &nbsp;
886    </td>
887    <td>
888
889<p>
890Class name for this instance to be used as a lookup (must be initialised by subclasses).
891<p>
892
893<p>
894Definition at line <a class="el" href="OgreStringInterface_8h-source.html#l00160">160</a> of file <a class="el" href="OgreStringInterface_8h-source.html">OgreStringInterface.h</a>.    </td>
895  </tr>
896</table>
897<a class="anchor" name="Ogre_1_1ScaleAffectorp2" doxytag="Ogre::LinearForceAffector::mParent" ></a><p>
898<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
899  <tr>
900    <td class="mdRow">
901      <table cellpadding="0" cellspacing="0" border="0">
902        <tr>
903          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1ParticleSystem.html">ParticleSystem</a>* <a class="el" href="classOgre_1_1ParticleAffector.html#Ogre_1_1ScaleAffectorp2">Ogre::ParticleAffector::mParent</a><code> [protected, inherited]</code>
904      </table>
905    </td>
906  </tr>
907</table>
908<table cellspacing=5 cellpadding=0 border=0>
909  <tr>
910    <td>
911      &nbsp;
912    </td>
913    <td>
914
915<p>
916
917<p>
918Definition at line <a class="el" href="OgreParticleAffector_8h-source.html#l00070">70</a> of file <a class="el" href="OgreParticleAffector_8h-source.html">OgreParticleAffector.h</a>.    </td>
919  </tr>
920</table>
921<a class="anchor" name="Ogre_1_1Texturet0" doxytag="Ogre::LinearForceAffector::msDictionary" ></a><p>
922<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
923  <tr>
924    <td class="mdRow">
925      <table cellpadding="0" cellspacing="0" border="0">
926        <tr>
927          <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a520">ParamDictionaryMap</a> <a class="el" href="classOgre_1_1StringInterface.html#Ogre_1_1Texturet0">Ogre::StringInterface::msDictionary</a><code> [static, protected, inherited]</code>
928      </table>
929    </td>
930  </tr>
931</table>
932<table cellspacing=5 cellpadding=0 border=0>
933  <tr>
934    <td>
935      &nbsp;
936    </td>
937    <td>
938
939<p>
940Dictionary of parameters.
941<p>
942
943<p>
944Definition 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>
945  </tr>
946</table>
947<a class="anchor" name="Ogre_1_1LinearForceAffectors1" doxytag="Ogre::LinearForceAffector::msForceAppCmd" ></a><p>
948<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
949  <tr>
950    <td class="mdRow">
951      <table cellpadding="0" cellspacing="0" border="0">
952        <tr>
953          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1LinearForceAffector_1_1CmdForceApp.html">CmdForceApp</a> <a class="el" href="classOgre_1_1LinearForceAffector.html#Ogre_1_1LinearForceAffectors1">Ogre::LinearForceAffector::msForceAppCmd</a><code> [static]</code>
954      </table>
955    </td>
956  </tr>
957</table>
958<table cellspacing=5 cellpadding=0 border=0>
959  <tr>
960    <td>
961      &nbsp;
962    </td>
963    <td>
964
965<p>
966
967<p>
968Definition at line <a class="el" href="OgreLinearForceAffector_8h-source.html#l00101">101</a> of file <a class="el" href="OgreLinearForceAffector_8h-source.html">OgreLinearForceAffector.h</a>.    </td>
969  </tr>
970</table>
971<a class="anchor" name="Ogre_1_1LinearForceAffectors0" doxytag="Ogre::LinearForceAffector::msForceVectorCmd" ></a><p>
972<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
973  <tr>
974    <td class="mdRow">
975      <table cellpadding="0" cellspacing="0" border="0">
976        <tr>
977          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1LinearForceAffector_1_1CmdForceVector.html">CmdForceVector</a> <a class="el" href="classOgre_1_1LinearForceAffector.html#Ogre_1_1LinearForceAffectors0">Ogre::LinearForceAffector::msForceVectorCmd</a><code> [static]</code>
978      </table>
979    </td>
980  </tr>
981</table>
982<table cellspacing=5 cellpadding=0 border=0>
983  <tr>
984    <td>
985      &nbsp;
986    </td>
987    <td>
988
989<p>
990Command objects.
991<p>
992
993<p>
994Definition at line <a class="el" href="OgreLinearForceAffector_8h-source.html#l00100">100</a> of file <a class="el" href="OgreLinearForceAffector_8h-source.html">OgreLinearForceAffector.h</a>.    </td>
995  </tr>
996</table>
997<a class="anchor" name="Ogre_1_1ScaleAffectorp1" doxytag="Ogre::LinearForceAffector::mType" ></a><p>
998<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
999  <tr>
1000    <td class="mdRow">
1001      <table cellpadding="0" cellspacing="0" border="0">
1002        <tr>
1003          <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a426">String</a> <a class="el" href="classOgre_1_1ParticleAffector.html#Ogre_1_1ScaleAffectorp1">Ogre::ParticleAffector::mType</a><code> [protected, inherited]</code>
1004      </table>
1005    </td>
1006  </tr>
1007</table>
1008<table cellspacing=5 cellpadding=0 border=0>
1009  <tr>
1010    <td>
1011      &nbsp;
1012    </td>
1013    <td>
1014
1015<p>
1016Name of the type of affector, MUST be initialised by subclasses.
1017<p>
1018
1019<p>
1020Definition 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>.    </td>
1021  </tr>
1022</table>
1023<hr>The documentation for this class was generated from the following file:<ul>
1024<li><a class="el" href="OgreLinearForceAffector_8h-source.html">OgreLinearForceAffector.h</a></ul>
1025<hr>
1026<p>
1027Copyright &copy; 2000-2005 by The OGRE Team<br />
1028<!--Creative Commons License--><a rel="license" href="http://creativecommons.org/licenses/by-sa/2.5/"><img alt="Creative Commons License" border="0" src="http://creativecommons.org/images/public/somerights20.png"/></a><br/>
1029This work is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-sa/2.5/">Creative Commons Attribution-ShareAlike 2.5 License</a>.<br/>
1030                <!--/Creative Commons License--><!-- <rdf:RDF xmlns="http://web.resource.org/cc/" xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#">
1031                <Work rdf:about="">
1032                        <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" />
1033        <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" />
1034                </Work>
1035                <License rdf:about="http://creativecommons.org/licenses/by-sa/2.5/"><permits rdf:resource="http://web.resource.org/cc/Reproduction"/><permits rdf:resource="http://web.resource.org/cc/Distribution"/><requires rdf:resource="http://web.resource.org/cc/Notice"/><requires rdf:resource="http://web.resource.org/cc/Attribution"/><permits rdf:resource="http://web.resource.org/cc/DerivativeWorks"/><requires rdf:resource="http://web.resource.org/cc/ShareAlike"/></License></rdf:RDF> -->
1036
1037Last modified Sun Feb 12 13:07:33 2006
1038</p>
1039</body>
1040</html>
Note: See TracBrowser for help on using the repository browser.