-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy path_activity_8h_source.html
125 lines (125 loc) · 13.6 KB
/
_activity_8h_source.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
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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=11"/>
<meta name="generator" content="Doxygen 1.9.3"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Gamedev Framework (gf): Activity.h Source File</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>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
extensions: ["tex2jax.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script>
<script type="text/javascript" async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="custom.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 id="projectrow">
<td id="projectlogo"><img alt="Logo" src="gf_logo.png"/></td>
<td id="projectalign">
<div id="projectname">Gamedev Framework (gf)<span id="projectnumber"> 0.21.0</span>
</div>
<div id="projectbrief">A C++17 framework for 2D games</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.3 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(function() {
initMenu('',false,false,'search.php','Search');
});
/* @license-end */
</script>
<div id="main-nav"></div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_6d069d519ae9d12fa11dd8e685586b60.html">gf</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">Activity.h</div></div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">/*</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment"> * Gamedev Framework (gf)</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment"> * Copyright (C) 2016-2021 Julien Bernard</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment"> *</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment"> * This software is provided 'as-is', without any express or implied</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="comment"> * warranty. In no event will the authors be held liable for any damages</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="comment"> * arising from the use of this software.</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="comment"> *</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="comment"> * Permission is granted to anyone to use this software for any purpose,</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="comment"> * including commercial applications, and to alter it and redistribute it</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="comment"> * freely, subject to the following restrictions:</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="comment"> *</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="comment"> * 1. The origin of this software must not be misrepresented; you must not</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="comment"> * claim that you wrote the original software. If you use this software</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="comment"> * in a product, an acknowledgment in the product documentation would be</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="comment"> * appreciated but is not required.</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="comment"> * 2. Altered source versions must be plainly marked as such, and must not be</span></div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="comment"> * misrepresented as being the original software.</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span><span class="comment"> * 3. This notice may not be removed or altered from any source distribution.</span></div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="comment"> */</span></div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="preprocessor">#ifndef GF_ACTIVITY_H</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span><span class="preprocessor">#define GF_ACTIVITY_H</span></div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> </div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span><span class="preprocessor">#include "CoreApi.h"</span></div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="preprocessor">#include "Time.h"</span></div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> </div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespacegf.html">gf</a> {</div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span><span class="preprocessor">#ifndef DOXYGEN_SHOULD_SKIP_THIS</span></div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span><span class="keyword">inline</span> <span class="keyword">namespace </span>v1 {</div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> </div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"><a class="line" href="group__core__animation.html#gac51a053dba8754067dd4bbbf793754df"> 38</a></span> <span class="keyword">enum class</span> <a class="code hl_enumeration" href="group__core__animation.html#gac51a053dba8754067dd4bbbf793754df">ActivityStatus</a> {</div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> <a class="code hl_enumvalue" href="group__core__animation.html#ggac51a053dba8754067dd4bbbf793754dfa5bda814c4aedb126839228f1a3d92f09">Running</a>, </div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> <a class="code hl_enumvalue" href="group__core__animation.html#ggac51a053dba8754067dd4bbbf793754dfa8f3d10eb21bd36347c258679eba9e92b">Finished</a>, </div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> };</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> </div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"><a class="line" href="classgf_1_1_activity.html"> 62</a></span> <span class="keyword">class </span>GF_CORE_API <a class="code hl_class" href="classgf_1_1_activity.html">Activity</a> {</div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span> <span class="keyword">public</span>:</div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"><a class="line" href="classgf_1_1_activity.html#a541a05bc394bc48e1a6f38f91959f2b0"> 67</a></span> <span class="keyword">virtual</span> <a class="code hl_function" href="classgf_1_1_activity.html#a541a05bc394bc48e1a6f38f91959f2b0">~Activity</a>();</div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span> </div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"><a class="line" href="classgf_1_1_activity.html#a0299bd0365cbf50648135bf3d6d406d0"> 75</a></span> <span class="keyword">virtual</span> <a class="code hl_enumeration" href="group__core__animation.html#gac51a053dba8754067dd4bbbf793754df">ActivityStatus</a> <a class="code hl_function" href="classgf_1_1_activity.html#a0299bd0365cbf50648135bf3d6d406d0">run</a>(<a class="code hl_class" href="classgf_1_1_time.html">Time</a> time) = 0;</div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span> </div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"><a class="line" href="classgf_1_1_activity.html#a9bd70c04b696b39d2e5d2ecb84a07a87"> 80</a></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classgf_1_1_activity.html#a9bd70c04b696b39d2e5d2ecb84a07a87">restart</a>();</div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span> };</div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span> </div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span><span class="preprocessor">#ifndef DOXYGEN_SHOULD_SKIP_THIS</span></div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span>}</div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno"> 86</span>}</div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span> </div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span><span class="preprocessor">#endif </span><span class="comment">// GF_ACTIVITY_H</span></div>
<div class="ttc" id="aclassgf_1_1_activity_html"><div class="ttname"><a href="classgf_1_1_activity.html">gf::Activity</a></div><div class="ttdoc">A game activity.</div><div class="ttdef"><b>Definition:</b> Activity.h:62</div></div>
<div class="ttc" id="aclassgf_1_1_activity_html_a0299bd0365cbf50648135bf3d6d406d0"><div class="ttname"><a href="classgf_1_1_activity.html#a0299bd0365cbf50648135bf3d6d406d0">gf::Activity::run</a></div><div class="ttdeci">virtual ActivityStatus run(Time time)=0</div><div class="ttdoc">Run the activity.</div></div>
<div class="ttc" id="aclassgf_1_1_activity_html_a541a05bc394bc48e1a6f38f91959f2b0"><div class="ttname"><a href="classgf_1_1_activity.html#a541a05bc394bc48e1a6f38f91959f2b0">gf::Activity::~Activity</a></div><div class="ttdeci">virtual ~Activity()</div><div class="ttdoc">Destructor.</div></div>
<div class="ttc" id="aclassgf_1_1_activity_html_a9bd70c04b696b39d2e5d2ecb84a07a87"><div class="ttname"><a href="classgf_1_1_activity.html#a9bd70c04b696b39d2e5d2ecb84a07a87">gf::Activity::restart</a></div><div class="ttdeci">virtual void restart()</div><div class="ttdoc">Restart the activity.</div></div>
<div class="ttc" id="aclassgf_1_1_time_html"><div class="ttname"><a href="classgf_1_1_time.html">gf::Time</a></div><div class="ttdoc">Represents a time value.</div><div class="ttdef"><b>Definition:</b> Time.h:65</div></div>
<div class="ttc" id="agroup__core__animation_html_gac51a053dba8754067dd4bbbf793754df"><div class="ttname"><a href="group__core__animation.html#gac51a053dba8754067dd4bbbf793754df">gf::ActivityStatus</a></div><div class="ttdeci">ActivityStatus</div><div class="ttdoc">Status of an activity.</div><div class="ttdef"><b>Definition:</b> Activity.h:38</div></div>
<div class="ttc" id="agroup__core__animation_html_ggac51a053dba8754067dd4bbbf793754dfa5bda814c4aedb126839228f1a3d92f09"><div class="ttname"><a href="group__core__animation.html#ggac51a053dba8754067dd4bbbf793754dfa5bda814c4aedb126839228f1a3d92f09">gf::ActivityStatus::Running</a></div><div class="ttdeci">@ Running</div><div class="ttdoc">The activity is still running.</div></div>
<div class="ttc" id="agroup__core__animation_html_ggac51a053dba8754067dd4bbbf793754dfa8f3d10eb21bd36347c258679eba9e92b"><div class="ttname"><a href="group__core__animation.html#ggac51a053dba8754067dd4bbbf793754dfa8f3d10eb21bd36347c258679eba9e92b">gf::ActivityStatus::Finished</a></div><div class="ttdeci">@ Finished</div><div class="ttdoc">The activity is finished.</div></div>
<div class="ttc" id="anamespacegf_html"><div class="ttname"><a href="namespacegf.html">gf</a></div><div class="ttdoc">The namespace for gf classes.</div><div class="ttdef"><b>Definition:</b> Action.h:35</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.3
</small></address>
</body>
</html>