<html> <head> <title>Ogre::TextureFrameControllerValue 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::TextureFrameControllerValue Class Reference</h1>Predefined controller value for getting / setting the frame number of a texture layer. <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::TextureFrameControllerValue:<p><center><img src="classOgre_1_1TextureFrameControllerValue__inherit__graph.png" border="0" usemap="#Ogre_1_1TextureFrameControllerValue__inherit__map" alt="Inheritance graph"></center> <map name="Ogre_1_1TextureFrameControllerValue__inherit__map"> <area href="classOgre_1_1ControllerValue.html" shape="rect" coords="24,36,211,17" alt=""> </map> <center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center>Collaboration diagram for Ogre::TextureFrameControllerValue:<p><center><img src="classOgre_1_1TextureFrameControllerValue__coll__graph.png" border="0" usemap="#Ogre_1_1TextureFrameControllerValue__coll__map" alt="Collaboration graph"></center> <map name="Ogre_1_1TextureFrameControllerValue__coll__map"> <area href="classOgre_1_1ControllerValue.html" shape="rect" coords="19,27,205,9" alt=""> <area href="classOgre_1_1TextureUnitState.html" shape="rect" coords="39,85,185,66" alt=""> </map> <center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classOgre_1_1TextureFrameControllerValue-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_1TextureFrameControllerValue.html#Ogre_1_1TextureFrameControllerValuea0">TextureFrameControllerValue</a> (<a class="el" href="classOgre_1_1TextureUnitState.html">TextureUnitState</a> *t)</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_1TextureFrameControllerValue.html#Ogre_1_1TextureFrameControllerValuea1">getValue</a> (void) const</td></tr> <tr><td> </td><td><font size=-1><em>Gets the frame number as a parametric value in the range [0,1].</em> <a href="#Ogre_1_1TextureFrameControllerValuea1"></a><em></em></font><br><br></td></tr> <tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classOgre_1_1TextureFrameControllerValue.html#Ogre_1_1TextureFrameControllerValuea2">setValue</a> (<a class="el" href="namespaceOgre.html#a349">Real</a> value)</td></tr> <tr><td> </td><td><font size=-1><em>Sets the frame number as a parametric value in the range [0,1]; the actual frame number is value * (numFrames-1).</em> <a href="#Ogre_1_1TextureFrameControllerValuea2"></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="classOgre_1_1TextureUnitState.html">TextureUnitState</a> * </td><td valign=bottom><a class="el" href="classOgre_1_1TextureFrameControllerValue.html#Ogre_1_1TextureFrameControllerValuen0">mTextureLayer</a></td></tr> </table> <hr><a name="_details"></a><h2>Detailed Description</h2> Predefined controller value for getting / setting the frame number of a texture layer. <p> <p> Definition at line <a class="el" href="OgrePredefinedControllers_8h-source.html#l00061">61</a> of file <a class="el" href="OgrePredefinedControllers_8h-source.html">OgrePredefinedControllers.h</a>.<hr><h2>Constructor & Destructor Documentation</h2> <a name="Ogre_1_1TextureFrameControllerValuea0" doxytag="Ogre::TextureFrameControllerValue::TextureFrameControllerValue"></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::TextureFrameControllerValue::TextureFrameControllerValue </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1TextureUnitState.html">TextureUnitState</a> * </td> <td class="mdname1" valign="top" nowrap> <em>t</em> </td> <td class="md" valign="top">) </td> <td class="md" nowrap></td> </tr> </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_8cpp-source.html#l00079">79</a> of file <a class="el" href="OgrePredefinedControllers_8cpp-source.html">OgrePredefinedControllers.cpp</a>. <p> References <a class="el" href="OgrePredefinedControllers_8h-source.html#l00064">mTextureLayer</a>. </td> </tr> </table> <hr><h2>Member Function Documentation</h2> <a name="Ogre_1_1TextureFrameControllerValuea1" doxytag="Ogre::TextureFrameControllerValue::getValue"></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::TextureFrameControllerValue::getValue </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">void </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top">) </td> <td class="md" nowrap> const<code> [virtual]</code></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> Gets the frame number as a parametric value in the range [0,1]. <p> <p> Implements <a class="el" href="classOgre_1_1ControllerValue.html#Ogre_1_1ControllerValuea0">Ogre::ControllerValue< Real ></a>. <p> Definition at line <a class="el" href="OgrePredefinedControllers_8cpp-source.html#l00084">84</a> of file <a class="el" href="OgrePredefinedControllers_8cpp-source.html">OgrePredefinedControllers.cpp</a>. <p> References <a class="el" href="OgreTextureUnitState_8cpp-source.html#l00337">Ogre::TextureUnitState::getCurrentFrame</a>(), <a class="el" href="OgreTextureUnitState_8cpp-source.html#l00342">Ogre::TextureUnitState::getNumFrames</a>(), <a class="el" href="OgrePredefinedControllers_8h-source.html#l00064">mTextureLayer</a>, and <a class="el" href="OgrePrerequisites_8h-source.html#l00086">Ogre::Real</a>. </td> </tr> </table> <a name="Ogre_1_1TextureFrameControllerValuea2" doxytag="Ogre::TextureFrameControllerValue::setValue"></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"> void Ogre::TextureFrameControllerValue::setValue </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>value</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> Sets the frame number as a parametric value in the range [0,1]; the actual frame number is value * (numFrames-1). <p> <p> Implements <a class="el" href="classOgre_1_1ControllerValue.html#Ogre_1_1ControllerValuea1">Ogre::ControllerValue< Real ></a>. <p> Definition at line <a class="el" href="OgrePredefinedControllers_8cpp-source.html#l00090">90</a> of file <a class="el" href="OgrePredefinedControllers_8cpp-source.html">OgrePredefinedControllers.cpp</a>. <p> References <a class="el" href="OgreTextureUnitState_8cpp-source.html#l00342">Ogre::TextureUnitState::getNumFrames</a>(), <a class="el" href="OgrePredefinedControllers_8h-source.html#l00064">mTextureLayer</a>, <a class="el" href="OgrePrerequisites_8h-source.html#l00086">Ogre::Real</a>, and <a class="el" href="OgreTextureUnitState_8cpp-source.html#l00328">Ogre::TextureUnitState::setCurrentFrame</a>(). </td> </tr> </table> <hr><h2>Member Data Documentation</h2> <a name="Ogre_1_1TextureFrameControllerValuen0" doxytag="Ogre::TextureFrameControllerValue::mTextureLayer"></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="classOgre_1_1TextureUnitState.html">TextureUnitState</a>* Ogre::TextureFrameControllerValue::mTextureLayer<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#l00064">64</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#l00084">getValue</a>(), <a class="el" href="OgrePredefinedControllers_8cpp-source.html#l00090">setValue</a>(), and <a class="el" href="OgrePredefinedControllers_8cpp-source.html#l00079">TextureFrameControllerValue</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:21:05 2004 </p> </body> </html>