<!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::TimeEvent 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_event.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::TimeEvent Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="FIFE::TimeEvent" -->
<p><code>#include <<a class="el" href="timeevent_8h_source.html">timeevent.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for FIFE::TimeEvent:</div>
<div class="dyncontent">
<div class="center"><img src="class_f_i_f_e_1_1_time_event__inherit__graph.png" border="0" usemap="#_f_i_f_e_1_1_time_event_inherit__map" alt="Inheritance graph"/></div>
<map name="_f_i_f_e_1_1_time_event_inherit__map" id="_f_i_f_e_1_1_time_event_inherit__map">
<area shape="rect" id="node3" href="class_f_i_f_e_1_1_sound_emitter.html" title="{FIFE::SoundEmitter\n|- m_manager\l- m_pool\l- m_source\l- m_soundclip\l- m_soundclipid\l- m_streamid\l- m_emitterid\l- m_loop\l- m_callback\l|+ SoundEmitter()\l+ ~SoundEmitter()\l+ getId()\l+ setPositioning()\l+ setRolloff()\l+ setSoundClip()\l+ setCallback()\l+ reset()\l+ release()\l+ setLooping()\l+ play()\l+ stop()\l+ pause()\l+ setGain()\l+ getGain()\l+ isStereo()\l+ getBitResolution()\l+ getSampleRate()\l+ getDecodedLength()\l+ getDuration()\l+ setCursor()\l+ getCursor()\l+ setPosition()\l+ setVelocity()\l- updateEvent()\l- attachSoundClip()\l}" alt="" coords="15,278,164,935"/></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_event-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_event.html#a99f4ce27abcd1c767f40865204b043b4">TimeEvent</a> (int period=-1)</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_event.html#a664ce9aab3c5a0f7aaa672d1d21f8a40">~TimeEvent</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_i_f_e_1_1_time_event.html#af3b681a4f786960c5a88e14d82b23a13">updateEvent</a> (unsigned long time)=0</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_event.html#a94874211d560b123e33b41ae3d4b90c1">managerUpdateEvent</a> (unsigned long time)</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_event.html#a8e90d94de6f79ab12fe9749f4da19433">setPeriod</a> (int period)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_i_f_e_1_1_time_event.html#a1ddf9e17360425abffd14d6535cc723b">getPeriod</a> ()</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_event.html#a1bc353acd80c95f736ac233e4859cf19">getLastUpdateTime</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_event.html#abe1b2d8f404bea058f169bea91c2a5a7">setLastUpdateTime</a> (unsigned long)</td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Interface for events to be registered with <a class="el" href="class_f_i_f_e_1_1_time_manager.html">TimeManager</a>.</p>
<p>To register a class with <a class="el" href="class_f_i_f_e_1_1_time_manager.html">TimeManager</a> firstly derive a class from this and override the <a class="el" href="class_f_i_f_e_1_1_time_event.html#af3b681a4f786960c5a88e14d82b23a13">updateEvent()</a> function. <a class="el" href="class_f_i_f_e_1_1_time_event.html#af3b681a4f786960c5a88e14d82b23a13">updateEvent()</a> will be called periodically depending on the value of <a class="el" href="class_f_i_f_e_1_1_time_event.html#a1ddf9e17360425abffd14d6535cc723b">getPeriod()</a> which can be set using the constructor or <a class="el" href="class_f_i_f_e_1_1_time_event.html#a8e90d94de6f79ab12fe9749f4da19433">setPeriod()</a>. A value of -1 will never be updated, 0 will updated every frame and a value over 0 defines the number of milliseconds between updates.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="class_f_i_f_e_1_1_time_manager.html">TimeManager</a> </dd></dl>
<p>Definition at line <a class="el" href="timeevent_8h_source.html#l00047">47</a> of file <a class="el" href="timeevent_8h_source.html">timeevent.h</a>.</p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a99f4ce27abcd1c767f40865204b043b4"></a><!-- doxytag: member="FIFE::TimeEvent::TimeEvent" ref="a99f4ce27abcd1c767f40865204b043b4" args="(int period=-1)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FIFE::TimeEvent::TimeEvent </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>period</em> = <code>-1</code></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Default constructor.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">period</td><td>The period of the event. See class description. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="timeevent_8cpp_source.html#l00037">37</a> of file <a class="el" href="timeevent_8cpp_source.html">timeevent.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a664ce9aab3c5a0f7aaa672d1d21f8a40"></a><!-- doxytag: member="FIFE::TimeEvent::~TimeEvent" ref="a664ce9aab3c5a0f7aaa672d1d21f8a40" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FIFE::TimeEvent::~TimeEvent </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="timeevent_8cpp_source.html#l00042">42</a> of file <a class="el" href="timeevent_8cpp_source.html">timeevent.cpp</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a1bc353acd80c95f736ac233e4859cf19"></a><!-- doxytag: member="FIFE::TimeEvent::getLastUpdateTime" ref="a1bc353acd80c95f736ac233e4859cf19" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned long FIFE::TimeEvent::getLastUpdateTime </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the last time the event was updated.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Time of last update. </dd></dl>
<p>Definition at line <a class="el" href="timeevent_8cpp_source.html#l00064">64</a> of file <a class="el" href="timeevent_8cpp_source.html">timeevent.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a1ddf9e17360425abffd14d6535cc723b"></a><!-- doxytag: member="FIFE::TimeEvent::getPeriod" ref="a1ddf9e17360425abffd14d6535cc723b" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int FIFE::TimeEvent::getPeriod </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the period of the event.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The period of the event. See class description. </dd></dl>
<p>Definition at line <a class="el" href="timeevent_8cpp_source.html#l00060">60</a> of file <a class="el" href="timeevent_8cpp_source.html">timeevent.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a94874211d560b123e33b41ae3d4b90c1"></a><!-- doxytag: member="FIFE::TimeEvent::managerUpdateEvent" ref="a94874211d560b123e33b41ae3d4b90c1" args="(unsigned long time)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FIFE::TimeEvent::managerUpdateEvent </td>
<td>(</td>
<td class="paramtype">unsigned long </td>
<td class="paramname"><em>time</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Called by <a class="el" href="class_f_i_f_e_1_1_time_manager.html">TimeManager</a> to update the event.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">time</td><td>Current time. Used To check if its time to update. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="timeevent_8cpp_source.html#l00046">46</a> of file <a class="el" href="timeevent_8cpp_source.html">timeevent.cpp</a>.</p>
<p>References <a class="el" href="class_f_i_f_e_1_1_time_event.html#af3b681a4f786960c5a88e14d82b23a13">updateEvent()</a>.</p>
</div>
</div>
<a class="anchor" id="abe1b2d8f404bea058f169bea91c2a5a7"></a><!-- doxytag: member="FIFE::TimeEvent::setLastUpdateTime" ref="abe1b2d8f404bea058f169bea91c2a5a7" args="(unsigned long)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FIFE::TimeEvent::setLastUpdateTime </td>
<td>(</td>
<td class="paramtype">unsigned long </td>
<td class="paramname"><em>ms</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the last time the event was updated.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">Time</td><td>of last update. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="timeevent_8cpp_source.html#l00068">68</a> of file <a class="el" href="timeevent_8cpp_source.html">timeevent.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a8e90d94de6f79ab12fe9749f4da19433"></a><!-- doxytag: member="FIFE::TimeEvent::setPeriod" ref="a8e90d94de6f79ab12fe9749f4da19433" args="(int period)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FIFE::TimeEvent::setPeriod </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>period</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the period of the event.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">period</td><td>The period of the event. See class description. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="timeevent_8cpp_source.html#l00056">56</a> of file <a class="el" href="timeevent_8cpp_source.html">timeevent.cpp</a>.</p>
<p>Referenced by <a class="el" href="soundemitter_8cpp_source.html#l00176">FIFE::SoundEmitter::play()</a>, <a class="el" href="soundemitter_8cpp_source.html#l00065">FIFE::SoundEmitter::reset()</a>, <a class="el" href="soundemitter_8cpp_source.html#l00198">FIFE::SoundEmitter::setCursor()</a>, and <a class="el" href="soundemitter_8cpp_source.html#l00185">FIFE::SoundEmitter::stop()</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_event_a8e90d94de6f79ab12fe9749f4da19433_icgraph.png" border="0" usemap="#class_f_i_f_e_1_1_time_event_a8e90d94de6f79ab12fe9749f4da19433_icgraph" alt=""/></div>
<map name="class_f_i_f_e_1_1_time_event_a8e90d94de6f79ab12fe9749f4da19433_icgraph" id="class_f_i_f_e_1_1_time_event_a8e90d94de6f79ab12fe9749f4da19433_icgraph">
<area shape="rect" id="node3" href="class_f_i_f_e_1_1_sound_emitter.html#acd547fc1aa1b33ecbea0afe889cf16ec" title="FIFE::SoundEmitter::play" alt="" coords="256,5,427,35"/><area shape="rect" id="node5" href="class_f_i_f_e_1_1_sound_emitter.html#ac9ee9df79f4a012a62e80918014158da" title="FIFE::SoundEmitter::reset" alt="" coords="255,59,428,88"/><area shape="rect" id="node7" href="class_f_i_f_e_1_1_sound_emitter.html#a4b81b8980d9301b8aeb02611e8eca4c1" title="FIFE::SoundEmitter::setCursor" alt="" coords="240,112,443,141"/><area shape="rect" id="node9" href="class_f_i_f_e_1_1_sound_emitter.html#a6682813f18e1d3e453a81cd15f983e2f" title="FIFE::SoundEmitter::stop" alt="" coords="491,139,661,168"/></map>
</div>
</p>
</div>
</div>
<a class="anchor" id="af3b681a4f786960c5a88e14d82b23a13"></a><!-- doxytag: member="FIFE::TimeEvent::updateEvent" ref="af3b681a4f786960c5a88e14d82b23a13" args="(unsigned long time)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void FIFE::TimeEvent::updateEvent </td>
<td>(</td>
<td class="paramtype">unsigned long </td>
<td class="paramname"><em>time</em></td><td>)</td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Update function to be overridden by client.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">time_delta</td><td>Time. </td></tr>
</table>
</dd>
</dl>
<p>Referenced by <a class="el" href="timeevent_8cpp_source.html#l00046">managerUpdateEvent()</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_event_af3b681a4f786960c5a88e14d82b23a13_icgraph.png" border="0" usemap="#class_f_i_f_e_1_1_time_event_af3b681a4f786960c5a88e14d82b23a13_icgraph" alt=""/></div>
<map name="class_f_i_f_e_1_1_time_event_af3b681a4f786960c5a88e14d82b23a13_icgraph" id="class_f_i_f_e_1_1_time_event_af3b681a4f786960c5a88e14d82b23a13_icgraph">
<area shape="rect" id="node3" href="class_f_i_f_e_1_1_time_event.html#a94874211d560b123e33b41ae3d4b90c1" title="FIFE::TimeEvent::managerUpdateEvent" alt="" coords="256,5,512,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="timeevent_8h_source.html">timeevent.h</a></li>
<li>engine/core/util/time/<a class="el" href="timeevent_8cpp_source.html">timeevent.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_event.html">TimeEvent</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>
