<html>
<head>
<title>Ogre::FrameTimeControllerValue 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::FrameTimeControllerValue Class Reference</h1>Predefined controller value for getting the latest frame time.
<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::FrameTimeControllerValue:<p><center><img src="classOgre_1_1FrameTimeControllerValue__inherit__graph.png" border="0" usemap="#Ogre_1_1FrameTimeControllerValue__inherit__map" alt="Inheritance graph"></center>
<map name="Ogre_1_1FrameTimeControllerValue__inherit__map">
<area href="classOgre_1_1ControllerValue.html" shape="rect" coords="7,36,193,17" alt="">
<area href="classOgre_1_1FrameListener.html" shape="rect" coords="217,36,351,17" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center>Collaboration diagram for Ogre::FrameTimeControllerValue:<p><center><img src="classOgre_1_1FrameTimeControllerValue__coll__graph.png" border="0" usemap="#Ogre_1_1FrameTimeControllerValue__coll__map" alt="Collaboration graph"></center>
<map name="Ogre_1_1FrameTimeControllerValue__coll__map">
<area href="classOgre_1_1ControllerValue.html" shape="rect" coords="7,36,193,17" alt="">
<area href="classOgre_1_1FrameListener.html" shape="rect" coords="217,36,351,17" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classOgre_1_1FrameTimeControllerValue-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_1FrameTimeControllerValue.html#Ogre_1_1FrameTimeControllerValuea0">FrameTimeControllerValue</a> ()</td></tr>
<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classOgre_1_1FrameTimeControllerValue.html#Ogre_1_1FrameTimeControllerValuea1">frameEnded</a> (const <a class="el" href="structOgre_1_1FrameEvent.html">FrameEvent</a> &evt)</td></tr>
<tr><td> </td><td><font size=-1><em>Called just after a frame has been rendered.</em> <a href="#Ogre_1_1FrameTimeControllerValuea1"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classOgre_1_1FrameTimeControllerValue.html#Ogre_1_1FrameTimeControllerValuea2">frameStarted</a> (const <a class="el" href="structOgre_1_1FrameEvent.html">FrameEvent</a> &evt)</td></tr>
<tr><td> </td><td><font size=-1><em>Called when a frame is about to begin rendering.</em> <a href="#Ogre_1_1FrameTimeControllerValuea2"></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_1FrameTimeControllerValue.html#Ogre_1_1FrameTimeControllerValuea3">getValue</a> (void) const</td></tr>
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classOgre_1_1FrameTimeControllerValue.html#Ogre_1_1FrameTimeControllerValuea4">setValue</a> (<a class="el" href="namespaceOgre.html#a349">Real</a> value)</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_1FrameTimeControllerValue.html#Ogre_1_1FrameTimeControllerValuea5">getTimeFactor</a> (void) const</td></tr>
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classOgre_1_1FrameTimeControllerValue.html#Ogre_1_1FrameTimeControllerValuea6">setTimeFactor</a> (<a class="el" href="namespaceOgre.html#a349">Real</a> tf)</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_1FrameTimeControllerValue.html#Ogre_1_1FrameTimeControllerValuen0">mFrameTime</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_1FrameTimeControllerValue.html#Ogre_1_1FrameTimeControllerValuen1">mTimeFactor</a></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Predefined controller value for getting the latest frame time.
<p>
<p>
Definition at line <a class="el" href="OgrePredefinedControllers_8h-source.html#l00042">42</a> of file <a class="el" href="OgrePredefinedControllers_8h-source.html">OgrePredefinedControllers.h</a>.<hr><h2>Constructor & Destructor Documentation</h2>
<a name="Ogre_1_1FrameTimeControllerValuea0" doxytag="Ogre::FrameTimeControllerValue::FrameTimeControllerValue"></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::FrameTimeControllerValue::FrameTimeControllerValue </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </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#l00038">38</a> of file <a class="el" href="OgrePredefinedControllers_8cpp-source.html">OgrePredefinedControllers.cpp</a>.
<p>
References <a class="el" href="OgrePredefinedControllers_8h-source.html#l00045">mFrameTime</a>, and <a class="el" href="OgrePredefinedControllers_8h-source.html#l00046">mTimeFactor</a>. </td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a name="Ogre_1_1FrameTimeControllerValuea1" doxytag="Ogre::FrameTimeControllerValue::frameEnded"></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 Ogre::FrameTimeControllerValue::frameEnded </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="structOgre_1_1FrameEvent.html">FrameEvent</a> & </td>
<td class="mdname1" valign="top" nowrap> <em>evt</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>
Called just after a frame has been rendered.
<p>
<dl compact><dt><b>
Returns: </b><dd>
True to continue with the next frame, false to drop out of the rendering loop. </dl>
<p>
Reimplemented from <a class="el" href="classOgre_1_1FrameListener.html#Ogre_1_1FrameListenera1">Ogre::FrameListener</a>.
<p>
Definition at line <a class="el" href="OgrePredefinedControllers_8cpp-source.html#l00054">54</a> of file <a class="el" href="OgrePredefinedControllers_8cpp-source.html">OgrePredefinedControllers.cpp</a>. </td>
</tr>
</table>
<a name="Ogre_1_1FrameTimeControllerValuea2" doxytag="Ogre::FrameTimeControllerValue::frameStarted"></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 Ogre::FrameTimeControllerValue::frameStarted </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="structOgre_1_1FrameEvent.html">FrameEvent</a> & </td>
<td class="mdname1" valign="top" nowrap> <em>evt</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>
Called when a frame is about to begin rendering.
<p>
<dl compact><dt><b>
Returns: </b><dd>
True to go ahead, false to abort rendering and drop out of the rendering loop. </dl>
<p>
Reimplemented from <a class="el" href="classOgre_1_1FrameListener.html#Ogre_1_1FrameListenera0">Ogre::FrameListener</a>.
<p>
Definition at line <a class="el" href="OgrePredefinedControllers_8cpp-source.html#l00047">47</a> of file <a class="el" href="OgrePredefinedControllers_8cpp-source.html">OgrePredefinedControllers.cpp</a>.
<p>
References <a class="el" href="OgrePredefinedControllers_8h-source.html#l00045">mFrameTime</a>, <a class="el" href="OgrePredefinedControllers_8h-source.html#l00046">mTimeFactor</a>, and <a class="el" href="OgreFrameListener_8h-source.html#l00051">Ogre::FrameEvent::timeSinceLastFrame</a>. </td>
</tr>
</table>
<a name="Ogre_1_1FrameTimeControllerValuea5" doxytag="Ogre::FrameTimeControllerValue::getTimeFactor"></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::FrameTimeControllerValue::getTimeFactor </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</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#l00069">69</a> of file <a class="el" href="OgrePredefinedControllers_8cpp-source.html">OgrePredefinedControllers.cpp</a>.
<p>
References <a class="el" href="OgrePredefinedControllers_8h-source.html#l00046">mTimeFactor</a>, and <a class="el" href="OgrePrerequisites_8h-source.html#l00086">Ogre::Real</a>. </td>
</tr>
</table>
<a name="Ogre_1_1FrameTimeControllerValuea3" doxytag="Ogre::FrameTimeControllerValue::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::FrameTimeControllerValue::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>
<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#l00059">59</a> of file <a class="el" href="OgrePredefinedControllers_8cpp-source.html">OgrePredefinedControllers.cpp</a>.
<p>
References <a class="el" href="OgrePredefinedControllers_8h-source.html#l00045">mFrameTime</a>, and <a class="el" href="OgrePrerequisites_8h-source.html#l00086">Ogre::Real</a>. </td>
</tr>
</table>
<a name="Ogre_1_1FrameTimeControllerValuea6" doxytag="Ogre::FrameTimeControllerValue::setTimeFactor"></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::FrameTimeControllerValue::setTimeFactor </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>tf</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#l00073">73</a> of file <a class="el" href="OgrePredefinedControllers_8cpp-source.html">OgrePredefinedControllers.cpp</a>.
<p>
References <a class="el" href="OgrePredefinedControllers_8h-source.html#l00046">mTimeFactor</a>, and <a class="el" href="OgrePrerequisites_8h-source.html#l00086">Ogre::Real</a>. </td>
</tr>
</table>
<a name="Ogre_1_1FrameTimeControllerValuea4" doxytag="Ogre::FrameTimeControllerValue::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::FrameTimeControllerValue::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>
<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#l00064">64</a> of file <a class="el" href="OgrePredefinedControllers_8cpp-source.html">OgrePredefinedControllers.cpp</a>.
<p>
References <a class="el" href="OgrePrerequisites_8h-source.html#l00086">Ogre::Real</a>. </td>
</tr>
</table>
<hr><h2>Member Data Documentation</h2>
<a name="Ogre_1_1FrameTimeControllerValuen0" doxytag="Ogre::FrameTimeControllerValue::mFrameTime"></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::FrameTimeControllerValue::mFrameTime<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#l00045">45</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#l00047">frameStarted</a>(), <a class="el" href="OgrePredefinedControllers_8cpp-source.html#l00038">FrameTimeControllerValue</a>(), and <a class="el" href="OgrePredefinedControllers_8cpp-source.html#l00059">getValue</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1FrameTimeControllerValuen1" doxytag="Ogre::FrameTimeControllerValue::mTimeFactor"></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::FrameTimeControllerValue::mTimeFactor<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#l00046">46</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#l00047">frameStarted</a>(), <a class="el" href="OgrePredefinedControllers_8cpp-source.html#l00038">FrameTimeControllerValue</a>(), <a class="el" href="OgrePredefinedControllers_8cpp-source.html#l00069">getTimeFactor</a>(), and <a class="el" href="OgrePredefinedControllers_8cpp-source.html#l00073">setTimeFactor</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:16:33 2004
</p>
</body>
</html>
