-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy path_entity_8h_source.html
163 lines (163 loc) · 19.8 KB
/
_entity_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
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
<!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): Entity.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://cdn.jsdelivr.net/npm/mathjax@2/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.22.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">Entity.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-2022 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_ENTITY_H</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span><span class="preprocessor">#define GF_ENTITY_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 "GraphicsApi.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="l00032" name="l00032"></a><span class="lineno"> 32</span> <span class="keyword">struct </span>RenderStates;</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> <span class="keyword">class </span>RenderTarget;</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> </div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"><a class="line" href="classgf_1_1_entity.html"> 53</a></span> <span class="keyword">class </span>GF_GRAPHICS_API <a class="code hl_class" href="classgf_1_1_entity.html">Entity</a> {</div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> <span class="keyword">public</span>:</div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"><a class="line" href="classgf_1_1_entity.html#a99519191c150cca95cb808d0571737f1"> 62</a></span> <a class="code hl_function" href="classgf_1_1_entity.html#a99519191c150cca95cb808d0571737f1">Entity</a>(<span class="keywordtype">int</span> priority = 0)</div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span> : m_priority(priority)</div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span> , m_liveness(Liveness::Alive)</div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span> {</div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span> }</div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span> </div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"><a class="line" href="classgf_1_1_entity.html#a743d49f49356ab4266bef7eaaf52f78d"> 71</a></span> <span class="keyword">virtual</span> <a class="code hl_function" href="classgf_1_1_entity.html#a743d49f49356ab4266bef7eaaf52f78d">~Entity</a>();</div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span> </div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"><a class="line" href="classgf_1_1_entity.html#afeac5ce3bfddb9eb30bf4724700954b7"> 78</a></span> <span class="keywordtype">void</span> <a class="code hl_function" href="classgf_1_1_entity.html#afeac5ce3bfddb9eb30bf4724700954b7">setPriority</a>(<span class="keywordtype">int</span> priority) {</div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span> m_priority = priority;</div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span> }</div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span> </div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"><a class="line" href="classgf_1_1_entity.html#ac7b4f887f22a641f33847d0447628aa2"> 87</a></span> <span class="keywordtype">int</span> <a class="code hl_function" href="classgf_1_1_entity.html#ac7b4f887f22a641f33847d0447628aa2">getPriority</a>()<span class="keyword"> const </span>{</div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span> <span class="keywordflow">return</span> m_priority;</div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span> }</div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span> </div>
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno"><a class="line" href="classgf_1_1_entity.html#a8bcbcc4f3428f2e9fe9d7ad17bde9c0c"> 102</a></span> <span class="keywordtype">bool</span> <a class="code hl_function" href="classgf_1_1_entity.html#a8bcbcc4f3428f2e9fe9d7ad17bde9c0c">isAlive</a>()<span class="keyword"> const </span>{</div>
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno"> 103</span> <span class="keywordflow">return</span> m_liveness == Liveness::Alive;</div>
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno"> 104</span> }</div>
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno"> 105</span> </div>
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno"><a class="line" href="classgf_1_1_entity.html#adb6536cb376e132adbd8bbdcfe99204a"> 111</a></span> <span class="keywordtype">void</span> <a class="code hl_function" href="classgf_1_1_entity.html#adb6536cb376e132adbd8bbdcfe99204a">setAlive</a>() {</div>
<div class="line"><a id="l00112" name="l00112"></a><span class="lineno"> 112</span> m_liveness = Liveness::Alive;</div>
<div class="line"><a id="l00113" name="l00113"></a><span class="lineno"> 113</span> }</div>
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno"> 114</span> </div>
<div class="line"><a id="l00121" name="l00121"></a><span class="lineno"><a class="line" href="classgf_1_1_entity.html#ab41d1e2a08ce78c30466fecd6de0c837"> 121</a></span> <span class="keywordtype">void</span> <a class="code hl_function" href="classgf_1_1_entity.html#ab41d1e2a08ce78c30466fecd6de0c837">kill</a>() {</div>
<div class="line"><a id="l00122" name="l00122"></a><span class="lineno"> 122</span> m_liveness = Liveness::Dead;</div>
<div class="line"><a id="l00123" name="l00123"></a><span class="lineno"> 123</span> }</div>
<div class="line"><a id="l00124" name="l00124"></a><span class="lineno"> 124</span> </div>
<div class="line"><a id="l00137" name="l00137"></a><span class="lineno"><a class="line" href="classgf_1_1_entity.html#ac0e67948dc2be7a9fbb6206dc6dcaac7"> 137</a></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classgf_1_1_entity.html#ac0e67948dc2be7a9fbb6206dc6dcaac7">update</a>(<a class="code hl_class" href="classgf_1_1_time.html">Time</a> time);</div>
<div class="line"><a id="l00138" name="l00138"></a><span class="lineno"> 138</span> </div>
<div class="line"><a id="l00146" name="l00146"></a><span class="lineno"><a class="line" href="classgf_1_1_entity.html#a594f75d48d112e3020679b5d33f75d1e"> 146</a></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classgf_1_1_entity.html#a594f75d48d112e3020679b5d33f75d1e">render</a>(<a class="code hl_class" href="classgf_1_1_render_target.html">RenderTarget</a>& target, <span class="keyword">const</span> <a class="code hl_struct" href="structgf_1_1_render_states.html">RenderStates</a>& states);</div>
<div class="line"><a id="l00147" name="l00147"></a><span class="lineno"> 147</span> </div>
<div class="line"><a id="l00148" name="l00148"></a><span class="lineno"> 148</span> <span class="keyword">private</span>:</div>
<div class="line"><a id="l00149" name="l00149"></a><span class="lineno"> 149</span> <span class="keyword">enum class</span> Liveness : <span class="keywordtype">int</span> {</div>
<div class="line"><a id="l00150" name="l00150"></a><span class="lineno"> 150</span> Alive,</div>
<div class="line"><a id="l00151" name="l00151"></a><span class="lineno"> 151</span> Dead,</div>
<div class="line"><a id="l00152" name="l00152"></a><span class="lineno"> 152</span> };</div>
<div class="line"><a id="l00153" name="l00153"></a><span class="lineno"> 153</span> </div>
<div class="line"><a id="l00154" name="l00154"></a><span class="lineno"> 154</span> <span class="keywordtype">int</span> m_priority;</div>
<div class="line"><a id="l00155" name="l00155"></a><span class="lineno"> 155</span> Liveness m_liveness;</div>
<div class="line"><a id="l00156" name="l00156"></a><span class="lineno"> 156</span> };</div>
<div class="line"><a id="l00157" name="l00157"></a><span class="lineno"> 157</span> </div>
<div class="line"><a id="l00158" name="l00158"></a><span class="lineno"> 158</span><span class="preprocessor">#ifndef DOXYGEN_SHOULD_SKIP_THIS</span></div>
<div class="line"><a id="l00159" name="l00159"></a><span class="lineno"> 159</span>}</div>
<div class="line"><a id="l00160" name="l00160"></a><span class="lineno"> 160</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00161" name="l00161"></a><span class="lineno"> 161</span>}</div>
<div class="line"><a id="l00162" name="l00162"></a><span class="lineno"> 162</span> </div>
<div class="line"><a id="l00163" name="l00163"></a><span class="lineno"> 163</span><span class="preprocessor">#endif </span><span class="comment">// GF_ENTITY_H</span></div>
<div class="ttc" id="aclassgf_1_1_entity_html"><div class="ttname"><a href="classgf_1_1_entity.html">gf::Entity</a></div><div class="ttdoc">A game entity.</div><div class="ttdef"><b>Definition:</b> Entity.h:53</div></div>
<div class="ttc" id="aclassgf_1_1_entity_html_a594f75d48d112e3020679b5d33f75d1e"><div class="ttname"><a href="classgf_1_1_entity.html#a594f75d48d112e3020679b5d33f75d1e">gf::Entity::render</a></div><div class="ttdeci">virtual void render(RenderTarget &target, const RenderStates &states)</div><div class="ttdoc">Render the entity.</div></div>
<div class="ttc" id="aclassgf_1_1_entity_html_a743d49f49356ab4266bef7eaaf52f78d"><div class="ttname"><a href="classgf_1_1_entity.html#a743d49f49356ab4266bef7eaaf52f78d">gf::Entity::~Entity</a></div><div class="ttdeci">virtual ~Entity()</div><div class="ttdoc">Destructor.</div></div>
<div class="ttc" id="aclassgf_1_1_entity_html_a8bcbcc4f3428f2e9fe9d7ad17bde9c0c"><div class="ttname"><a href="classgf_1_1_entity.html#a8bcbcc4f3428f2e9fe9d7ad17bde9c0c">gf::Entity::isAlive</a></div><div class="ttdeci">bool isAlive() const</div><div class="ttdoc">Check if the entity is alive.</div><div class="ttdef"><b>Definition:</b> Entity.h:102</div></div>
<div class="ttc" id="aclassgf_1_1_entity_html_a99519191c150cca95cb808d0571737f1"><div class="ttname"><a href="classgf_1_1_entity.html#a99519191c150cca95cb808d0571737f1">gf::Entity::Entity</a></div><div class="ttdeci">Entity(int priority=0)</div><div class="ttdoc">Contructor.</div><div class="ttdef"><b>Definition:</b> Entity.h:62</div></div>
<div class="ttc" id="aclassgf_1_1_entity_html_ab41d1e2a08ce78c30466fecd6de0c837"><div class="ttname"><a href="classgf_1_1_entity.html#ab41d1e2a08ce78c30466fecd6de0c837">gf::Entity::kill</a></div><div class="ttdeci">void kill()</div><div class="ttdoc">Kill an entity.</div><div class="ttdef"><b>Definition:</b> Entity.h:121</div></div>
<div class="ttc" id="aclassgf_1_1_entity_html_ac0e67948dc2be7a9fbb6206dc6dcaac7"><div class="ttname"><a href="classgf_1_1_entity.html#ac0e67948dc2be7a9fbb6206dc6dcaac7">gf::Entity::update</a></div><div class="ttdeci">virtual void update(Time time)</div><div class="ttdoc">Update the entity's state.</div></div>
<div class="ttc" id="aclassgf_1_1_entity_html_ac7b4f887f22a641f33847d0447628aa2"><div class="ttname"><a href="classgf_1_1_entity.html#ac7b4f887f22a641f33847d0447628aa2">gf::Entity::getPriority</a></div><div class="ttdeci">int getPriority() const</div><div class="ttdoc">Get the priority of the entity.</div><div class="ttdef"><b>Definition:</b> Entity.h:87</div></div>
<div class="ttc" id="aclassgf_1_1_entity_html_adb6536cb376e132adbd8bbdcfe99204a"><div class="ttname"><a href="classgf_1_1_entity.html#adb6536cb376e132adbd8bbdcfe99204a">gf::Entity::setAlive</a></div><div class="ttdeci">void setAlive()</div><div class="ttdoc">Set the entity alive (again)</div><div class="ttdef"><b>Definition:</b> Entity.h:111</div></div>
<div class="ttc" id="aclassgf_1_1_entity_html_afeac5ce3bfddb9eb30bf4724700954b7"><div class="ttname"><a href="classgf_1_1_entity.html#afeac5ce3bfddb9eb30bf4724700954b7">gf::Entity::setPriority</a></div><div class="ttdeci">void setPriority(int priority)</div><div class="ttdoc">Set the priority of the entity.</div><div class="ttdef"><b>Definition:</b> Entity.h:78</div></div>
<div class="ttc" id="aclassgf_1_1_render_target_html"><div class="ttname"><a href="classgf_1_1_render_target.html">gf::RenderTarget</a></div><div class="ttdoc">Base class for all render targets (window, texture, ...)</div><div class="ttdef"><b>Definition:</b> RenderTarget.h:102</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="anamespacegf_html"><div class="ttname"><a href="namespacegf.html">gf</a></div><div class="ttdoc">The namespace for gf classes.</div></div>
<div class="ttc" id="astructgf_1_1_render_states_html"><div class="ttname"><a href="structgf_1_1_render_states.html">gf::RenderStates</a></div><div class="ttdoc">Define the states used for drawing to a RenderTarget.</div><div class="ttdef"><b>Definition:</b> RenderStates.h:82</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>