source: OGRE/trunk/ogrenew/Docs/api/html/classOgre_1_1Controller.html @ 692

Revision 692, 32.0 KB checked in by mattausch, 18 years ago (diff)

adding ogre 1.2 and dependencies
Line 
1<html>
2<head>
3<title> TemplateOgre::Controller&lt; T &gt; 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::Controller&lt; T &gt; Class Template Reference</h1>Instances of this class 'control' the value of another object in the system. 
11<a href="#_details">More...</a>
12<p>
13<code>#include &lt;<a class="el" href="OgreController_8h-source.html">OgreController.h</a>&gt;</code>
14<p>
15<a href="classOgre_1_1Controller-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
16<tr><td></td></tr>
17<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
18<tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Controller.html#Ogre_1_1Controllera0">Controller</a> (const <a class="el" href="classOgre_1_1SharedPtr.html">SharedPtr</a>&lt; <a class="el" href="classOgre_1_1ControllerValue.html">ControllerValue</a>&lt; T &gt; &gt; &amp;src, const <a class="el" href="classOgre_1_1SharedPtr.html">SharedPtr</a>&lt; <a class="el" href="classOgre_1_1ControllerValue.html">ControllerValue</a>&lt; T &gt; &gt; &amp;dest, const <a class="el" href="classOgre_1_1SharedPtr.html">SharedPtr</a>&lt; <a class="el" href="classOgre_1_1ControllerFunction.html">ControllerFunction</a>&lt; T &gt; &gt; &amp;func)</td></tr>
19
20<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Usual constructor.  <a href="#Ogre_1_1Controllera0"></a><br><br></td></tr>
21<tr><td class="memItemLeft" nowrap align=right valign=top>virtual&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Controller.html#Ogre_1_1Controllera1">~Controller</a> ()</td></tr>
22
23<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default d-tor.  <a href="#Ogre_1_1Controllera1"></a><br><br></td></tr>
24<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Controller.html#Ogre_1_1Controllera2">setSource</a> (const <a class="el" href="classOgre_1_1SharedPtr.html">SharedPtr</a>&lt; <a class="el" href="classOgre_1_1ControllerValue.html">ControllerValue</a>&lt; T &gt; &gt; &amp;src)</td></tr>
25
26<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets the input controller value.  <a href="#Ogre_1_1Controllera2"></a><br><br></td></tr>
27<tr><td class="memItemLeft" nowrap align=right valign=top>const <a class="el" href="classOgre_1_1SharedPtr.html">SharedPtr</a>&lt; <a class="el" href="classOgre_1_1ControllerValue.html">ControllerValue</a>&lt;<br>
28 T &gt; &gt; &amp;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Controller.html#Ogre_1_1Controllera3">getSource</a> (void) const </td></tr>
29
30<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Gets the input controller value.  <a href="#Ogre_1_1Controllera3"></a><br><br></td></tr>
31<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Controller.html#Ogre_1_1Controllera4">setDestination</a> (const <a class="el" href="classOgre_1_1SharedPtr.html">SharedPtr</a>&lt; <a class="el" href="classOgre_1_1ControllerValue.html">ControllerValue</a>&lt; T &gt; &gt; &amp;dest)</td></tr>
32
33<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets the output controller value.  <a href="#Ogre_1_1Controllera4"></a><br><br></td></tr>
34<tr><td class="memItemLeft" nowrap align=right valign=top>const <a class="el" href="classOgre_1_1SharedPtr.html">SharedPtr</a>&lt; <a class="el" href="classOgre_1_1ControllerValue.html">ControllerValue</a>&lt;<br>
35 T &gt; &gt; &amp;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Controller.html#Ogre_1_1Controllera5">getDestination</a> (void) const </td></tr>
36
37<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Gets the output controller value.  <a href="#Ogre_1_1Controllera5"></a><br><br></td></tr>
38<tr><td class="memItemLeft" nowrap align=right valign=top>bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Controller.html#Ogre_1_1Controllera6">getEnabled</a> (void) const </td></tr>
39
40<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns true if this controller is currently enabled.  <a href="#Ogre_1_1Controllera6"></a><br><br></td></tr>
41<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Controller.html#Ogre_1_1Controllera7">setEnabled</a> (bool enabled)</td></tr>
42
43<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets whether this controller is enabled.  <a href="#Ogre_1_1Controllera7"></a><br><br></td></tr>
44<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Controller.html#Ogre_1_1Controllera8">setFunction</a> (const <a class="el" href="classOgre_1_1SharedPtr.html">SharedPtr</a>&lt; <a class="el" href="classOgre_1_1ControllerFunction.html">ControllerFunction</a>&lt; T &gt; &gt; &amp;func)</td></tr>
45
46<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets the function object to be used by this controller.  <a href="#Ogre_1_1Controllera8"></a><br><br></td></tr>
47<tr><td class="memItemLeft" nowrap align=right valign=top>const <a class="el" href="classOgre_1_1SharedPtr.html">SharedPtr</a>&lt; <a class="el" href="classOgre_1_1ControllerFunction.html">ControllerFunction</a>&lt;<br>
48 T &gt; &gt; &amp;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Controller.html#Ogre_1_1Controllera9">getFunction</a> (void) const </td></tr>
49
50<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns a pointer to the function object used by this controller.  <a href="#Ogre_1_1Controllera9"></a><br><br></td></tr>
51<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Controller.html#Ogre_1_1Controllera10">update</a> (void)</td></tr>
52
53<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Tells this controller to map it's input controller value to it's output controller value, via the controller function.  <a href="#Ogre_1_1Controllera10"></a><br><br></td></tr>
54<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr>
55<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1SharedPtr.html">SharedPtr</a>&lt; <a class="el" href="classOgre_1_1ControllerValue.html">ControllerValue</a>&lt;<br>
56 T &gt; &gt;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Controller.html#Ogre_1_1Controllerp0">mSource</a></td></tr>
57
58<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Source value.  <a href="#Ogre_1_1Controllerp0"></a><br><br></td></tr>
59<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1SharedPtr.html">SharedPtr</a>&lt; <a class="el" href="classOgre_1_1ControllerValue.html">ControllerValue</a>&lt;<br>
60 T &gt; &gt;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Controller.html#Ogre_1_1Controllerp1">mDest</a></td></tr>
61
62<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destination value.  <a href="#Ogre_1_1Controllerp1"></a><br><br></td></tr>
63<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1SharedPtr.html">SharedPtr</a>&lt; <a class="el" href="classOgre_1_1ControllerFunction.html">ControllerFunction</a>&lt;<br>
64 T &gt; &gt;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Controller.html#Ogre_1_1Controllerp2">mFunc</a></td></tr>
65
66<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Function.  <a href="#Ogre_1_1Controllerp2"></a><br><br></td></tr>
67<tr><td class="memItemLeft" nowrap align=right valign=top>bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Controller.html#Ogre_1_1Controllerp3">mEnabled</a></td></tr>
68
69<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight"><a class="el" href="classOgre_1_1Controller.html">Controller</a> is enabled or not.  <a href="#Ogre_1_1Controllerp3"></a><br><br></td></tr>
70</table>
71<hr><a name="_details"></a><h2>Detailed Description</h2>
72<h3>template&lt;typename T&gt;<br>
73 class Ogre::Controller&lt; T &gt;</h3>
74
75Instances of this class 'control' the value of another object in the system.
76<p>
77<dl compact><dt><b>Remarks:</b></dt><dd><a class="el" href="classOgre_1_1Controller.html">Controller</a> classes are used to manage the values of object automatically based on the value of some input. For example, a <a class="el" href="classOgre_1_1Controller.html">Controller</a> could animate a texture by controlling the current frame of the texture based on time, or a different <a class="el" href="classOgre_1_1Controller.html">Controller</a> could change the colour of a material used for a spaceship shield mesh based on the remaining shield power level of the ship. </dd></dl>
78<dl compact><dt><b></b></dt><dd>The <a class="el" href="classOgre_1_1Controller.html">Controller</a> is an intentionally abstract concept - it can generate values based on input and a function, which can either be one of the standard ones supplied, or a function can be 'plugged in' for custom behaviour - see the <a class="el" href="classOgre_1_1ControllerFunction.html">ControllerFunction</a> class for details. Both the input and output values are via <a class="el" href="classOgre_1_1ControllerValue.html">ControllerValue</a> objects, meaning that any value can be both input and output of the controller. </dd></dl>
79<dl compact><dt><b></b></dt><dd>Whilst this is very flexible, it can be a little bit confusing so to make it simpler the most often used controller setups are available by calling methods on the <a class="el" href="classOgre_1_1ControllerManager.html">ControllerManager</a> object. </dd></dl>
80<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="classOgre_1_1ControllerFunction.html">ControllerFunction</a> </dd></dl>
81
82<p>
83
84<p>
85Definition at line <a class="el" href="OgreController_8h-source.html#l00127">127</a> of file <a class="el" href="OgreController_8h-source.html">OgreController.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
86<a class="anchor" name="Ogre_1_1Controllera0" doxytag="Ogre::Controller::Controller" ></a><p>
87<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
88  <tr>
89    <td class="mdRow">
90      <table cellpadding="0" cellspacing="0" border="0">
91        <tr>
92          <td class="md" colspan="4">
93template&lt;typename T&gt; </td>
94        </tr>
95        <tr>
96          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1Controller.html">Ogre::Controller</a>&lt; T &gt;::<a class="el" href="classOgre_1_1Controller.html">Controller</a> </td>
97          <td class="md" valign="top">(&nbsp;</td>
98          <td class="md" nowrap valign="top">const <a class="el" href="classOgre_1_1SharedPtr.html">SharedPtr</a>&lt; <a class="el" href="classOgre_1_1ControllerValue.html">ControllerValue</a>&lt; T &gt; &gt; &amp;&nbsp;</td>
99          <td class="mdname" nowrap> <em>src</em>, </td>
100        </tr>
101        <tr>
102          <td class="md" nowrap align="right"></td>
103          <td></td>
104          <td class="md" nowrap>const <a class="el" href="classOgre_1_1SharedPtr.html">SharedPtr</a>&lt; <a class="el" href="classOgre_1_1ControllerValue.html">ControllerValue</a>&lt; T &gt; &gt; &amp;&nbsp;</td>
105          <td class="mdname" nowrap> <em>dest</em>, </td>
106        </tr>
107        <tr>
108          <td class="md" nowrap align="right"></td>
109          <td></td>
110          <td class="md" nowrap>const <a class="el" href="classOgre_1_1SharedPtr.html">SharedPtr</a>&lt; <a class="el" href="classOgre_1_1ControllerFunction.html">ControllerFunction</a>&lt; T &gt; &gt; &amp;&nbsp;</td>
111          <td class="mdname" nowrap> <em>func</em></td>
112        </tr>
113        <tr>
114          <td></td>
115          <td class="md">)&nbsp;</td>
116          <td class="md" colspan="2"></td>
117        </tr>
118
119      </table>
120    </td>
121  </tr>
122</table>
123<table cellspacing=5 cellpadding=0 border=0>
124  <tr>
125    <td>
126      &nbsp;
127    </td>
128    <td>
129
130<p>
131Usual constructor.
132<p>
133<dl compact><dt><b>Remarks:</b></dt><dd>Requires source and destination values, and a function object. None of these are destroyed with the <a class="el" href="classOgre_1_1Controller.html">Controller</a> when it is deleted (they can be shared) so you must delete these as appropriate. </dd></dl>
134
135<p>
136Definition at line <a class="el" href="OgreController_8h-source.html#l00147">147</a> of file <a class="el" href="OgreController_8h-source.html">OgreController.h</a>.    </td>
137  </tr>
138</table>
139<a class="anchor" name="Ogre_1_1Controllera1" doxytag="Ogre::Controller::~Controller" ></a><p>
140<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
141  <tr>
142    <td class="mdRow">
143      <table cellpadding="0" cellspacing="0" border="0">
144        <tr>
145          <td class="md" colspan="4">
146template&lt;typename T&gt; </td>
147        </tr>
148        <tr>
149          <td class="md" nowrap valign="top"> virtual <a class="el" href="classOgre_1_1Controller.html">Ogre::Controller</a>&lt; T &gt;::~<a class="el" href="classOgre_1_1Controller.html">Controller</a> </td>
150          <td class="md" valign="top">(&nbsp;</td>
151          <td class="mdname1" valign="top" nowrap>          </td>
152          <td class="md" valign="top">&nbsp;)&nbsp;</td>
153          <td class="md" nowrap><code> [virtual]</code></td>
154        </tr>
155
156      </table>
157    </td>
158  </tr>
159</table>
160<table cellspacing=5 cellpadding=0 border=0>
161  <tr>
162    <td>
163      &nbsp;
164    </td>
165    <td>
166
167<p>
168Default d-tor.
169<p>
170
171<p>
172Definition at line <a class="el" href="OgreController_8h-source.html#l00156">156</a> of file <a class="el" href="OgreController_8h-source.html">OgreController.h</a>.    </td>
173  </tr>
174</table>
175<hr><h2>Member Function Documentation</h2>
176<a class="anchor" name="Ogre_1_1Controllera5" doxytag="Ogre::Controller::getDestination" ></a><p>
177<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
178  <tr>
179    <td class="mdRow">
180      <table cellpadding="0" cellspacing="0" border="0">
181        <tr>
182          <td class="md" colspan="4">
183template&lt;typename T&gt; </td>
184        </tr>
185        <tr>
186          <td class="md" nowrap valign="top"> const <a class="el" href="classOgre_1_1SharedPtr.html">SharedPtr</a>&lt; <a class="el" href="classOgre_1_1ControllerValue.html">ControllerValue</a>&lt;T&gt; &gt;&amp; <a class="el" href="classOgre_1_1Controller.html">Ogre::Controller</a>&lt; T &gt;::getDestination </td>
187          <td class="md" valign="top">(&nbsp;</td>
188          <td class="md" nowrap valign="top">void&nbsp;</td>
189          <td class="mdname1" valign="top" nowrap>          </td>
190          <td class="md" valign="top">&nbsp;)&nbsp;</td>
191          <td class="md" nowrap> const</td>
192        </tr>
193
194      </table>
195    </td>
196  </tr>
197</table>
198<table cellspacing=5 cellpadding=0 border=0>
199  <tr>
200    <td>
201      &nbsp;
202    </td>
203    <td>
204
205<p>
206Gets the output controller value.
207<p>
208
209<p>
210Definition at line <a class="el" href="OgreController_8h-source.html#l00176">176</a> of file <a class="el" href="OgreController_8h-source.html">OgreController.h</a>.    </td>
211  </tr>
212</table>
213<a class="anchor" name="Ogre_1_1Controllera6" doxytag="Ogre::Controller::getEnabled" ></a><p>
214<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
215  <tr>
216    <td class="mdRow">
217      <table cellpadding="0" cellspacing="0" border="0">
218        <tr>
219          <td class="md" colspan="4">
220template&lt;typename T&gt; </td>
221        </tr>
222        <tr>
223          <td class="md" nowrap valign="top"> bool <a class="el" href="classOgre_1_1Controller.html">Ogre::Controller</a>&lt; T &gt;::getEnabled </td>
224          <td class="md" valign="top">(&nbsp;</td>
225          <td class="md" nowrap valign="top">void&nbsp;</td>
226          <td class="mdname1" valign="top" nowrap>          </td>
227          <td class="md" valign="top">&nbsp;)&nbsp;</td>
228          <td class="md" nowrap> const</td>
229        </tr>
230
231      </table>
232    </td>
233  </tr>
234</table>
235<table cellspacing=5 cellpadding=0 border=0>
236  <tr>
237    <td>
238      &nbsp;
239    </td>
240    <td>
241
242<p>
243Returns true if this controller is currently enabled.
244<p>
245
246<p>
247Definition at line <a class="el" href="OgreController_8h-source.html#l00182">182</a> of file <a class="el" href="OgreController_8h-source.html">OgreController.h</a>.    </td>
248  </tr>
249</table>
250<a class="anchor" name="Ogre_1_1Controllera9" doxytag="Ogre::Controller::getFunction" ></a><p>
251<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
252  <tr>
253    <td class="mdRow">
254      <table cellpadding="0" cellspacing="0" border="0">
255        <tr>
256          <td class="md" colspan="4">
257template&lt;typename T&gt; </td>
258        </tr>
259        <tr>
260          <td class="md" nowrap valign="top"> const <a class="el" href="classOgre_1_1SharedPtr.html">SharedPtr</a>&lt; <a class="el" href="classOgre_1_1ControllerFunction.html">ControllerFunction</a>&lt;T&gt; &gt;&amp; <a class="el" href="classOgre_1_1Controller.html">Ogre::Controller</a>&lt; T &gt;::getFunction </td>
261          <td class="md" valign="top">(&nbsp;</td>
262          <td class="md" nowrap valign="top">void&nbsp;</td>
263          <td class="mdname1" valign="top" nowrap>          </td>
264          <td class="md" valign="top">&nbsp;)&nbsp;</td>
265          <td class="md" nowrap> const</td>
266        </tr>
267
268      </table>
269    </td>
270  </tr>
271</table>
272<table cellspacing=5 cellpadding=0 border=0>
273  <tr>
274    <td>
275      &nbsp;
276    </td>
277    <td>
278
279<p>
280Returns a pointer to the function object used by this controller.
281<p>
282
283<p>
284Definition at line <a class="el" href="OgreController_8h-source.html#l00202">202</a> of file <a class="el" href="OgreController_8h-source.html">OgreController.h</a>.    </td>
285  </tr>
286</table>
287<a class="anchor" name="Ogre_1_1Controllera3" doxytag="Ogre::Controller::getSource" ></a><p>
288<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
289  <tr>
290    <td class="mdRow">
291      <table cellpadding="0" cellspacing="0" border="0">
292        <tr>
293          <td class="md" colspan="4">
294template&lt;typename T&gt; </td>
295        </tr>
296        <tr>
297          <td class="md" nowrap valign="top"> const <a class="el" href="classOgre_1_1SharedPtr.html">SharedPtr</a>&lt; <a class="el" href="classOgre_1_1ControllerValue.html">ControllerValue</a>&lt;T&gt; &gt;&amp; <a class="el" href="classOgre_1_1Controller.html">Ogre::Controller</a>&lt; T &gt;::getSource </td>
298          <td class="md" valign="top">(&nbsp;</td>
299          <td class="md" nowrap valign="top">void&nbsp;</td>
300          <td class="mdname1" valign="top" nowrap>          </td>
301          <td class="md" valign="top">&nbsp;)&nbsp;</td>
302          <td class="md" nowrap> const</td>
303        </tr>
304
305      </table>
306    </td>
307  </tr>
308</table>
309<table cellspacing=5 cellpadding=0 border=0>
310  <tr>
311    <td>
312      &nbsp;
313    </td>
314    <td>
315
316<p>
317Gets the input controller value.
318<p>
319
320<p>
321Definition at line <a class="el" href="OgreController_8h-source.html#l00165">165</a> of file <a class="el" href="OgreController_8h-source.html">OgreController.h</a>.    </td>
322  </tr>
323</table>
324<a class="anchor" name="Ogre_1_1Controllera4" doxytag="Ogre::Controller::setDestination" ></a><p>
325<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
326  <tr>
327    <td class="mdRow">
328      <table cellpadding="0" cellspacing="0" border="0">
329        <tr>
330          <td class="md" colspan="4">
331template&lt;typename T&gt; </td>
332        </tr>
333        <tr>
334          <td class="md" nowrap valign="top"> void <a class="el" href="classOgre_1_1Controller.html">Ogre::Controller</a>&lt; T &gt;::setDestination </td>
335          <td class="md" valign="top">(&nbsp;</td>
336          <td class="md" nowrap valign="top">const <a class="el" href="classOgre_1_1SharedPtr.html">SharedPtr</a>&lt; <a class="el" href="classOgre_1_1ControllerValue.html">ControllerValue</a>&lt; T &gt; &gt; &amp;&nbsp;</td>
337          <td class="mdname1" valign="top" nowrap> <em>dest</em>          </td>
338          <td class="md" valign="top">&nbsp;)&nbsp;</td>
339          <td class="md" nowrap></td>
340        </tr>
341
342      </table>
343    </td>
344  </tr>
345</table>
346<table cellspacing=5 cellpadding=0 border=0>
347  <tr>
348    <td>
349      &nbsp;
350    </td>
351    <td>
352
353<p>
354Sets the output controller value.
355<p>
356
357<p>
358Definition at line <a class="el" href="OgreController_8h-source.html#l00170">170</a> of file <a class="el" href="OgreController_8h-source.html">OgreController.h</a>.    </td>
359  </tr>
360</table>
361<a class="anchor" name="Ogre_1_1Controllera7" doxytag="Ogre::Controller::setEnabled" ></a><p>
362<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
363  <tr>
364    <td class="mdRow">
365      <table cellpadding="0" cellspacing="0" border="0">
366        <tr>
367          <td class="md" colspan="4">
368template&lt;typename T&gt; </td>
369        </tr>
370        <tr>
371          <td class="md" nowrap valign="top"> void <a class="el" href="classOgre_1_1Controller.html">Ogre::Controller</a>&lt; T &gt;::setEnabled </td>
372          <td class="md" valign="top">(&nbsp;</td>
373          <td class="md" nowrap valign="top">bool&nbsp;</td>
374          <td class="mdname1" valign="top" nowrap> <em>enabled</em>          </td>
375          <td class="md" valign="top">&nbsp;)&nbsp;</td>
376          <td class="md" nowrap></td>
377        </tr>
378
379      </table>
380    </td>
381  </tr>
382</table>
383<table cellspacing=5 cellpadding=0 border=0>
384  <tr>
385    <td>
386      &nbsp;
387    </td>
388    <td>
389
390<p>
391Sets whether this controller is enabled.
392<p>
393
394<p>
395Definition at line <a class="el" href="OgreController_8h-source.html#l00188">188</a> of file <a class="el" href="OgreController_8h-source.html">OgreController.h</a>.    </td>
396  </tr>
397</table>
398<a class="anchor" name="Ogre_1_1Controllera8" doxytag="Ogre::Controller::setFunction" ></a><p>
399<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
400  <tr>
401    <td class="mdRow">
402      <table cellpadding="0" cellspacing="0" border="0">
403        <tr>
404          <td class="md" colspan="4">
405template&lt;typename T&gt; </td>
406        </tr>
407        <tr>
408          <td class="md" nowrap valign="top"> void <a class="el" href="classOgre_1_1Controller.html">Ogre::Controller</a>&lt; T &gt;::setFunction </td>
409          <td class="md" valign="top">(&nbsp;</td>
410          <td class="md" nowrap valign="top">const <a class="el" href="classOgre_1_1SharedPtr.html">SharedPtr</a>&lt; <a class="el" href="classOgre_1_1ControllerFunction.html">ControllerFunction</a>&lt; T &gt; &gt; &amp;&nbsp;</td>
411          <td class="mdname1" valign="top" nowrap> <em>func</em>          </td>
412          <td class="md" valign="top">&nbsp;)&nbsp;</td>
413          <td class="md" nowrap></td>
414        </tr>
415
416      </table>
417    </td>
418  </tr>
419</table>
420<table cellspacing=5 cellpadding=0 border=0>
421  <tr>
422    <td>
423      &nbsp;
424    </td>
425    <td>
426
427<p>
428Sets the function object to be used by this controller.
429<p>
430
431<p>
432Definition at line <a class="el" href="OgreController_8h-source.html#l00195">195</a> of file <a class="el" href="OgreController_8h-source.html">OgreController.h</a>.    </td>
433  </tr>
434</table>
435<a class="anchor" name="Ogre_1_1Controllera2" doxytag="Ogre::Controller::setSource" ></a><p>
436<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
437  <tr>
438    <td class="mdRow">
439      <table cellpadding="0" cellspacing="0" border="0">
440        <tr>
441          <td class="md" colspan="4">
442template&lt;typename T&gt; </td>
443        </tr>
444        <tr>
445          <td class="md" nowrap valign="top"> void <a class="el" href="classOgre_1_1Controller.html">Ogre::Controller</a>&lt; T &gt;::setSource </td>
446          <td class="md" valign="top">(&nbsp;</td>
447          <td class="md" nowrap valign="top">const <a class="el" href="classOgre_1_1SharedPtr.html">SharedPtr</a>&lt; <a class="el" href="classOgre_1_1ControllerValue.html">ControllerValue</a>&lt; T &gt; &gt; &amp;&nbsp;</td>
448          <td class="mdname1" valign="top" nowrap> <em>src</em>          </td>
449          <td class="md" valign="top">&nbsp;)&nbsp;</td>
450          <td class="md" nowrap></td>
451        </tr>
452
453      </table>
454    </td>
455  </tr>
456</table>
457<table cellspacing=5 cellpadding=0 border=0>
458  <tr>
459    <td>
460      &nbsp;
461    </td>
462    <td>
463
464<p>
465Sets the input controller value.
466<p>
467
468<p>
469Definition at line <a class="el" href="OgreController_8h-source.html#l00160">160</a> of file <a class="el" href="OgreController_8h-source.html">OgreController.h</a>.    </td>
470  </tr>
471</table>
472<a class="anchor" name="Ogre_1_1Controllera10" doxytag="Ogre::Controller::update" ></a><p>
473<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
474  <tr>
475    <td class="mdRow">
476      <table cellpadding="0" cellspacing="0" border="0">
477        <tr>
478          <td class="md" colspan="4">
479template&lt;typename T&gt; </td>
480        </tr>
481        <tr>
482          <td class="md" nowrap valign="top"> void <a class="el" href="classOgre_1_1Controller.html">Ogre::Controller</a>&lt; T &gt;::update </td>
483          <td class="md" valign="top">(&nbsp;</td>
484          <td class="md" nowrap valign="top">void&nbsp;</td>
485          <td class="mdname1" valign="top" nowrap>          </td>
486          <td class="md" valign="top">&nbsp;)&nbsp;</td>
487          <td class="md" nowrap></td>
488        </tr>
489
490      </table>
491    </td>
492  </tr>
493</table>
494<table cellspacing=5 cellpadding=0 border=0>
495  <tr>
496    <td>
497      &nbsp;
498    </td>
499    <td>
500
501<p>
502Tells this controller to map it's input controller value to it's output controller value, via the controller function.
503<p>
504<dl compact><dt><b>Remarks:</b></dt><dd>This method is called automatically every frame by <a class="el" href="classOgre_1_1ControllerManager.html">ControllerManager</a>.</dd></dl>
505
506<p>
507Definition at line <a class="el" href="OgreController_8h-source.html#l00212">212</a> of file <a class="el" href="OgreController_8h-source.html">OgreController.h</a>.    </td>
508  </tr>
509</table>
510<hr><h2>Member Data Documentation</h2>
511<a class="anchor" name="Ogre_1_1Controllerp1" doxytag="Ogre::Controller::mDest" ></a><p>
512<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
513  <tr>
514    <td class="mdRow">
515      <table cellpadding="0" cellspacing="0" border="0">
516        <tr>
517          <td class="md" colspan="4">
518template&lt;typename T&gt; </td>
519        </tr>
520        <tr>
521          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1SharedPtr.html">SharedPtr</a>&lt; <a class="el" href="classOgre_1_1ControllerValue.html">ControllerValue</a>&lt;T&gt; &gt; <a class="el" href="classOgre_1_1Controller.html">Ogre::Controller</a>&lt; T &gt;::<a class="el" href="classOgre_1_1Controller.html#Ogre_1_1Controllerp1">mDest</a><code> [protected]</code>
522      </table>
523    </td>
524  </tr>
525</table>
526<table cellspacing=5 cellpadding=0 border=0>
527  <tr>
528    <td>
529      &nbsp;
530    </td>
531    <td>
532
533<p>
534Destination value.
535<p>
536
537<p>
538Definition at line <a class="el" href="OgreController_8h-source.html#l00133">133</a> of file <a class="el" href="OgreController_8h-source.html">OgreController.h</a>.    </td>
539  </tr>
540</table>
541<a class="anchor" name="Ogre_1_1Controllerp3" doxytag="Ogre::Controller::mEnabled" ></a><p>
542<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
543  <tr>
544    <td class="mdRow">
545      <table cellpadding="0" cellspacing="0" border="0">
546        <tr>
547          <td class="md" colspan="4">
548template&lt;typename T&gt; </td>
549        </tr>
550        <tr>
551          <td class="md" nowrap valign="top"> bool <a class="el" href="classOgre_1_1Controller.html">Ogre::Controller</a>&lt; T &gt;::<a class="el" href="classOgre_1_1Controller.html#Ogre_1_1Controllerp3">mEnabled</a><code> [protected]</code>
552      </table>
553    </td>
554  </tr>
555</table>
556<table cellspacing=5 cellpadding=0 border=0>
557  <tr>
558    <td>
559      &nbsp;
560    </td>
561    <td>
562
563<p>
564<a class="el" href="classOgre_1_1Controller.html">Controller</a> is enabled or not.
565<p>
566
567<p>
568Definition at line <a class="el" href="OgreController_8h-source.html#l00137">137</a> of file <a class="el" href="OgreController_8h-source.html">OgreController.h</a>.    </td>
569  </tr>
570</table>
571<a class="anchor" name="Ogre_1_1Controllerp2" doxytag="Ogre::Controller::mFunc" ></a><p>
572<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
573  <tr>
574    <td class="mdRow">
575      <table cellpadding="0" cellspacing="0" border="0">
576        <tr>
577          <td class="md" colspan="4">
578template&lt;typename T&gt; </td>
579        </tr>
580        <tr>
581          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1SharedPtr.html">SharedPtr</a>&lt; <a class="el" href="classOgre_1_1ControllerFunction.html">ControllerFunction</a>&lt;T&gt; &gt; <a class="el" href="classOgre_1_1Controller.html">Ogre::Controller</a>&lt; T &gt;::<a class="el" href="classOgre_1_1Controller.html#Ogre_1_1Controllerp2">mFunc</a><code> [protected]</code>
582      </table>
583    </td>
584  </tr>
585</table>
586<table cellspacing=5 cellpadding=0 border=0>
587  <tr>
588    <td>
589      &nbsp;
590    </td>
591    <td>
592
593<p>
594Function.
595<p>
596
597<p>
598Definition at line <a class="el" href="OgreController_8h-source.html#l00135">135</a> of file <a class="el" href="OgreController_8h-source.html">OgreController.h</a>.    </td>
599  </tr>
600</table>
601<a class="anchor" name="Ogre_1_1Controllerp0" doxytag="Ogre::Controller::mSource" ></a><p>
602<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
603  <tr>
604    <td class="mdRow">
605      <table cellpadding="0" cellspacing="0" border="0">
606        <tr>
607          <td class="md" colspan="4">
608template&lt;typename T&gt; </td>
609        </tr>
610        <tr>
611          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1SharedPtr.html">SharedPtr</a>&lt; <a class="el" href="classOgre_1_1ControllerValue.html">ControllerValue</a>&lt;T&gt; &gt; <a class="el" href="classOgre_1_1Controller.html">Ogre::Controller</a>&lt; T &gt;::<a class="el" href="classOgre_1_1Controller.html#Ogre_1_1Controllerp0">mSource</a><code> [protected]</code>
612      </table>
613    </td>
614  </tr>
615</table>
616<table cellspacing=5 cellpadding=0 border=0>
617  <tr>
618    <td>
619      &nbsp;
620    </td>
621    <td>
622
623<p>
624Source value.
625<p>
626
627<p>
628Definition at line <a class="el" href="OgreController_8h-source.html#l00131">131</a> of file <a class="el" href="OgreController_8h-source.html">OgreController.h</a>.    </td>
629  </tr>
630</table>
631<hr>The documentation for this class was generated from the following file:<ul>
632<li><a class="el" href="OgreController_8h-source.html">OgreController.h</a></ul>
633<hr>
634<p>
635Copyright &copy; 2000-2005 by The OGRE Team<br />
636<!--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/>
637This 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/>
638                <!--/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#">
639                <Work rdf:about="">
640                        <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" />
641        <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" />
642                </Work>
643                <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> -->
644
645Last modified Sun Mar 12 14:38:36 2006
646</p>
647</body>
648</html>
Note: See TracBrowser for help on using the repository browser.