[657] | 1 | <html> |
---|
| 2 | <head> |
---|
| 3 | <title>Ogre::ScaleControllerFunction 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 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">Class 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">Class Members</a> | <a class="qindex" href="globals.html">File Members</a> | <a class="qindex" href="pages.html">Related Pages</a></div> |
---|
| 10 | <h1>Ogre::ScaleControllerFunction Class Reference</h1>Predefined controller function which simply scales an input to an output value. |
---|
| 11 | <a href="#_details">More...</a> |
---|
| 12 | <p> |
---|
| 13 | <code>#include <<a class="el" href="OgrePredefinedControllers_8h-source.html">OgrePredefinedControllers.h</a>></code> |
---|
| 14 | <p> |
---|
| 15 | <p>Inheritance diagram for Ogre::ScaleControllerFunction: |
---|
| 16 | <p><center><img src="classOgre_1_1ScaleControllerFunction.png" usemap="#Ogre::ScaleControllerFunction_map" border="0" alt=""></center> |
---|
| 17 | <map name="Ogre::ScaleControllerFunction_map"> |
---|
| 18 | <area href="classOgre_1_1ControllerFunction.html" alt="Ogre::ControllerFunction< Real >" shape="rect" coords="0,0,201,24"> |
---|
| 19 | </map> |
---|
| 20 | <a href="classOgre_1_1ScaleControllerFunction-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> </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ScaleControllerFunction.html#Ogre_1_1ScaleControllerFunctiona0">ScaleControllerFunction</a> (<a class="el" href="namespaceOgre.html#a420">Real</a> scalefactor, bool deltaInput)</td></tr> |
---|
| 24 | |
---|
| 25 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor, requires a scale factor. <a href="#Ogre_1_1ScaleControllerFunctiona0"></a><br><br></td></tr> |
---|
| 26 | <tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a420">Real</a> </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ScaleControllerFunction.html#Ogre_1_1ScaleControllerFunctiona1">calculate</a> (<a class="el" href="namespaceOgre.html#a420">Real</a> source)</td></tr> |
---|
| 27 | |
---|
| 28 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Overriden method. <a href="#Ogre_1_1ScaleControllerFunctiona1"></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> </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"> </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> </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ScaleControllerFunction.html#Ogre_1_1ScaleControllerFunctionp0">mScale</a></td></tr> |
---|
| 35 | |
---|
| 36 | <tr><td class="memItemLeft" nowrap align=right valign=top>bool </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ControllerFunction.html#Ogre_1_1ControllerFunctionp0">mDeltaInput</a></td></tr> |
---|
| 37 | |
---|
| 38 | <tr><td class="mdescLeft"> </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> |
---|
| 39 | <tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a420">Real</a> </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ControllerFunction.html#Ogre_1_1ControllerFunctionp1">mDeltaCount</a></td></tr> |
---|
| 40 | |
---|
| 41 | </table> |
---|
| 42 | <hr><a name="_details"></a><h2>Detailed Description</h2> |
---|
| 43 | Predefined controller function which simply scales an input to an output value. |
---|
| 44 | <p> |
---|
| 45 | |
---|
| 46 | <p> |
---|
| 47 | Definition at line <a class="el" href="OgrePredefinedControllers_8h-source.html#l00182">182</a> of file <a class="el" href="OgrePredefinedControllers_8h-source.html">OgrePredefinedControllers.h</a>.<hr><h2>Constructor & Destructor Documentation</h2> |
---|
| 48 | <a class="anchor" name="Ogre_1_1ScaleControllerFunctiona0" doxytag="Ogre::ScaleControllerFunction::ScaleControllerFunction" ></a><p> |
---|
| 49 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
| 50 | <tr> |
---|
| 51 | <td class="mdRow"> |
---|
| 52 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 53 | <tr> |
---|
| 54 | <td class="md" nowrap valign="top"> Ogre::ScaleControllerFunction::ScaleControllerFunction </td> |
---|
| 55 | <td class="md" valign="top">( </td> |
---|
| 56 | <td class="md" nowrap valign="top"><a class="el" href="namespaceOgre.html#a420">Real</a> </td> |
---|
| 57 | <td class="mdname" nowrap> <em>scalefactor</em>, </td> |
---|
| 58 | </tr> |
---|
| 59 | <tr> |
---|
| 60 | <td class="md" nowrap align="right"></td> |
---|
| 61 | <td></td> |
---|
| 62 | <td class="md" nowrap>bool </td> |
---|
| 63 | <td class="mdname" nowrap> <em>deltaInput</em></td> |
---|
| 64 | </tr> |
---|
| 65 | <tr> |
---|
| 66 | <td></td> |
---|
| 67 | <td class="md">) </td> |
---|
| 68 | <td class="md" colspan="2"></td> |
---|
| 69 | </tr> |
---|
| 70 | |
---|
| 71 | </table> |
---|
| 72 | </td> |
---|
| 73 | </tr> |
---|
| 74 | </table> |
---|
| 75 | <table cellspacing=5 cellpadding=0 border=0> |
---|
| 76 | <tr> |
---|
| 77 | <td> |
---|
| 78 | |
---|
| 79 | </td> |
---|
| 80 | <td> |
---|
| 81 | |
---|
| 82 | <p> |
---|
| 83 | Constructor, requires a scale factor. |
---|
| 84 | <p> |
---|
| 85 | <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
| 86 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
| 87 | <tr><td valign=top><em>scalefactor</em> </td><td>The multipier applied to the input to produce the output. </td></tr> |
---|
| 88 | <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> |
---|
| 89 | </table> |
---|
| 90 | </dl> |
---|
| 91 | </td> |
---|
| 92 | </tr> |
---|
| 93 | </table> |
---|
| 94 | <hr><h2>Member Function Documentation</h2> |
---|
| 95 | <a class="anchor" name="Ogre_1_1ScaleControllerFunctiona1" doxytag="Ogre::ScaleControllerFunction::calculate" ></a><p> |
---|
| 96 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
| 97 | <tr> |
---|
| 98 | <td class="mdRow"> |
---|
| 99 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 100 | <tr> |
---|
| 101 | <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a420">Real</a> Ogre::ScaleControllerFunction::calculate </td> |
---|
| 102 | <td class="md" valign="top">( </td> |
---|
| 103 | <td class="md" nowrap valign="top"><a class="el" href="namespaceOgre.html#a420">Real</a> </td> |
---|
| 104 | <td class="mdname1" valign="top" nowrap> <em>source</em> </td> |
---|
| 105 | <td class="md" valign="top"> ) </td> |
---|
| 106 | <td class="md" nowrap><code> [virtual]</code></td> |
---|
| 107 | </tr> |
---|
| 108 | |
---|
| 109 | </table> |
---|
| 110 | </td> |
---|
| 111 | </tr> |
---|
| 112 | </table> |
---|
| 113 | <table cellspacing=5 cellpadding=0 border=0> |
---|
| 114 | <tr> |
---|
| 115 | <td> |
---|
| 116 | |
---|
| 117 | </td> |
---|
| 118 | <td> |
---|
| 119 | |
---|
| 120 | <p> |
---|
| 121 | Overriden method. |
---|
| 122 | <p> |
---|
| 123 | |
---|
| 124 | <p> |
---|
| 125 | Implements <a class="el" href="classOgre_1_1ControllerFunction.html#Ogre_1_1ControllerFunctiona2">Ogre::ControllerFunction< Real ></a>. </td> |
---|
| 126 | </tr> |
---|
| 127 | </table> |
---|
| 128 | <a class="anchor" name="Ogre_1_1ControllerFunctionb0" doxytag="Ogre::ScaleControllerFunction::getAdjustedInput" ></a><p> |
---|
| 129 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
| 130 | <tr> |
---|
| 131 | <td class="mdRow"> |
---|
| 132 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 133 | <tr> |
---|
| 134 | <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>< <a class="el" href="namespaceOgre.html#a420">Real</a> >::getAdjustedInput </td> |
---|
| 135 | <td class="md" valign="top">( </td> |
---|
| 136 | <td class="md" nowrap valign="top"><a class="el" href="namespaceOgre.html#a420">Real</a> </td> |
---|
| 137 | <td class="mdname1" valign="top" nowrap> <em>input</em> </td> |
---|
| 138 | <td class="md" valign="top"> ) </td> |
---|
| 139 | <td class="md" nowrap><code> [protected, inherited]</code></td> |
---|
| 140 | </tr> |
---|
| 141 | |
---|
| 142 | </table> |
---|
| 143 | </td> |
---|
| 144 | </tr> |
---|
| 145 | </table> |
---|
| 146 | <table cellspacing=5 cellpadding=0 border=0> |
---|
| 147 | <tr> |
---|
| 148 | <td> |
---|
| 149 | |
---|
| 150 | </td> |
---|
| 151 | <td> |
---|
| 152 | |
---|
| 153 | <p> |
---|
| 154 | Gets the input value as adjusted by any delta. |
---|
| 155 | <p> |
---|
| 156 | |
---|
| 157 | <p> |
---|
| 158 | Reimplemented in <a class="el" href="classOgre_1_1WaveformControllerFunction.html#Ogre_1_1WaveformControllerFunctionb0">Ogre::WaveformControllerFunction</a>. |
---|
| 159 | <p> |
---|
| 160 | 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>. </td> |
---|
| 161 | </tr> |
---|
| 162 | </table> |
---|
| 163 | <hr><h2>Member Data Documentation</h2> |
---|
| 164 | <a class="anchor" name="Ogre_1_1ControllerFunctionp1" doxytag="Ogre::ScaleControllerFunction::mDeltaCount" ></a><p> |
---|
| 165 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
| 166 | <tr> |
---|
| 167 | <td class="mdRow"> |
---|
| 168 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 169 | <tr> |
---|
| 170 | <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>< <a class="el" href="namespaceOgre.html#a420">Real</a> >::<a class="el" href="classOgre_1_1ControllerFunction.html#Ogre_1_1ControllerFunctionp1">mDeltaCount</a><code> [protected, inherited]</code> |
---|
| 171 | </table> |
---|
| 172 | </td> |
---|
| 173 | </tr> |
---|
| 174 | </table> |
---|
| 175 | <table cellspacing=5 cellpadding=0 border=0> |
---|
| 176 | <tr> |
---|
| 177 | <td> |
---|
| 178 | |
---|
| 179 | </td> |
---|
| 180 | <td> |
---|
| 181 | |
---|
| 182 | <p> |
---|
| 183 | |
---|
| 184 | <p> |
---|
| 185 | 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>. </td> |
---|
| 186 | </tr> |
---|
| 187 | </table> |
---|
| 188 | <a class="anchor" name="Ogre_1_1ControllerFunctionp0" doxytag="Ogre::ScaleControllerFunction::mDeltaInput" ></a><p> |
---|
| 189 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
| 190 | <tr> |
---|
| 191 | <td class="mdRow"> |
---|
| 192 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 193 | <tr> |
---|
| 194 | <td class="md" nowrap valign="top"> bool <a class="el" href="classOgre_1_1ControllerFunction.html">Ogre::ControllerFunction</a>< <a class="el" href="namespaceOgre.html#a420">Real</a> >::<a class="el" href="classOgre_1_1ControllerFunction.html#Ogre_1_1ControllerFunctionp0">mDeltaInput</a><code> [protected, inherited]</code> |
---|
| 195 | </table> |
---|
| 196 | </td> |
---|
| 197 | </tr> |
---|
| 198 | </table> |
---|
| 199 | <table cellspacing=5 cellpadding=0 border=0> |
---|
| 200 | <tr> |
---|
| 201 | <td> |
---|
| 202 | |
---|
| 203 | </td> |
---|
| 204 | <td> |
---|
| 205 | |
---|
| 206 | <p> |
---|
| 207 | If true, function will add imput values together and wrap at 1.0 before evaluating. |
---|
| 208 | <p> |
---|
| 209 | |
---|
| 210 | <p> |
---|
| 211 | 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>. </td> |
---|
| 212 | </tr> |
---|
| 213 | </table> |
---|
| 214 | <a class="anchor" name="Ogre_1_1ScaleControllerFunctionp0" doxytag="Ogre::ScaleControllerFunction::mScale" ></a><p> |
---|
| 215 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
| 216 | <tr> |
---|
| 217 | <td class="mdRow"> |
---|
| 218 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 219 | <tr> |
---|
| 220 | <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a420">Real</a> <a class="el" href="classOgre_1_1ScaleControllerFunction.html#Ogre_1_1ScaleControllerFunctionp0">Ogre::ScaleControllerFunction::mScale</a><code> [protected]</code> |
---|
| 221 | </table> |
---|
| 222 | </td> |
---|
| 223 | </tr> |
---|
| 224 | </table> |
---|
| 225 | <table cellspacing=5 cellpadding=0 border=0> |
---|
| 226 | <tr> |
---|
| 227 | <td> |
---|
| 228 | |
---|
| 229 | </td> |
---|
| 230 | <td> |
---|
| 231 | |
---|
| 232 | <p> |
---|
| 233 | |
---|
| 234 | <p> |
---|
| 235 | Definition at line <a class="el" href="OgrePredefinedControllers_8h-source.html#l00185">185</a> of file <a class="el" href="OgrePredefinedControllers_8h-source.html">OgrePredefinedControllers.h</a>. </td> |
---|
| 236 | </tr> |
---|
| 237 | </table> |
---|
| 238 | <hr>The documentation for this class was generated from the following file:<ul> |
---|
| 239 | <li><a class="el" href="OgrePredefinedControllers_8h-source.html">OgrePredefinedControllers.h</a></ul> |
---|
| 240 | <hr> |
---|
| 241 | <p> |
---|
| 242 | Copyright © 2000-2005 by The OGRE Team<br /> |
---|
| 243 | <!--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/> |
---|
| 244 | This 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/> |
---|
| 245 | <!--/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#"> |
---|
| 246 | <Work rdf:about=""> |
---|
| 247 | <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" /> |
---|
| 248 | <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" /> |
---|
| 249 | </Work> |
---|
| 250 | <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> --> |
---|
| 251 | |
---|
| 252 | Last modified Sun Feb 12 13:02:11 2006 |
---|
| 253 | </p> |
---|
| 254 | </body> |
---|
| 255 | </html> |
---|