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

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

adding ogre 1.2 and dependencies
Line 
1<html>
2<head>
3<title> TemplateOgre::ControllerFunction&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::ControllerFunction&lt; T &gt; Class Template Reference</h1>Subclasses of this class are responsible for performing a function on an input value for a <a class="el" href="classOgre_1_1Controller.html">Controller</a>. 
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_1ControllerFunction-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_1ControllerFunction.html#Ogre_1_1ControllerFunctiona0">ControllerFunction</a> (bool deltaInput)</td></tr>
19
20<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor.  <a href="#Ogre_1_1ControllerFunctiona0"></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_1ControllerFunction.html#Ogre_1_1ControllerFunctiona1">~ControllerFunction</a> ()</td></tr>
22
23<tr><td class="memItemLeft" nowrap align=right valign=top>virtual T&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ControllerFunction.html#Ogre_1_1ControllerFunctiona2">calculate</a> (T sourceValue)=0</td></tr>
24
25<tr><td colspan=2><br><h2>Protected Member Functions</h2></td></tr>
26<tr><td class="memItemLeft" nowrap align=right valign=top>T&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ControllerFunction.html#Ogre_1_1ControllerFunctionb0">getAdjustedInput</a> (T input)</td></tr>
27
28<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Gets the input value as adjusted by any delta.  <a href="#Ogre_1_1ControllerFunctionb0"></a><br><br></td></tr>
29<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr>
30<tr><td class="memItemLeft" nowrap align=right valign=top>bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ControllerFunction.html#Ogre_1_1ControllerFunctionp0">mDeltaInput</a></td></tr>
31
32<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">If true, function will add imput values together and wrap at 1.0 before evaluating.  <a href="#Ogre_1_1ControllerFunctionp0"></a><br><br></td></tr>
33<tr><td class="memItemLeft" nowrap align=right valign=top>T&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ControllerFunction.html#Ogre_1_1ControllerFunctionp1">mDeltaCount</a></td></tr>
34
35</table>
36<hr><a name="_details"></a><h2>Detailed Description</h2>
37<h3>template&lt;typename T&gt;<br>
38 class Ogre::ControllerFunction&lt; T &gt;</h3>
39
40Subclasses of this class are responsible for performing a function on an input value for a <a class="el" href="classOgre_1_1Controller.html">Controller</a>.
41<p>
42<dl compact><dt><b>Remarks:</b></dt><dd>This abstract class provides the interface that needs to be supported for a custom function which can be 'plugged in' to a <a class="el" href="classOgre_1_1Controller.html">Controller</a> instance, which controls some object value based on an input value. For example, the WaveControllerFunction class provided by <a class="el" href="namespaceOgre.html">Ogre</a> allows you to use various waveforms to translate an input value to an output value. </dd></dl>
43<dl compact><dt><b></b></dt><dd>You are free to create your own subclasses in order to define any function you wish. </dd></dl>
44
45<p>
46
47<p>
48Definition at line <a class="el" href="OgreController_8h-source.html#l00047">47</a> of file <a class="el" href="OgreController_8h-source.html">OgreController.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
49<a class="anchor" name="Ogre_1_1ControllerFunctiona0" doxytag="Ogre::ControllerFunction::ControllerFunction" ></a><p>
50<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
51  <tr>
52    <td class="mdRow">
53      <table cellpadding="0" cellspacing="0" border="0">
54        <tr>
55          <td class="md" colspan="4">
56template&lt;typename T&gt; </td>
57        </tr>
58        <tr>
59          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1ControllerFunction.html">Ogre::ControllerFunction</a>&lt; T &gt;::<a class="el" href="classOgre_1_1ControllerFunction.html">ControllerFunction</a> </td>
60          <td class="md" valign="top">(&nbsp;</td>
61          <td class="md" nowrap valign="top">bool&nbsp;</td>
62          <td class="mdname1" valign="top" nowrap> <em>deltaInput</em>          </td>
63          <td class="md" valign="top">&nbsp;)&nbsp;</td>
64          <td class="md" nowrap></td>
65        </tr>
66
67      </table>
68    </td>
69  </tr>
70</table>
71<table cellspacing=5 cellpadding=0 border=0>
72  <tr>
73    <td>
74      &nbsp;
75    </td>
76    <td>
77
78<p>
79Constructor.
80<p>
81<dl compact><dt><b>Parameters:</b></dt><dd>
82  <table border="0" cellspacing="2" cellpadding="0">
83    <tr><td valign=top><em>deltaInput</em>&nbsp;</td><td>If true, signifies that the input will be a delta value such that the function should add it to an internal counter before calculating the output. </td></tr>
84  </table>
85</dl>
86
87<p>
88Definition at line <a class="el" href="OgreController_8h-source.html#l00081">81</a> of file <a class="el" href="OgreController_8h-source.html">OgreController.h</a>.    </td>
89  </tr>
90</table>
91<a class="anchor" name="Ogre_1_1ControllerFunctiona1" doxytag="Ogre::ControllerFunction::~ControllerFunction" ></a><p>
92<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
93  <tr>
94    <td class="mdRow">
95      <table cellpadding="0" cellspacing="0" border="0">
96        <tr>
97          <td class="md" colspan="4">
98template&lt;typename T&gt; </td>
99        </tr>
100        <tr>
101          <td class="md" nowrap valign="top"> virtual <a class="el" href="classOgre_1_1ControllerFunction.html">Ogre::ControllerFunction</a>&lt; T &gt;::~<a class="el" href="classOgre_1_1ControllerFunction.html">ControllerFunction</a> </td>
102          <td class="md" valign="top">(&nbsp;</td>
103          <td class="mdname1" valign="top" nowrap>          </td>
104          <td class="md" valign="top">&nbsp;)&nbsp;</td>
105          <td class="md" nowrap><code> [virtual]</code></td>
106        </tr>
107
108      </table>
109    </td>
110  </tr>
111</table>
112<table cellspacing=5 cellpadding=0 border=0>
113  <tr>
114    <td>
115      &nbsp;
116    </td>
117    <td>
118
119<p>
120
121<p>
122Definition at line <a class="el" href="OgreController_8h-source.html#l00087">87</a> of file <a class="el" href="OgreController_8h-source.html">OgreController.h</a>.    </td>
123  </tr>
124</table>
125<hr><h2>Member Function Documentation</h2>
126<a class="anchor" name="Ogre_1_1ControllerFunctiona2" doxytag="Ogre::ControllerFunction::calculate" ></a><p>
127<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
128  <tr>
129    <td class="mdRow">
130      <table cellpadding="0" cellspacing="0" border="0">
131        <tr>
132          <td class="md" colspan="4">
133template&lt;typename T&gt; </td>
134        </tr>
135        <tr>
136          <td class="md" nowrap valign="top"> virtual T <a class="el" href="classOgre_1_1ControllerFunction.html">Ogre::ControllerFunction</a>&lt; T &gt;::calculate </td>
137          <td class="md" valign="top">(&nbsp;</td>
138          <td class="md" nowrap valign="top">T&nbsp;</td>
139          <td class="mdname1" valign="top" nowrap> <em>sourceValue</em>          </td>
140          <td class="md" valign="top">&nbsp;)&nbsp;</td>
141          <td class="md" nowrap><code> [pure virtual]</code></td>
142        </tr>
143
144      </table>
145    </td>
146  </tr>
147</table>
148<table cellspacing=5 cellpadding=0 border=0>
149  <tr>
150    <td>
151      &nbsp;
152    </td>
153    <td>
154
155<p>
156
157<p>
158Implemented in <a class="el" href="classOgre_1_1PassthroughControllerFunction.html#Ogre_1_1PassthroughControllerFunctiona1">Ogre::PassthroughControllerFunction</a>, <a class="el" href="classOgre_1_1AnimationControllerFunction.html#Ogre_1_1AnimationControllerFunctiona1">Ogre::AnimationControllerFunction</a>, <a class="el" href="classOgre_1_1ScaleControllerFunction.html#Ogre_1_1ScaleControllerFunctiona1">Ogre::ScaleControllerFunction</a>, and <a class="el" href="classOgre_1_1WaveformControllerFunction.html#Ogre_1_1WaveformControllerFunctiona1">Ogre::WaveformControllerFunction</a>.    </td>
159  </tr>
160</table>
161<a class="anchor" name="Ogre_1_1ControllerFunctionb0" doxytag="Ogre::ControllerFunction::getAdjustedInput" ></a><p>
162<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
163  <tr>
164    <td class="mdRow">
165      <table cellpadding="0" cellspacing="0" border="0">
166        <tr>
167          <td class="md" colspan="4">
168template&lt;typename T&gt; </td>
169        </tr>
170        <tr>
171          <td class="md" nowrap valign="top"> T <a class="el" href="classOgre_1_1ControllerFunction.html">Ogre::ControllerFunction</a>&lt; T &gt;::getAdjustedInput </td>
172          <td class="md" valign="top">(&nbsp;</td>
173          <td class="md" nowrap valign="top">T&nbsp;</td>
174          <td class="mdname1" valign="top" nowrap> <em>input</em>          </td>
175          <td class="md" valign="top">&nbsp;)&nbsp;</td>
176          <td class="md" nowrap><code> [protected]</code></td>
177        </tr>
178
179      </table>
180    </td>
181  </tr>
182</table>
183<table cellspacing=5 cellpadding=0 border=0>
184  <tr>
185    <td>
186      &nbsp;
187    </td>
188    <td>
189
190<p>
191Gets the input value as adjusted by any delta.
192<p>
193
194<p>
195Reimplemented in <a class="el" href="classOgre_1_1WaveformControllerFunction.html#Ogre_1_1WaveformControllerFunctionb0">Ogre::WaveformControllerFunction</a>.
196<p>
197Definition at line <a class="el" href="OgreController_8h-source.html#l00056">56</a> of file <a class="el" href="OgreController_8h-source.html">OgreController.h</a>.    </td>
198  </tr>
199</table>
200<hr><h2>Member Data Documentation</h2>
201<a class="anchor" name="Ogre_1_1ControllerFunctionp1" doxytag="Ogre::ControllerFunction::mDeltaCount" ></a><p>
202<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
203  <tr>
204    <td class="mdRow">
205      <table cellpadding="0" cellspacing="0" border="0">
206        <tr>
207          <td class="md" colspan="4">
208template&lt;typename T&gt; </td>
209        </tr>
210        <tr>
211          <td class="md" nowrap valign="top"> T <a class="el" href="classOgre_1_1ControllerFunction.html">Ogre::ControllerFunction</a>&lt; T &gt;::<a class="el" href="classOgre_1_1ControllerFunction.html#Ogre_1_1ControllerFunctionp1">mDeltaCount</a><code> [protected]</code>
212      </table>
213    </td>
214  </tr>
215</table>
216<table cellspacing=5 cellpadding=0 border=0>
217  <tr>
218    <td>
219      &nbsp;
220    </td>
221    <td>
222
223<p>
224
225<p>
226Definition at line <a class="el" href="OgreController_8h-source.html#l00052">52</a> of file <a class="el" href="OgreController_8h-source.html">OgreController.h</a>.    </td>
227  </tr>
228</table>
229<a class="anchor" name="Ogre_1_1ControllerFunctionp0" doxytag="Ogre::ControllerFunction::mDeltaInput" ></a><p>
230<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
231  <tr>
232    <td class="mdRow">
233      <table cellpadding="0" cellspacing="0" border="0">
234        <tr>
235          <td class="md" colspan="4">
236template&lt;typename T&gt; </td>
237        </tr>
238        <tr>
239          <td class="md" nowrap valign="top"> bool <a class="el" href="classOgre_1_1ControllerFunction.html">Ogre::ControllerFunction</a>&lt; T &gt;::<a class="el" href="classOgre_1_1ControllerFunction.html#Ogre_1_1ControllerFunctionp0">mDeltaInput</a><code> [protected]</code>
240      </table>
241    </td>
242  </tr>
243</table>
244<table cellspacing=5 cellpadding=0 border=0>
245  <tr>
246    <td>
247      &nbsp;
248    </td>
249    <td>
250
251<p>
252If true, function will add imput values together and wrap at 1.0 before evaluating.
253<p>
254
255<p>
256Definition at line <a class="el" href="OgreController_8h-source.html#l00051">51</a> of file <a class="el" href="OgreController_8h-source.html">OgreController.h</a>.    </td>
257  </tr>
258</table>
259<hr>The documentation for this class was generated from the following file:<ul>
260<li><a class="el" href="OgreController_8h-source.html">OgreController.h</a></ul>
261<hr>
262<p>
263Copyright &copy; 2000-2005 by The OGRE Team<br />
264<!--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/>
265This 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/>
266                <!--/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#">
267                <Work rdf:about="">
268                        <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" />
269        <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" />
270                </Work>
271                <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> -->
272
273Last modified Sun Mar 12 14:38:36 2006
274</p>
275</body>
276</html>
Note: See TracBrowser for help on using the repository browser.