-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathclasshb_1_1Clock.html
231 lines (219 loc) · 12.7 KB
/
classhb_1_1Clock.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
<!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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.8"/>
<title>Hummingbird Framework: hb::Clock Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Hummingbird Framework
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.8 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</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>
<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="classes.html"><span>Class Index</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><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('classhb_1_1Clock.html','');});
</script>
<div id="doc-content">
<!-- 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>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Modules</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Pages</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>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="classhb_1_1Clock-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">hb::Clock Class Reference<div class="ingroups"><a class="el" href="group__core.html">Hummingbird Core</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>A class for measuring <a class="el" href="classhb_1_1Time.html" title="Class for representing intervals of time. ">Time</a> intervals.
<a href="classhb_1_1Clock.html#details">More...</a></p>
<p><code>#include <<a class="el" href="Clock_8h_source.html">Clock.h</a>></code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a8beeb692fb23d602f6b93e7719867fd8"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classhb_1_1Clock.html#a8beeb692fb23d602f6b93e7719867fd8">Clock</a> ()</td></tr>
<tr class="memdesc:a8beeb692fb23d602f6b93e7719867fd8"><td class="mdescLeft"> </td><td class="mdescRight">Class constructor. <a href="#a8beeb692fb23d602f6b93e7719867fd8">More...</a><br /></td></tr>
<tr class="separator:a8beeb692fb23d602f6b93e7719867fd8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab6c02100c85d07910b997684b1975b8f"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classhb_1_1Clock.html#ab6c02100c85d07910b997684b1975b8f">~Clock</a> ()</td></tr>
<tr class="memdesc:ab6c02100c85d07910b997684b1975b8f"><td class="mdescLeft"> </td><td class="mdescRight">Class destructor. <a href="#ab6c02100c85d07910b997684b1975b8f">More...</a><br /></td></tr>
<tr class="separator:ab6c02100c85d07910b997684b1975b8f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a99c613d878168ddc06b117591d9238a0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classhb_1_1Time.html">Time</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classhb_1_1Clock.html#a99c613d878168ddc06b117591d9238a0">getElapsedTime</a> () const </td></tr>
<tr class="memdesc:a99c613d878168ddc06b117591d9238a0"><td class="mdescLeft"> </td><td class="mdescRight">Returns the <a class="el" href="classhb_1_1Time.html" title="Class for representing intervals of time. ">Time</a> elapsed since creation or last reset. <a href="#a99c613d878168ddc06b117591d9238a0">More...</a><br /></td></tr>
<tr class="separator:a99c613d878168ddc06b117591d9238a0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aeaaa06ca99ed4d4ec7e6e234a5c23729"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classhb_1_1Time.html">Time</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classhb_1_1Clock.html#aeaaa06ca99ed4d4ec7e6e234a5c23729">reset</a> ()</td></tr>
<tr class="memdesc:aeaaa06ca99ed4d4ec7e6e234a5c23729"><td class="mdescLeft"> </td><td class="mdescRight">Restarts the <a class="el" href="classhb_1_1Time.html" title="Class for representing intervals of time. ">Time</a> counter. <a href="#aeaaa06ca99ed4d4ec7e6e234a5c23729">More...</a><br /></td></tr>
<tr class="separator:aeaaa06ca99ed4d4ec7e6e234a5c23729"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>A class for measuring <a class="el" href="classhb_1_1Time.html" title="Class for representing intervals of time. ">Time</a> intervals. </p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="a8beeb692fb23d602f6b93e7719867fd8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">hb::Clock::Clock </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Class constructor. </p>
<p>Initializes a new instance of <a class="el" href="classhb_1_1Clock.html" title="A class for measuring Time intervals. ">Clock</a> wich starts measuring the time as it is created. </p>
</div>
</div>
<a class="anchor" id="ab6c02100c85d07910b997684b1975b8f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">hb::Clock::~Clock </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Class destructor. </p>
<p>Destroys the instance of <a class="el" href="classhb_1_1Clock.html" title="A class for measuring Time intervals. ">Clock</a>. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a99c613d878168ddc06b117591d9238a0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classhb_1_1Time.html">Time</a> hb::Clock::getElapsedTime </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the <a class="el" href="classhb_1_1Time.html" title="Class for representing intervals of time. ">Time</a> elapsed since creation or last reset. </p>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="classhb_1_1Time.html" title="Class for representing intervals of time. ">Time</a> since instance creation or last <a class="el" href="classhb_1_1Clock.html#aeaaa06ca99ed4d4ec7e6e234a5c23729" title="Restarts the Time counter. ">reset()</a>. </dd></dl>
</div>
</div>
<a class="anchor" id="aeaaa06ca99ed4d4ec7e6e234a5c23729"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classhb_1_1Time.html">Time</a> hb::Clock::reset </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Restarts the <a class="el" href="classhb_1_1Time.html" title="Class for representing intervals of time. ">Time</a> counter. </p>
<p>This function also returns the time elapsed up to its reset. This is usefull for getting precise delta times without having time overhead for having to call two methods: </p><div class="fragment"><div class="line"><a class="code" href="classhb_1_1Clock.html">hb::Clock</a> clk;</div>
<div class="line"><span class="keywordflow">while</span>(game_is_running)</div>
<div class="line">{</div>
<div class="line"> <a class="code" href="classhb_1_1Time.html">hb::Time</a> deltaTime = clk.<a class="code" href="classhb_1_1Clock.html#aeaaa06ca99ed4d4ec7e6e234a5c23729">reset</a>();</div>
<div class="line"> ... <span class="comment">// Game code</span></div>
<div class="line">}</div>
</div><!-- fragment --><dl class="section return"><dt>Returns</dt><dd><a class="el" href="classhb_1_1Time.html" title="Class for representing intervals of time. ">Time</a> since instance creation or last <a class="el" href="classhb_1_1Clock.html#aeaaa06ca99ed4d4ec7e6e234a5c23729" title="Restarts the Time counter. ">reset()</a>. </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>Core/Core/<a class="el" href="Clock_8h_source.html">Clock.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><b>hb</b></li><li class="navelem"><a class="el" href="classhb_1_1Clock.html">Clock</a></li>
<li class="footer">Generated on Sat Apr 4 2015 15:01:46 for Hummingbird Framework by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.8 </li>
</ul>
</div>
</body>
</html>