Sophie

Sophie

distrib > Mandriva > 2010.0 > i586 > media > contrib-release > by-pkgid > bad97183153701b09df5fae1052b1c30 > files > 1445

crystalspace-doc-1.2.1-5mdv2010.0.i586.rpm

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>Crystal Space 1.2.1: csutil/timer.h Source File (Crystal Space 1.2.1 Public API Reference)</title>
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<table border="0" cellpadding="0" cellspacing="0" width="100%" class="head">
 <tr height="59">
  <td class="head" width="202" valign="bottom" style="padding-left:0;"><a href="http://www.crystalspace3d.org/"><img src="csblur.png" width="236" height="59" alt="CrystalSpace" border="0"></a></td>
  <td class="head"><h2>Public API Reference</h2></td>
 </tr>
 <tr height="11">
  <td colspan="2" class="headshadow" valign="top" style="padding-left:0;"><img src="csblurb.png" width="236" height="11" alt="" border="0"></td>
 </tr>
</table>
<div class="content">
<!-- Generated by Doxygen 1.5.3 -->
<div class="tabs">
  <ul>
    <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
    <li><a href="modules.html"><span>Modules</span></a></li>
    <li><a href="namespaces.html"><span>Namespaces</span></a></li>
    <li><a href="classes.html"><span>Classes</span></a></li>
    <li class="current"><a href="files.html"><span>Files</span></a></li>
    <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
  </ul>
</div>
<h1>csutil/timer.h</h1><a href="csutil_2timer_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
<a name="l00002"></a>00002 <span class="comment">    Copyright (C) 2003 by Jorrit Tyberghein</span>
<a name="l00003"></a>00003 <span class="comment"></span>
<a name="l00004"></a>00004 <span class="comment">    This library is free software; you can redistribute it and/or</span>
<a name="l00005"></a>00005 <span class="comment">    modify it under the terms of the GNU Library General Public</span>
<a name="l00006"></a>00006 <span class="comment">    License as published by the Free Software Foundation; either</span>
<a name="l00007"></a>00007 <span class="comment">    version 2 of the License, or (at your option) any later version.</span>
<a name="l00008"></a>00008 <span class="comment"></span>
<a name="l00009"></a>00009 <span class="comment">    This library is distributed in the hope that it will be useful,</span>
<a name="l00010"></a>00010 <span class="comment">    but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00011"></a>00011 <span class="comment">    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU</span>
<a name="l00012"></a>00012 <span class="comment">    Library General Public License for more details.</span>
<a name="l00013"></a>00013 <span class="comment"></span>
<a name="l00014"></a>00014 <span class="comment">    You should have received a copy of the GNU Library General Public</span>
<a name="l00015"></a>00015 <span class="comment">    License along with this library; if not, write to the Free</span>
<a name="l00016"></a>00016 <span class="comment">    Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.</span>
<a name="l00017"></a>00017 <span class="comment">*/</span>
<a name="l00018"></a>00018 
<a name="l00019"></a>00019 <span class="preprocessor">#ifndef __CS_TIMER_H__</span>
<a name="l00020"></a>00020 <span class="preprocessor"></span><span class="preprocessor">#define __CS_TIMER_H__</span>
<a name="l00021"></a>00021 <span class="preprocessor"></span>
<a name="l00026"></a>00026 <span class="preprocessor">#include &lt;stdarg.h&gt;</span>
<a name="l00027"></a>00027 <span class="preprocessor">#include &lt;stdio.h&gt;</span>
<a name="l00028"></a>00028 <span class="preprocessor">#include "csextern.h"</span>
<a name="l00029"></a>00029 <span class="preprocessor">#include "<a class="code" href="csutil_2array_8h.html" title="Generic Array Template.">csutil/array.h</a>"</span>
<a name="l00030"></a>00030 <span class="preprocessor">#include "<a class="code" href="scf__implementation_8h.html" title="Crystal Space Shared Class Facility (SCF) - implementation creation support.">csutil/scf_implementation.h</a>"</span>
<a name="l00031"></a>00031 <span class="preprocessor">#include "<a class="code" href="iutil_2timer_8h.html" title="Timer event interfaces.">iutil/timer.h</a>"</span>
<a name="l00032"></a>00032 <span class="preprocessor">#include "<a class="code" href="iutil_2eventnames_8h.html" title="General event name resolver interface.">iutil/eventnames.h</a>"</span>
<a name="l00033"></a>00033 
<a name="l00034"></a>00034 <span class="keyword">struct </span><a class="code" href="structiEvent.html" title="This interface describes any system event.">iEvent</a>;
<a name="l00035"></a>00035 <span class="keyword">struct </span><a class="code" href="structiObjectRegistry.html" title="This interface serves as a registry of other objects.">iObjectRegistry</a>;
<a name="l00036"></a>00036 <span class="keyword">struct </span><a class="code" href="structiVirtualClock.html" title="A virtual game clock.">iVirtualClock</a>;
<a name="l00037"></a>00037 <span class="keyword">struct </span><a class="code" href="structiEventHandler.html" title="This interface describes an entity that can receive events.">iEventHandler</a>;
<a name="l00038"></a>00038 <span class="keyword">struct </span>timerevent;
<a name="l00039"></a>00039 
<a name="l00044"></a><a class="code" href="classcsEventTimer.html">00044</a> <span class="keyword">class </span>CS_CRYSTALSPACE_EXPORT <a class="code" href="classcsEventTimer.html" title="This class implements a timer.">csEventTimer</a> : 
<a name="l00045"></a>00045   <span class="keyword">public</span> <a class="code" href="classscfImplementation1.html">scfImplementation1</a>&lt;csEventTimer, iEventTimer&gt;
<a name="l00046"></a>00046 {
<a name="l00047"></a>00047 <span class="keyword">private</span>:
<a name="l00048"></a>00048   <a class="code" href="structiObjectRegistry.html" title="This interface serves as a registry of other objects.">iObjectRegistry</a>* object_reg;
<a name="l00049"></a>00049   <a class="code" href="group__event__handling.html#g51e1762faeeefdadf693499fc93db757" title="A csEventID is a handle for a string representing an event&amp;#39;s hierarchical name...">csEventID</a> FinalProcess;
<a name="l00050"></a>00050   <a class="code" href="classcsArray.html" title="A templated array class.">csArray&lt;timerevent&gt;</a> timerevents;
<a name="l00051"></a>00051   <a class="code" href="structiEventHandler.html" title="This interface describes an entity that can receive events.">iEventHandler</a>* handler;
<a name="l00052"></a>00052   <a class="code" href="classcsRef.html" title="A smart pointer.">csRef&lt;iVirtualClock&gt;</a> vc;
<a name="l00053"></a>00053 
<a name="l00054"></a>00054   <span class="keywordtype">size_t</span> FindTimerEvent (<a class="code" href="structiTimerEvent.html" title="A timer event.">iTimerEvent</a>* ev);
<a name="l00055"></a>00055 
<a name="l00056"></a>00056   <span class="comment">// Optimization: to prevent having to loop over all timer events</span>
<a name="l00057"></a>00057   <span class="comment">// all the time we keep the minimum time needed before the first</span>
<a name="l00058"></a>00058   <span class="comment">// event is triggered.</span>
<a name="l00059"></a>00059   <a class="code" href="group__util.html#g56f1a81c92849566ae864511088eb7e8" title="signed 32-bit integer (-2 147 483 648..2 147 483 647)">int32</a> minimum_time;
<a name="l00060"></a>00060   <a class="code" href="group__util.html#g56f1a81c92849566ae864511088eb7e8" title="signed 32-bit integer (-2 147 483 648..2 147 483 647)">int32</a> accumulate_elapsed;
<a name="l00061"></a>00061 
<a name="l00062"></a>00062 <span class="keyword">public</span>:
<a name="l00063"></a>00063   <a class="code" href="classcsEventTimer.html" title="This class implements a timer.">csEventTimer</a> (<a class="code" href="structiObjectRegistry.html" title="This interface serves as a registry of other objects.">iObjectRegistry</a>* object_reg);
<a name="l00064"></a>00064   <span class="keyword">virtual</span> ~<a class="code" href="classcsEventTimer.html" title="This class implements a timer.">csEventTimer</a> ();
<a name="l00065"></a>00065 
<a name="l00066"></a>00066   <span class="keywordtype">bool</span> HandleEvent (<a class="code" href="structiEvent.html" title="This interface describes any system event.">iEvent</a>&amp; e);
<a name="l00067"></a>00067 
<a name="l00068"></a>00068   <span class="keyword">virtual</span> <span class="keywordtype">void</span> AddTimerEvent (<a class="code" href="structiTimerEvent.html" title="A timer event.">iTimerEvent</a>* ev, <a class="code" href="group__util.html#g28e82998c4c2d1197a1d412bba7da793" title="A time value measured in milliseconds (1/1000 of a second).">csTicks</a> delay);
<a name="l00069"></a>00069   <span class="keyword">virtual</span> <span class="keywordtype">void</span> RemoveTimerEvent (<a class="code" href="structiTimerEvent.html" title="A timer event.">iTimerEvent</a>* ev);
<a name="l00070"></a>00070   <span class="keyword">virtual</span> <span class="keywordtype">void</span> RemoveAllTimerEvents ();
<a name="l00071"></a>00071 
<a name="l00072"></a><a class="code" href="classcsEventTimer.html#dbe80cf32749062636d9816f4a596b20">00072</a>   <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> GetEventCount ()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> timerevents.GetSize (); }
<a name="l00073"></a>00073   <span class="keyword">virtual</span> <a class="code" href="group__util.html#g28e82998c4c2d1197a1d412bba7da793" title="A time value measured in milliseconds (1/1000 of a second).">csTicks</a> GetTimeLeft (<span class="keywordtype">size_t</span> idx) <span class="keyword">const</span>;
<a name="l00074"></a>00074 
<a name="l00080"></a>00080   <span class="keyword">static</span> <a class="code" href="classcsPtr.html" title="A pointer encapsulator.">csPtr&lt;iEventTimer&gt;</a> GetStandardTimer (<a class="code" href="structiObjectRegistry.html" title="This interface serves as a registry of other objects.">iObjectRegistry</a>* object_reg);
<a name="l00081"></a>00081 };
<a name="l00082"></a>00082 
<a name="l00083"></a>00083 <span class="preprocessor">#endif // __CS_TIMER_H__</span>
<a name="l00084"></a>00084 <span class="preprocessor"></span>
</pre></div><hr size="1"><address><small>Generated for Crystal Space 1.2.1 by 
<a href="http://www.doxygen.org/index.html">doxygen</a> 1.5.3 
</small></address> </div></body> </html>

Perl :: Catalyst :: PostgreSQL :: RPM Valid HTML 4.01 Transitional