forked from mmistakes/minimal-mistakes
-
Notifications
You must be signed in to change notification settings - Fork 0
/
_component_8hpp_source.html
137 lines (135 loc) · 11.9 KB
/
_component_8hpp_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
<!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" lang="en-US">
<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.10.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>CS4850 Final Project: Component.hpp 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/javascript" src="clipboard.js"></script>
<script type="text/javascript" src="cookie.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></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 id="projectrow">
<td id="projectalign">
<div id="projectname">CS4850 Final Project
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.10.0 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<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('',true,false,'search.php','Search');
$(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @license-end */
</script>
</div><!-- top -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div class="header">
<div class="headertitle"><div class="title">Component.hpp</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="preprocessor">#pragma once</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span> </div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="preprocessor">#include <SDL2/SDL.h></span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="preprocessor">#include <memory></span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span> </div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="preprocessor">#include "ComponentType.hpp"</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span> </div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="comment">// Forward declaration</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="keyword">struct </span><a class="code hl_struct" href="struct_game_entity.html">GameEntity</a>;</div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span> </div>
<div class="foldopen" id="foldopen00015" data-start="{" data-end="};">
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"><a class="line" href="struct_component.html"> 15</a></span><span class="keyword">struct </span><a class="code hl_struct" href="struct_component.html">Component</a> {</div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span> </div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span> <a class="code hl_struct" href="struct_component.html">Component</a>() {}</div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> </div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> <span class="keyword">virtual</span> <a class="code hl_struct" href="struct_component.html">~Component</a>() {}</div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> </div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"><a class="line" href="struct_component.html#a85d6bd954d08b01cfad8e8357f98d011"> 26</a></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code hl_function" href="struct_component.html#a85d6bd954d08b01cfad8e8357f98d011">Input</a>(<span class="keywordtype">float</span> deltaTime) {}</div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> </div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"><a class="line" href="struct_component.html#a3c50208a8c7ea021b0ae2b9dfbaec65a"> 33</a></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code hl_function" href="struct_component.html#a3c50208a8c7ea021b0ae2b9dfbaec65a">Update</a>(<span class="keywordtype">float</span> deltaTime) {}</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> </div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"><a class="line" href="struct_component.html#a223de42285cca9e02809120c1a44c4ac"> 40</a></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code hl_function" href="struct_component.html#a223de42285cca9e02809120c1a44c4ac">Render</a>(SDL_Renderer* renderer) {}</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> </div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"><a class="line" href="struct_component.html#a2e87d60cd7150786e51bfcda7129ed90"> 47</a></span> <span class="keyword">virtual</span> ComponentType <a class="code hl_function" href="struct_component.html#a2e87d60cd7150786e51bfcda7129ed90">GetType</a>() = 0;</div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> </div>
<div class="foldopen" id="foldopen00054" data-start="{" data-end="}">
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"><a class="line" href="struct_component.html#abd8232c424fe5808f4f3d1cc020a960f"> 54</a></span> <span class="keywordtype">void</span> <a class="code hl_function" href="struct_component.html#abd8232c424fe5808f4f3d1cc020a960f">SetGameEntity</a>(std::shared_ptr<GameEntity> gameEntity) {</div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> mGameEntity = gameEntity;</div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> }</div>
</div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span> </div>
<div class="foldopen" id="foldopen00063" data-start="{" data-end="}">
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"><a class="line" href="struct_component.html#ad1000f79fe140ee4cc90d0b23cd6c035"> 63</a></span> std::shared_ptr<GameEntity> <a class="code hl_function" href="struct_component.html#ad1000f79fe140ee4cc90d0b23cd6c035">GetGameEntity</a>() {</div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span> <span class="keywordflow">return</span> mGameEntity;</div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span> }</div>
</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> <span class="keyword">protected</span>:</div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span> std::shared_ptr<GameEntity> mGameEntity;</div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span>};</div>
</div>
<div class="ttc" id="astruct_component_html"><div class="ttname"><a href="struct_component.html">Component</a></div><div class="ttdoc">Base class for all components.</div><div class="ttdef"><b>Definition</b> Component.hpp:15</div></div>
<div class="ttc" id="astruct_component_html_a223de42285cca9e02809120c1a44c4ac"><div class="ttname"><a href="struct_component.html#a223de42285cca9e02809120c1a44c4ac">Component::Render</a></div><div class="ttdeci">virtual void Render(SDL_Renderer *renderer)</div><div class="ttdoc">Render the game.</div><div class="ttdef"><b>Definition</b> Component.hpp:40</div></div>
<div class="ttc" id="astruct_component_html_a2e87d60cd7150786e51bfcda7129ed90"><div class="ttname"><a href="struct_component.html#a2e87d60cd7150786e51bfcda7129ed90">Component::GetType</a></div><div class="ttdeci">virtual ComponentType GetType()=0</div><div class="ttdoc">Get the type of the component.</div></div>
<div class="ttc" id="astruct_component_html_a3c50208a8c7ea021b0ae2b9dfbaec65a"><div class="ttname"><a href="struct_component.html#a3c50208a8c7ea021b0ae2b9dfbaec65a">Component::Update</a></div><div class="ttdeci">virtual void Update(float deltaTime)</div><div class="ttdoc">Update the game state.</div><div class="ttdef"><b>Definition</b> Component.hpp:33</div></div>
<div class="ttc" id="astruct_component_html_a85d6bd954d08b01cfad8e8357f98d011"><div class="ttname"><a href="struct_component.html#a85d6bd954d08b01cfad8e8357f98d011">Component::Input</a></div><div class="ttdeci">virtual void Input(float deltaTime)</div><div class="ttdoc">Handle input.</div><div class="ttdef"><b>Definition</b> Component.hpp:26</div></div>
<div class="ttc" id="astruct_component_html_abd8232c424fe5808f4f3d1cc020a960f"><div class="ttname"><a href="struct_component.html#abd8232c424fe5808f4f3d1cc020a960f">Component::SetGameEntity</a></div><div class="ttdeci">void SetGameEntity(std::shared_ptr< GameEntity > gameEntity)</div><div class="ttdoc">Set the game entity that the component is attached to.</div><div class="ttdef"><b>Definition</b> Component.hpp:54</div></div>
<div class="ttc" id="astruct_component_html_ad1000f79fe140ee4cc90d0b23cd6c035"><div class="ttname"><a href="struct_component.html#ad1000f79fe140ee4cc90d0b23cd6c035">Component::GetGameEntity</a></div><div class="ttdeci">std::shared_ptr< GameEntity > GetGameEntity()</div><div class="ttdoc">Get the game entity that the component is attached to.</div><div class="ttdef"><b>Definition</b> Component.hpp:63</div></div>
<div class="ttc" id="astruct_game_entity_html"><div class="ttname"><a href="struct_game_entity.html">GameEntity</a></div><div class="ttdoc">GameEntity class that represents an entity in the game.</div><div class="ttdef"><b>Definition</b> GameEntity.hpp:19</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.10.0
</small></address>
</body>
</html>