-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy path_entity_8h_source.html
77 lines (77 loc) · 17.6 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
<!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.13"/>
<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" src="http://cdn.mathjax.org/mathjax/latest/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 style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="gf_logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Gamedev Framework (gf)
 <span id="projectnumber">0.14.0</span>
</div>
<div id="projectbrief">A C++14 framework for 2D games</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',false,false,'search.php','Search');
});
</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 name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * Gamedev Framework (gf)</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * Copyright (C) 2016-2019 Julien Bernard</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> *</span></div><div class="line"><a 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 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 name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * arising from the use of this software.</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> *</span></div><div class="line"><a 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 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 name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * freely, subject to the following restrictions:</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> *</span></div><div class="line"><a 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 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 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 name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> * appreciated but is not required.</span></div><div class="line"><a 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 name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> * misrepresented as being the original software.</span></div><div class="line"><a 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 name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> */</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#ifndef GF_ENTITY_H</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#define GF_ENTITY_H</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> </div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include "Portability.h"</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include "Time.h"</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> </div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="keyword">namespace </span><a class="code" href="namespacegf.html">gf</a> {</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#ifndef DOXYGEN_SHOULD_SKIP_THIS</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="keyword">inline</span> <span class="keyword">namespace </span>v1 {</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> </div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  <span class="keyword">struct </span>RenderStates;</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  <span class="keyword">class </span>RenderTarget;</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> </div><div class="line"><a name="l00053"></a><span class="lineno"><a class="line" href="classgf_1_1_entity.html"> 53</a></span>  <span class="keyword">class </span>GF_API <a class="code" href="classgf_1_1_entity.html">Entity</a> {</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00062"></a><span class="lineno"><a class="line" href="classgf_1_1_entity.html#a99519191c150cca95cb808d0571737f1"> 62</a></span>  <a class="code" href="classgf_1_1_entity.html#a99519191c150cca95cb808d0571737f1">Entity</a>(<span class="keywordtype">int</span> priority = 0)</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  : m_priority(priority)</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  , m_liveness(Liveness::ALIVE)</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  {</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  }</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> </div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <span class="keyword">virtual</span> ~<a class="code" href="classgf_1_1_entity.html">Entity</a>();</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span> </div><div class="line"><a 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" href="classgf_1_1_entity.html#afeac5ce3bfddb9eb30bf4724700954b7">setPriority</a>(<span class="keywordtype">int</span> priority) {</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  m_priority = priority;</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  }</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span> </div><div class="line"><a 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" href="classgf_1_1_entity.html#ac7b4f887f22a641f33847d0447628aa2">getPriority</a>()<span class="keyword"> const </span>{</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  <span class="keywordflow">return</span> m_priority;</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  }</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span> </div><div class="line"><a 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" href="classgf_1_1_entity.html#a8bcbcc4f3428f2e9fe9d7ad17bde9c0c">isAlive</a>()<span class="keyword"> const </span>{</div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  <span class="keywordflow">return</span> m_liveness == Liveness::ALIVE;</div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  }</div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span> </div><div class="line"><a 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" href="classgf_1_1_entity.html#adb6536cb376e132adbd8bbdcfe99204a">setAlive</a>() {</div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  m_liveness = Liveness::ALIVE;</div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  }</div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span> </div><div class="line"><a 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" href="classgf_1_1_entity.html#ab41d1e2a08ce78c30466fecd6de0c837">kill</a>() {</div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span>  m_liveness = Liveness::DEAD;</div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span>  }</div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span> </div><div class="line"><a name="l00137"></a><span class="lineno"> 137</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> update(<a class="code" href="classgf_1_1_time.html">Time</a> time);</div><div class="line"><a name="l00138"></a><span class="lineno"> 138</span> </div><div class="line"><a name="l00146"></a><span class="lineno"> 146</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> render(<a class="code" href="classgf_1_1_render_target.html">RenderTarget</a>& target, <span class="keyword">const</span> <a class="code" href="structgf_1_1_render_states.html">RenderStates</a>& states);</div><div class="line"><a name="l00147"></a><span class="lineno"> 147</span> </div><div class="line"><a name="l00148"></a><span class="lineno"> 148</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00149"></a><span class="lineno"> 149</span>  <span class="keyword">enum class</span> Liveness : int {</div><div class="line"><a name="l00150"></a><span class="lineno"> 150</span>  ALIVE,</div><div class="line"><a name="l00151"></a><span class="lineno"> 151</span>  DEAD,</div><div class="line"><a name="l00152"></a><span class="lineno"> 152</span>  };</div><div class="line"><a name="l00153"></a><span class="lineno"> 153</span> </div><div class="line"><a name="l00154"></a><span class="lineno"> 154</span>  <span class="keywordtype">int</span> m_priority;</div><div class="line"><a name="l00155"></a><span class="lineno"> 155</span>  Liveness m_liveness;</div><div class="line"><a name="l00156"></a><span class="lineno"> 156</span>  };</div><div class="line"><a name="l00157"></a><span class="lineno"> 157</span> </div><div class="line"><a name="l00158"></a><span class="lineno"> 158</span> <span class="preprocessor">#ifndef DOXYGEN_SHOULD_SKIP_THIS</span></div><div class="line"><a name="l00159"></a><span class="lineno"> 159</span> }</div><div class="line"><a name="l00160"></a><span class="lineno"> 160</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00161"></a><span class="lineno"> 161</span> }</div><div class="line"><a name="l00162"></a><span class="lineno"> 162</span> </div><div class="line"><a name="l00163"></a><span class="lineno"> 163</span> <span class="preprocessor">#endif // GF_ENTITY_H</span></div><div class="ttc" id="classgf_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:73</div></div>
<div class="ttc" id="structgf_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 class="ttc" id="classgf_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:74</div></div>
<div class="ttc" id="classgf_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="classgf_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="namespacegf_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 class="ttc" id="classgf_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="classgf_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="classgf_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="classgf_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="classgf_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><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>