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

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

added ogre dependencies and patched ogre sources
Line 
1<html>
2<head>
3<title>Ogre::AnimationControllerFunction 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::AnimationControllerFunction Class Reference</h1>Predefined controller function for dealing with animation. 
11<a href="#_details">More...</a>
12<p>
13<code>#include &lt;<a class="el" href="OgrePredefinedControllers_8h-source.html">OgrePredefinedControllers.h</a>&gt;</code>
14<p>
15<p>Inheritance diagram for Ogre::AnimationControllerFunction:
16<p><center><img src="classOgre_1_1AnimationControllerFunction.png" usemap="#Ogre::AnimationControllerFunction_map" border="0" alt=""></center>
17<map name="Ogre::AnimationControllerFunction_map">
18<area href="classOgre_1_1ControllerFunction.html" alt="Ogre::ControllerFunction< Real >" shape="rect" coords="0,0,207,24">
19</map>
20<a href="classOgre_1_1AnimationControllerFunction-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
21<tr><td></td></tr>
22<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
23<tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1AnimationControllerFunction.html#Ogre_1_1AnimationControllerFunctiona0">AnimationControllerFunction</a> (<a class="el" href="namespaceOgre.html#a420">Real</a> sequenceTime, <a class="el" href="namespaceOgre.html#a420">Real</a> timeOffset=0.0f)</td></tr>
24
25<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor.  <a href="#Ogre_1_1AnimationControllerFunctiona0"></a><br><br></td></tr>
26<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a420">Real</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1AnimationControllerFunction.html#Ogre_1_1AnimationControllerFunctiona1">calculate</a> (<a class="el" href="namespaceOgre.html#a420">Real</a> source)</td></tr>
27
28<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Overriden function.  <a href="#Ogre_1_1AnimationControllerFunctiona1"></a><br><br></td></tr>
29<tr><td colspan=2><br><h2>Protected Member Functions</h2></td></tr>
30<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a420">Real</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ControllerFunction.html#Ogre_1_1ControllerFunctionb0">getAdjustedInput</a> (Realinput)</td></tr>
31
32<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>
33<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr>
34<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a420">Real</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1AnimationControllerFunction.html#Ogre_1_1AnimationControllerFunctionp0">mSeqTime</a></td></tr>
35
36<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a420">Real</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1AnimationControllerFunction.html#Ogre_1_1AnimationControllerFunctionp1">mTime</a></td></tr>
37
38<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>
39
40<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>
41<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a420">Real</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ControllerFunction.html#Ogre_1_1ControllerFunctionp1">mDeltaCount</a></td></tr>
42
43</table>
44<hr><a name="_details"></a><h2>Detailed Description</h2>
45Predefined controller function for dealing with animation.
46<p>
47
48<p>
49Definition at line <a class="el" href="OgrePredefinedControllers_8h-source.html#l00160">160</a> of file <a class="el" href="OgrePredefinedControllers_8h-source.html">OgrePredefinedControllers.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
50<a class="anchor" name="Ogre_1_1AnimationControllerFunctiona0" doxytag="Ogre::AnimationControllerFunction::AnimationControllerFunction" ></a><p>
51<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
52  <tr>
53    <td class="mdRow">
54      <table cellpadding="0" cellspacing="0" border="0">
55        <tr>
56          <td class="md" nowrap valign="top"> Ogre::AnimationControllerFunction::AnimationControllerFunction </td>
57          <td class="md" valign="top">(&nbsp;</td>
58          <td class="md" nowrap valign="top"><a class="el" href="namespaceOgre.html#a420">Real</a>&nbsp;</td>
59          <td class="mdname" nowrap> <em>sequenceTime</em>, </td>
60        </tr>
61        <tr>
62          <td class="md" nowrap align="right"></td>
63          <td></td>
64          <td class="md" nowrap><a class="el" href="namespaceOgre.html#a420">Real</a>&nbsp;</td>
65          <td class="mdname" nowrap> <em>timeOffset</em> = 0.0f</td>
66        </tr>
67        <tr>
68          <td></td>
69          <td class="md">)&nbsp;</td>
70          <td class="md" colspan="2"></td>
71        </tr>
72
73      </table>
74    </td>
75  </tr>
76</table>
77<table cellspacing=5 cellpadding=0 border=0>
78  <tr>
79    <td>
80      &nbsp;
81    </td>
82    <td>
83
84<p>
85Constructor.
86<p>
87<dl compact><dt><b>Parameters:</b></dt><dd>
88  <table border="0" cellspacing="2" cellpadding="0">
89    <tr><td valign=top><em>sequenceTime</em>&nbsp;</td><td>The amount of time in seconds it takes to loop through the whole animation sequence. </td></tr>
90    <tr><td valign=top><em>timeOffset</em>&nbsp;</td><td>The offset in seconds at which to start (default is start at 0) </td></tr>
91  </table>
92</dl>
93    </td>
94  </tr>
95</table>
96<hr><h2>Member Function Documentation</h2>
97<a class="anchor" name="Ogre_1_1AnimationControllerFunctiona1" doxytag="Ogre::AnimationControllerFunction::calculate" ></a><p>
98<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
99  <tr>
100    <td class="mdRow">
101      <table cellpadding="0" cellspacing="0" border="0">
102        <tr>
103          <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a420">Real</a> Ogre::AnimationControllerFunction::calculate </td>
104          <td class="md" valign="top">(&nbsp;</td>
105          <td class="md" nowrap valign="top"><a class="el" href="namespaceOgre.html#a420">Real</a>&nbsp;</td>
106          <td class="mdname1" valign="top" nowrap> <em>source</em>          </td>
107          <td class="md" valign="top">&nbsp;)&nbsp;</td>
108          <td class="md" nowrap><code> [virtual]</code></td>
109        </tr>
110
111      </table>
112    </td>
113  </tr>
114</table>
115<table cellspacing=5 cellpadding=0 border=0>
116  <tr>
117    <td>
118      &nbsp;
119    </td>
120    <td>
121
122<p>
123Overriden function.
124<p>
125
126<p>
127Implements <a class="el" href="classOgre_1_1ControllerFunction.html#Ogre_1_1ControllerFunctiona2">Ogre::ControllerFunction&lt; Real &gt;</a>.    </td>
128  </tr>
129</table>
130<a class="anchor" name="Ogre_1_1ControllerFunctionb0" doxytag="Ogre::AnimationControllerFunction::getAdjustedInput" ></a><p>
131<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
132  <tr>
133    <td class="mdRow">
134      <table cellpadding="0" cellspacing="0" border="0">
135        <tr>
136          <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a420">Real</a>  <a class="el" href="classOgre_1_1ControllerFunction.html">Ogre::ControllerFunction</a>&lt; <a class="el" href="namespaceOgre.html#a420">Real</a>  &gt;::getAdjustedInput </td>
137          <td class="md" valign="top">(&nbsp;</td>
138          <td class="md" nowrap valign="top"><a class="el" href="namespaceOgre.html#a420">Real</a> &nbsp;</td>
139          <td class="mdname1" valign="top" nowrap> <em>input</em>          </td>
140          <td class="md" valign="top">&nbsp;)&nbsp;</td>
141          <td class="md" nowrap><code> [protected, inherited]</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>
156Gets the input value as adjusted by any delta.
157<p>
158
159<p>
160Reimplemented in <a class="el" href="classOgre_1_1WaveformControllerFunction.html#Ogre_1_1WaveformControllerFunctionb0">Ogre::WaveformControllerFunction</a>.
161<p>
162Definition 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>
163  </tr>
164</table>
165<hr><h2>Member Data Documentation</h2>
166<a class="anchor" name="Ogre_1_1ControllerFunctionp1" doxytag="Ogre::AnimationControllerFunction::mDeltaCount" ></a><p>
167<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
168  <tr>
169    <td class="mdRow">
170      <table cellpadding="0" cellspacing="0" border="0">
171        <tr>
172          <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a420">Real</a>  <a class="el" href="classOgre_1_1ControllerFunction.html">Ogre::ControllerFunction</a>&lt; <a class="el" href="namespaceOgre.html#a420">Real</a>  &gt;::<a class="el" href="classOgre_1_1ControllerFunction.html#Ogre_1_1ControllerFunctionp1">mDeltaCount</a><code> [protected, inherited]</code>
173      </table>
174    </td>
175  </tr>
176</table>
177<table cellspacing=5 cellpadding=0 border=0>
178  <tr>
179    <td>
180      &nbsp;
181    </td>
182    <td>
183
184<p>
185
186<p>
187Definition 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>
188  </tr>
189</table>
190<a class="anchor" name="Ogre_1_1ControllerFunctionp0" doxytag="Ogre::AnimationControllerFunction::mDeltaInput" ></a><p>
191<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
192  <tr>
193    <td class="mdRow">
194      <table cellpadding="0" cellspacing="0" border="0">
195        <tr>
196          <td class="md" nowrap valign="top"> bool <a class="el" href="classOgre_1_1ControllerFunction.html">Ogre::ControllerFunction</a>&lt; <a class="el" href="namespaceOgre.html#a420">Real</a>  &gt;::<a class="el" href="classOgre_1_1ControllerFunction.html#Ogre_1_1ControllerFunctionp0">mDeltaInput</a><code> [protected, inherited]</code>
197      </table>
198    </td>
199  </tr>
200</table>
201<table cellspacing=5 cellpadding=0 border=0>
202  <tr>
203    <td>
204      &nbsp;
205    </td>
206    <td>
207
208<p>
209If true, function will add imput values together and wrap at 1.0 before evaluating.
210<p>
211
212<p>
213Definition 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>
214  </tr>
215</table>
216<a class="anchor" name="Ogre_1_1AnimationControllerFunctionp0" doxytag="Ogre::AnimationControllerFunction::mSeqTime" ></a><p>
217<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
218  <tr>
219    <td class="mdRow">
220      <table cellpadding="0" cellspacing="0" border="0">
221        <tr>
222          <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a420">Real</a> <a class="el" href="classOgre_1_1AnimationControllerFunction.html#Ogre_1_1AnimationControllerFunctionp0">Ogre::AnimationControllerFunction::mSeqTime</a><code> [protected]</code>
223      </table>
224    </td>
225  </tr>
226</table>
227<table cellspacing=5 cellpadding=0 border=0>
228  <tr>
229    <td>
230      &nbsp;
231    </td>
232    <td>
233
234<p>
235
236<p>
237Definition at line <a class="el" href="OgrePredefinedControllers_8h-source.html#l00163">163</a> of file <a class="el" href="OgrePredefinedControllers_8h-source.html">OgrePredefinedControllers.h</a>.    </td>
238  </tr>
239</table>
240<a class="anchor" name="Ogre_1_1AnimationControllerFunctionp1" doxytag="Ogre::AnimationControllerFunction::mTime" ></a><p>
241<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
242  <tr>
243    <td class="mdRow">
244      <table cellpadding="0" cellspacing="0" border="0">
245        <tr>
246          <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a420">Real</a> <a class="el" href="classOgre_1_1AnimationControllerFunction.html#Ogre_1_1AnimationControllerFunctionp1">Ogre::AnimationControllerFunction::mTime</a><code> [protected]</code>
247      </table>
248    </td>
249  </tr>
250</table>
251<table cellspacing=5 cellpadding=0 border=0>
252  <tr>
253    <td>
254      &nbsp;
255    </td>
256    <td>
257
258<p>
259
260<p>
261Definition at line <a class="el" href="OgrePredefinedControllers_8h-source.html#l00164">164</a> of file <a class="el" href="OgrePredefinedControllers_8h-source.html">OgrePredefinedControllers.h</a>.    </td>
262  </tr>
263</table>
264<hr>The documentation for this class was generated from the following file:<ul>
265<li><a class="el" href="OgrePredefinedControllers_8h-source.html">OgrePredefinedControllers.h</a></ul>
266<hr>
267<p>
268Copyright &copy; 2000-2005 by The OGRE Team<br />
269<!--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/>
270This 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/>
271                <!--/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#">
272                <Work rdf:about="">
273                        <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" />
274        <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" />
275                </Work>
276                <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> -->
277
278Last modified Sun Feb 12 13:02:10 2006
279</p>
280</body>
281</html>
Note: See TracBrowser for help on using the repository browser.