<html> <head> <title>Ogre::ScaleControllerFunction 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::ScaleControllerFunction Class Reference</h1>Predefined controller function which simply scales an input to an output value. <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::ScaleControllerFunction:<p><center><img src="classOgre_1_1ScaleControllerFunction__inherit__graph.png" border="0" usemap="#Ogre_1_1ScaleControllerFunction__inherit__map" alt="Inheritance graph"></center> <map name="Ogre_1_1ScaleControllerFunction__inherit__map"> <area href="classOgre_1_1ControllerFunction.html" shape="rect" coords="7,36,212,17" alt=""> </map> <center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center>Collaboration diagram for Ogre::ScaleControllerFunction:<p><center><img src="classOgre_1_1ScaleControllerFunction__coll__graph.png" border="0" usemap="#Ogre_1_1ScaleControllerFunction__coll__map" alt="Collaboration graph"></center> <map name="Ogre_1_1ScaleControllerFunction__coll__map"> <area href="classOgre_1_1ControllerFunction.html" shape="rect" coords="7,36,212,17" alt=""> </map> <center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classOgre_1_1ScaleControllerFunction-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_1ScaleControllerFunction.html#Ogre_1_1ScaleControllerFunctiona0">ScaleControllerFunction</a> (<a class="el" href="namespaceOgre.html#a349">Real</a> scalefactor, bool deltaInput)</td></tr> <tr><td> </td><td><font size=-1><em>Constructor, requires a scale factor.</em> <a href="#Ogre_1_1ScaleControllerFunctiona0"></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_1ScaleControllerFunction.html#Ogre_1_1ScaleControllerFunctiona1">calculate</a> (<a class="el" href="namespaceOgre.html#a349">Real</a> source)</td></tr> <tr><td> </td><td><font size=-1><em>Overriden method.</em> <a href="#Ogre_1_1ScaleControllerFunctiona1"></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_1ScaleControllerFunction.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_1ScaleControllerFunction.html#Ogre_1_1ScaleControllerFunctionn0">mScale</a></td></tr> <tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classOgre_1_1ScaleControllerFunction.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_1ScaleControllerFunction.html#Ogre_1_1ControllerFunctionn1">mDeltaCount</a></td></tr> </table> <hr><a name="_details"></a><h2>Detailed Description</h2> Predefined controller function which simply scales an input to an output value. <p> <p> Definition at line <a class="el" href="OgrePredefinedControllers_8h-source.html#l00177">177</a> of file <a class="el" href="OgrePredefinedControllers_8h-source.html">OgrePredefinedControllers.h</a>.<hr><h2>Constructor & Destructor Documentation</h2> <a name="Ogre_1_1ScaleControllerFunctiona0" doxytag="Ogre::ScaleControllerFunction::ScaleControllerFunction"></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::ScaleControllerFunction::ScaleControllerFunction </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>scalefactor</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>bool </td> <td class="mdname" nowrap> <em>deltaInput</em></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, requires a scale factor. <p> <dl compact><dt><b> Parameters: </b><dd> <table border=0 cellspacing=2 cellpadding=0> <tr><td valign=top><em>scalefactor</em> </td><td> The multipier applied to the input to produce the output. </td></tr> <tr><td valign=top><em>deltaInput</em> </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> </table> </dl> <p> Definition at line <a class="el" href="OgrePredefinedControllers_8cpp-source.html#l00216">216</a> of file <a class="el" href="OgrePredefinedControllers_8cpp-source.html">OgrePredefinedControllers.cpp</a>. <p> References <a class="el" href="OgrePredefinedControllers_8h-source.html#l00180">mScale</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_1ScaleControllerFunctiona1" doxytag="Ogre::ScaleControllerFunction::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::ScaleControllerFunction::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 method. <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#l00221">221</a> of file <a class="el" href="OgrePredefinedControllers_8cpp-source.html">OgrePredefinedControllers.cpp</a>. <p> References <a class="el" href="OgreController_8h-source.html#l00056">Ogre::ControllerFunction< Real >::getAdjustedInput</a>(), <a class="el" href="OgrePredefinedControllers_8h-source.html#l00180">mScale</a>, and <a class="el" href="OgrePrerequisites_8h-source.html#l00086">Ogre::Real</a>. </td> </tr> </table> <a name="Ogre_1_1ControllerFunctionb0" doxytag="Ogre::ScaleControllerFunction::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">calculate</a>(). </td> </tr> </table> <hr><h2>Member Data Documentation</h2> <a name="Ogre_1_1ControllerFunctionn1" doxytag="Ogre::ScaleControllerFunction::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::ScaleControllerFunction::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_1ScaleControllerFunctionn0" doxytag="Ogre::ScaleControllerFunction::mScale"></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::ScaleControllerFunction::mScale<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#l00180">180</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#l00221">calculate</a>(), and <a class="el" href="OgrePredefinedControllers_8cpp-source.html#l00216">ScaleControllerFunction</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:19:52 2004 </p> </body> </html>