<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>FIFE: FIFE::TimeManager Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body onload='searchBox.OnSelectItem(0);'>
<!-- Generated by Doxygen 1.7.4 -->
<script type="text/javascript"><!--
var searchBox = new SearchBox("searchBox", "search",false,'Search');
--></script>
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">FIFE <span id="projectnumber">2008.0</span></div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="dirs.html"><span>Directories</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
<li id="searchli">
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
initNavTree('class_f_i_f_e_1_1_time_manager.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">FIFE::TimeManager Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="FIFE::TimeManager" --><!-- doxytag: inherits="DynamicSingleton< TimeManager >" -->
<p><code>#include <<a class="el" href="timemanager_8h_source.html">timemanager.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for FIFE::TimeManager:</div>
<div class="dyncontent">
<div class="center"><img src="class_f_i_f_e_1_1_time_manager__inherit__graph.png" border="0" usemap="#_f_i_f_e_1_1_time_manager_inherit__map" alt="Inheritance graph"/></div>
<map name="_f_i_f_e_1_1_time_manager_inherit__map" id="_f_i_f_e_1_1_time_manager_inherit__map">
<area shape="rect" id="node2" href="class_f_i_f_e_1_1_dynamic_singleton.html" title="{FIFE::DynamicSingleton\< TimeManager \>\n|- m_instance\l|+ DynamicSingleton()\l+ ~DynamicSingleton()\l+ instance()\l- DynamicSingleton()\l- operator=()\l}" alt="" coords="5,485,272,640"/><area shape="rect" id="node4" href="class_f_i_f_e_1_1_fife_class.html" title="{FIFE::FifeClass\n|- m_fifeid\l- m_refcount\l- m_curid\l|+ FifeClass()\l+ ~FifeClass()\l+ getFifeId()\l+ addRef()\l+ decRef()\l+ getRefCount()\l}" alt="" coords="101,6,216,213"/><area shape="rect" id="node6" href="class_f_i_f_e_1_1_dynamic_singleton.html" title="{FIFE::DynamicSingleton\< T \>\n|- m_instance\l|+ DynamicSingleton()\l+ ~DynamicSingleton()\l+ instance()\l- DynamicSingleton()\l- operator=()\l}" alt="" coords="155,264,352,419"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for FIFE::TimeManager:</div>
<div class="dyncontent">
<div class="center"><img src="class_f_i_f_e_1_1_time_manager__coll__graph.png" border="0" usemap="#_f_i_f_e_1_1_time_manager_coll__map" alt="Collaboration graph"/></div>
<map name="_f_i_f_e_1_1_time_manager_coll__map" id="_f_i_f_e_1_1_time_manager_coll__map">
<area shape="rect" id="node2" href="class_f_i_f_e_1_1_dynamic_singleton.html" title="{FIFE::DynamicSingleton\< TimeManager \>\n|- m_instance\l|+ DynamicSingleton()\l+ ~DynamicSingleton()\l+ instance()\l- DynamicSingleton()\l- operator=()\l}" alt="" coords="65,608,332,763"/><area shape="rect" id="node4" href="class_f_i_f_e_1_1_fife_class.html" title="{FIFE::FifeClass\n|- m_fifeid\l- m_refcount\l- m_curid\l|+ FifeClass()\l+ ~FifeClass()\l+ getFifeId()\l+ addRef()\l+ decRef()\l+ getRefCount()\l}" alt="" coords="200,6,315,213"/><area shape="rect" id="node7" href="class_f_i_f_e_1_1_dynamic_singleton.html" title="{FIFE::DynamicSingleton\< T \>\n|- m_instance\l|+ DynamicSingleton()\l+ ~DynamicSingleton()\l+ instance()\l- DynamicSingleton()\l- operator=()\l}" alt="" coords="253,325,451,480"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="class_f_i_f_e_1_1_time_manager-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_i_f_e_1_1_time_manager.html#a5e20cbdef9d25e0c702eefaad6a659bf">TimeManager</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_i_f_e_1_1_time_manager.html#ab2d34a62457f119434e76322b523882b">~TimeManager</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_i_f_e_1_1_time_manager.html#a569c077bed8bc6dd7fe4909db11a45b8">update</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_i_f_e_1_1_time_manager.html#ae260d36f655a36309b799d85a16cec1a">registerEvent</a> (<a class="el" href="class_f_i_f_e_1_1_time_event.html">TimeEvent</a> *event)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_i_f_e_1_1_time_manager.html#a39981683cef637ea96a8cfef6235a9c4">unregisterEvent</a> (<a class="el" href="class_f_i_f_e_1_1_time_event.html">TimeEvent</a> *event)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">unsigned long </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_i_f_e_1_1_time_manager.html#ad97ff59283ad39f5f7604c8f4fcc359e">getTime</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">unsigned long </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_i_f_e_1_1_time_manager.html#a1cde63e0dfa6509edcb33bb17a8c6d1a">getTimeDelta</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_i_f_e_1_1_time_manager.html#a1039a7e14a72f51b8c9b47016436ca30">getAverageFrameTime</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_i_f_e_1_1_time_manager.html#abae7df059b8073d7b347b4db65e0938b">printStatistics</a> () const </td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Time Manager</p>
<p>This class is in charge of storing the current time, average frame time, as well as controlling periodic events. Users of this class will have to manually register and unregister events.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="class_f_i_f_e_1_1_time_event.html">TimeEvent</a> </dd></dl>
<p>Definition at line <a class="el" href="timemanager_8h_source.html#l00049">49</a> of file <a class="el" href="timemanager_8h_source.html">timemanager.h</a>.</p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a5e20cbdef9d25e0c702eefaad6a659bf"></a><!-- doxytag: member="FIFE::TimeManager::TimeManager" ref="a5e20cbdef9d25e0c702eefaad6a659bf" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FIFE::TimeManager::TimeManager </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Default constructor. </p>
<p>Definition at line <a class="el" href="timemanager_8cpp_source.html#l00042">42</a> of file <a class="el" href="timemanager_8cpp_source.html">timemanager.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ab2d34a62457f119434e76322b523882b"></a><!-- doxytag: member="FIFE::TimeManager::~TimeManager" ref="ab2d34a62457f119434e76322b523882b" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FIFE::TimeManager::~TimeManager </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Destructor. </p>
<p>Definition at line <a class="el" href="timemanager_8cpp_source.html#l00048">48</a> of file <a class="el" href="timemanager_8cpp_source.html">timemanager.cpp</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a1039a7e14a72f51b8c9b47016436ca30"></a><!-- doxytag: member="FIFE::TimeManager::getAverageFrameTime" ref="a1039a7e14a72f51b8c9b47016436ca30" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double FIFE::TimeManager::getAverageFrameTime </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets average frame time</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Average frame time in milliseconds. </dd></dl>
<p>Definition at line <a class="el" href="timemanager_8cpp_source.html#l00108">108</a> of file <a class="el" href="timemanager_8cpp_source.html">timemanager.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ad97ff59283ad39f5f7604c8f4fcc359e"></a><!-- doxytag: member="FIFE::TimeManager::getTime" ref="ad97ff59283ad39f5f7604c8f4fcc359e" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned long FIFE::TimeManager::getTime </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the time.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The time in milliseconds. </dd></dl>
<p>Definition at line <a class="el" href="timemanager_8cpp_source.html#l00100">100</a> of file <a class="el" href="timemanager_8cpp_source.html">timemanager.cpp</a>.</p>
<p>Referenced by <a class="el" href="cursor_8cpp_source.html#l00145">FIFE::Cursor::draw()</a>, <a class="el" href="cursor_8cpp_source.html#l00098">FIFE::Cursor::set()</a>, and <a class="el" href="cursor_8cpp_source.html#l00122">FIFE::Cursor::setDrag()</a>.</p>
<p><div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="class_f_i_f_e_1_1_time_manager_ad97ff59283ad39f5f7604c8f4fcc359e_icgraph.png" border="0" usemap="#class_f_i_f_e_1_1_time_manager_ad97ff59283ad39f5f7604c8f4fcc359e_icgraph" alt=""/></div>
<map name="class_f_i_f_e_1_1_time_manager_ad97ff59283ad39f5f7604c8f4fcc359e_icgraph" id="class_f_i_f_e_1_1_time_manager_ad97ff59283ad39f5f7604c8f4fcc359e_icgraph">
<area shape="rect" id="node3" href="class_f_i_f_e_1_1_cursor.html#af570d8c901ab5b833d8cb819b0760fca" title="FIFE::Cursor::draw" alt="" coords="257,5,391,35"/><area shape="rect" id="node7" href="class_f_i_f_e_1_1_cursor.html#a21dd0cb6bc53366f2f15c7fe79feca0f" title="FIFE::Cursor::set" alt="" coords="263,59,385,88"/><area shape="rect" id="node9" href="class_f_i_f_e_1_1_cursor.html#a02f16b0d944a4b4405381b5d07dae935" title="FIFE::Cursor::setDrag" alt="" coords="248,112,400,141"/><area shape="rect" id="node5" href="class_f_i_f_e_1_1_engine.html#aaa1ab7210b65c1b610117515a68c7c40" title="FIFE::Engine::pump" alt="" coords="448,5,587,35"/></map>
</div>
</p>
</div>
</div>
<a class="anchor" id="a1cde63e0dfa6509edcb33bb17a8c6d1a"></a><!-- doxytag: member="FIFE::TimeManager::getTimeDelta" ref="a1cde63e0dfa6509edcb33bb17a8c6d1a" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned long FIFE::TimeManager::getTimeDelta </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the time since the last frame.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Time since last frame in milliseconds. </dd></dl>
<p>Definition at line <a class="el" href="timemanager_8cpp_source.html#l00104">104</a> of file <a class="el" href="timemanager_8cpp_source.html">timemanager.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="abae7df059b8073d7b347b4db65e0938b"></a><!-- doxytag: member="FIFE::TimeManager::printStatistics" ref="abae7df059b8073d7b347b4db65e0938b" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FIFE::TimeManager::printStatistics </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Prints Timer statistics </p>
<p>Definition at line <a class="el" href="timemanager_8cpp_source.html#l00112">112</a> of file <a class="el" href="timemanager_8cpp_source.html">timemanager.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ae260d36f655a36309b799d85a16cec1a"></a><!-- doxytag: member="FIFE::TimeManager::registerEvent" ref="ae260d36f655a36309b799d85a16cec1a" args="(TimeEvent *event)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FIFE::TimeManager::registerEvent </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_f_i_f_e_1_1_time_event.html">TimeEvent</a> * </td>
<td class="paramname"><em>event</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Adds a <a class="el" href="class_f_i_f_e_1_1_time_event.html">TimeEvent</a>.</p>
<p>The event will be updated regularly, depending on its settings. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">event</td><td>The <a class="el" href="class_f_i_f_e_1_1_time_event.html">TimeEvent</a> object to be added. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="timemanager_8cpp_source.html#l00084">84</a> of file <a class="el" href="timemanager_8cpp_source.html">timemanager.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a39981683cef637ea96a8cfef6235a9c4"></a><!-- doxytag: member="FIFE::TimeManager::unregisterEvent" ref="a39981683cef637ea96a8cfef6235a9c4" args="(TimeEvent *event)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FIFE::TimeManager::unregisterEvent </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_f_i_f_e_1_1_time_event.html">TimeEvent</a> * </td>
<td class="paramname"><em>event</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Removes a <a class="el" href="class_f_i_f_e_1_1_time_event.html">TimeEvent</a>.</p>
<p>Removes an event from the list. It will not be deleted. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">event</td><td>The <a class="el" href="class_f_i_f_e_1_1_time_event.html">TimeEvent</a> object to be removed. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="timemanager_8cpp_source.html#l00089">89</a> of file <a class="el" href="timemanager_8cpp_source.html">timemanager.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a569c077bed8bc6dd7fe4909db11a45b8"></a><!-- doxytag: member="FIFE::TimeManager::update" ref="a569c077bed8bc6dd7fe4909db11a45b8" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FIFE::TimeManager::update </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Called once a frame and updates the timer objects and events. </p>
<p>Definition at line <a class="el" href="timemanager_8cpp_source.html#l00051">51</a> of file <a class="el" href="timemanager_8cpp_source.html">timemanager.cpp</a>.</p>
<p>Referenced by <a class="el" href="engine_8cpp_source.html#l00362">FIFE::Engine::pump()</a>.</p>
<p><div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="class_f_i_f_e_1_1_time_manager_a569c077bed8bc6dd7fe4909db11a45b8_icgraph.png" border="0" usemap="#class_f_i_f_e_1_1_time_manager_a569c077bed8bc6dd7fe4909db11a45b8_icgraph" alt=""/></div>
<map name="class_f_i_f_e_1_1_time_manager_a569c077bed8bc6dd7fe4909db11a45b8_icgraph" id="class_f_i_f_e_1_1_time_manager_a569c077bed8bc6dd7fe4909db11a45b8_icgraph">
<area shape="rect" id="node3" href="class_f_i_f_e_1_1_engine.html#aaa1ab7210b65c1b610117515a68c7c40" title="FIFE::Engine::pump" alt="" coords="240,5,379,35"/></map>
</div>
</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>engine/core/util/time/<a class="el" href="timemanager_8h_source.html">timemanager.h</a></li>
<li>engine/core/util/time/<a class="el" href="timemanager_8cpp_source.html">timemanager.cpp</a></li>
</ul>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespace_f_i_f_e.html">FIFE</a> </li>
<li class="navelem"><a class="el" href="class_f_i_f_e_1_1_time_manager.html">TimeManager</a> </li>
<li class="footer">Generated on Sun Jul 10 2011 for FIFE by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerator</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
</body>
</html>
