<html>
<head>
<title>Ogre::AnimationControllerFunction class Reference - OGRE Documentation</title> <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<link type="text/css" rel="stylesheet" href="style.css">
</head>
<body>
<!-- Generated by Doxygen 1.2.16 -->
<center>
<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="namespaces.html">Namespace List</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="namespacemembers.html">Namespace Members</a> <a class="qindex" href="functions.html">Compound Members</a> <a class="qindex" href="globals.html">File Members</a> <a class="qindex" href="pages.html">Related Pages</a> </center>
<hr><h1>Ogre::AnimationControllerFunction Class Reference</h1>Predefined controller function for dealing with animation.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="OgrePredefinedControllers_8h-source.html">OgrePredefinedControllers.h</a>></code>
<p>
Inheritance diagram for Ogre::AnimationControllerFunction:<p><center><img src="classOgre_1_1AnimationControllerFunction__inherit__graph.png" border="0" usemap="#Ogre_1_1AnimationControllerFunction__inherit__map" alt="Inheritance graph"></center>
<map name="Ogre_1_1AnimationControllerFunction__inherit__map">
<area href="classOgre_1_1ControllerFunction.html" shape="rect" coords="11,36,216,17" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center>Collaboration diagram for Ogre::AnimationControllerFunction:<p><center><img src="classOgre_1_1AnimationControllerFunction__coll__graph.png" border="0" usemap="#Ogre_1_1AnimationControllerFunction__coll__map" alt="Collaboration graph"></center>
<map name="Ogre_1_1AnimationControllerFunction__coll__map">
<area href="classOgre_1_1ControllerFunction.html" shape="rect" coords="11,36,216,17" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classOgre_1_1AnimationControllerFunction-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
<tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classOgre_1_1AnimationControllerFunction.html#Ogre_1_1AnimationControllerFunctiona0">AnimationControllerFunction</a> (<a class="el" href="namespaceOgre.html#a349">Real</a> sequenceTime, <a class="el" href="namespaceOgre.html#a349">Real</a> timeOffset=0.0f)</td></tr>
<tr><td> </td><td><font size=-1><em>Constructor.</em> <a href="#Ogre_1_1AnimationControllerFunctiona0"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a349">Real</a> </td><td valign=bottom><a class="el" href="classOgre_1_1AnimationControllerFunction.html#Ogre_1_1AnimationControllerFunctiona1">calculate</a> (<a class="el" href="namespaceOgre.html#a349">Real</a> source)</td></tr>
<tr><td> </td><td><font size=-1><em>Overriden function.</em> <a href="#Ogre_1_1AnimationControllerFunctiona1"></a><em></em></font><br><br></td></tr>
<tr><td colspan=2><br><h2>Protected Methods</h2></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a349">Real</a> </td><td valign=bottom><a class="el" href="classOgre_1_1AnimationControllerFunction.html#Ogre_1_1ControllerFunctionb0">getAdjustedInput</a> (<a class="el" href="namespaceOgre.html#a349">Real</a> input)</td></tr>
<tr><td> </td><td><font size=-1><em>Gets the input value as adjusted by any delta.</em> <a href="#Ogre_1_1ControllerFunctionb0"></a><em></em></font><br><br></td></tr>
<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a349">Real</a> </td><td valign=bottom><a class="el" href="classOgre_1_1AnimationControllerFunction.html#Ogre_1_1AnimationControllerFunctionn0">mSeqTime</a></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a349">Real</a> </td><td valign=bottom><a class="el" href="classOgre_1_1AnimationControllerFunction.html#Ogre_1_1AnimationControllerFunctionn1">mTime</a></td></tr>
<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classOgre_1_1AnimationControllerFunction.html#Ogre_1_1ControllerFunctionn0">mDeltaInput</a></td></tr>
<tr><td> </td><td><font size=-1><em>If true, function will add imput values together and wrap at 1.0 before evaluating.</em> <a href="#Ogre_1_1ControllerFunctionn0"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a349">Real</a> </td><td valign=bottom><a class="el" href="classOgre_1_1AnimationControllerFunction.html#Ogre_1_1ControllerFunctionn1">mDeltaCount</a></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Predefined controller function for dealing with animation.
<p>
<p>
Definition at line <a class="el" href="OgrePredefinedControllers_8h-source.html#l00155">155</a> of file <a class="el" href="OgrePredefinedControllers_8h-source.html">OgrePredefinedControllers.h</a>.<hr><h2>Constructor & Destructor Documentation</h2>
<a name="Ogre_1_1AnimationControllerFunctiona0" doxytag="Ogre::AnimationControllerFunction::AnimationControllerFunction"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> Ogre::AnimationControllerFunction::AnimationControllerFunction </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="namespaceOgre.html#a349">Real</a> </td>
<td class="mdname" nowrap> <em>sequenceTime</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap><a class="el" href="namespaceOgre.html#a349">Real</a> </td>
<td class="mdname" nowrap> <em>timeOffset</em> = 0.0f</td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Constructor.
<p>
<dl compact><dt><b>
Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>sequenceTime</em> </td><td>
The amount of time in seconds it takes to loop through the whole animation sequence. </td></tr>
<tr><td valign=top><em>timeOffset</em> </td><td>
The offset in seconds at which to start (default is start at 0) </td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="OgrePredefinedControllers_8cpp-source.html#l00196">196</a> of file <a class="el" href="OgrePredefinedControllers_8cpp-source.html">OgrePredefinedControllers.cpp</a>.
<p>
References <a class="el" href="OgrePredefinedControllers_8h-source.html#l00158">mSeqTime</a>, <a class="el" href="OgrePredefinedControllers_8h-source.html#l00159">mTime</a>, and <a class="el" href="OgrePrerequisites_8h-source.html#l00086">Ogre::Real</a>. </td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a name="Ogre_1_1AnimationControllerFunctiona1" doxytag="Ogre::AnimationControllerFunction::calculate"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a349">Real</a> Ogre::AnimationControllerFunction::calculate </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="namespaceOgre.html#a349">Real</a> </td>
<td class="mdname1" valign="top" nowrap> <em>source</em> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap><code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Overriden function.
<p>
<p>
Implements <a class="el" href="classOgre_1_1ControllerFunction.html#Ogre_1_1ControllerFunctiona1">Ogre::ControllerFunction< Real ></a>.
<p>
Definition at line <a class="el" href="OgrePredefinedControllers_8cpp-source.html#l00203">203</a> of file <a class="el" href="OgrePredefinedControllers_8cpp-source.html">OgrePredefinedControllers.cpp</a>.
<p>
References <a class="el" href="OgrePredefinedControllers_8h-source.html#l00158">mSeqTime</a>, <a class="el" href="OgrePredefinedControllers_8h-source.html#l00159">mTime</a>, and <a class="el" href="OgrePrerequisites_8h-source.html#l00086">Ogre::Real</a>. </td>
</tr>
</table>
<a name="Ogre_1_1ControllerFunctionb0" doxytag="Ogre::AnimationControllerFunction::getAdjustedInput"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a349">Real</a> <a class="el" href="classOgre_1_1ControllerFunction.html">Ogre::ControllerFunction</a>< <a class="el" href="namespaceOgre.html#a349">Real</a> >::getAdjustedInput </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="namespaceOgre.html#a349">Real</a> </td>
<td class="mdname1" valign="top" nowrap> <em>input</em> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap><code> [protected, inherited]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Gets the input value as adjusted by any delta.
<p>
<p>
Reimplemented in <a class="el" href="classOgre_1_1WaveformControllerFunction.html#Ogre_1_1WaveformControllerFunctionb0">Ogre::WaveformControllerFunction</a>.
<p>
Definition 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>.
<p>
Referenced by <a class="el" href="OgrePredefinedControllers_8cpp-source.html#l00221">Ogre::ScaleControllerFunction::calculate</a>(). </td>
</tr>
</table>
<hr><h2>Member Data Documentation</h2>
<a name="Ogre_1_1ControllerFunctionn1" doxytag="Ogre::AnimationControllerFunction::mDeltaCount"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a349">Real</a> <a class="el" href="classOgre_1_1ControllerFunction.html">Ogre::ControllerFunction</a>< <a class="el" href="namespaceOgre.html#a349">Real</a> >::mDeltaCount<code> [protected, inherited]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<p>
Definition at line <a class="el" href="OgreController_8h-source.html#l00052">52</a> of file <a class="el" href="OgreController_8h-source.html">OgreController.h</a>.
<p>
Referenced by <a class="el" href="OgrePredefinedControllers_8cpp-source.html#l00229">Ogre::WaveformControllerFunction::WaveformControllerFunction</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1ControllerFunctionn0" doxytag="Ogre::AnimationControllerFunction::mDeltaInput"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> bool <a class="el" href="classOgre_1_1ControllerFunction.html">Ogre::ControllerFunction</a>< <a class="el" href="namespaceOgre.html#a349">Real</a> >::mDeltaInput<code> [protected, inherited]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
If true, function will add imput values together and wrap at 1.0 before evaluating.
<p>
<p>
Definition 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>.
<p>
Referenced by <a class="el" href="OgrePredefinedControllers_8cpp-source.html#l00241">Ogre::WaveformControllerFunction::getAdjustedInput</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1AnimationControllerFunctionn0" doxytag="Ogre::AnimationControllerFunction::mSeqTime"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a349">Real</a> Ogre::AnimationControllerFunction::mSeqTime<code> [protected]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<p>
Definition at line <a class="el" href="OgrePredefinedControllers_8h-source.html#l00158">158</a> of file <a class="el" href="OgrePredefinedControllers_8h-source.html">OgrePredefinedControllers.h</a>.
<p>
Referenced by <a class="el" href="OgrePredefinedControllers_8cpp-source.html#l00196">AnimationControllerFunction</a>(), and <a class="el" href="OgrePredefinedControllers_8cpp-source.html#l00203">calculate</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1AnimationControllerFunctionn1" doxytag="Ogre::AnimationControllerFunction::mTime"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a349">Real</a> Ogre::AnimationControllerFunction::mTime<code> [protected]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<p>
Definition at line <a class="el" href="OgrePredefinedControllers_8h-source.html#l00159">159</a> of file <a class="el" href="OgrePredefinedControllers_8h-source.html">OgrePredefinedControllers.h</a>.
<p>
Referenced by <a class="el" href="OgrePredefinedControllers_8cpp-source.html#l00196">AnimationControllerFunction</a>(), and <a class="el" href="OgrePredefinedControllers_8cpp-source.html#l00203">calculate</a>(). </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="OgrePredefinedControllers_8h-source.html">OgrePredefinedControllers.h</a><li><a class="el" href="OgrePredefinedControllers_8cpp-source.html">OgrePredefinedControllers.cpp</a></ul>
<p>
Copyright © 2002-2003 by The OGRE Team<br />
Last modified Wed Jan 21 00:15:46 2004
</p>
</body>
</html>
