diff options
Diffstat (limited to 'entity_8h_source.html')
| -rw-r--r-- | entity_8h_source.html | 182 |
1 files changed, 182 insertions, 0 deletions
diff --git a/entity_8h_source.html b/entity_8h_source.html new file mode 100644 index 00000000..d5b72548 --- /dev/null +++ b/entity_8h_source.html @@ -0,0 +1,182 @@ +<!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.6"/> +<title>yage/entity/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> +<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" /> +<link href="style.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="yage.png"/></td> + <td style="padding-left: 0.5em;"> + <div id="projectbrief">Yet Another Game Engine</div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.8.6 --> +<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="pages.html"><span>Related Pages</span></a></li> + <li><a href="namespaces.html"><span>Namespaces</span></a></li> + <li><a href="annotated.html"><span>Classes</span></a></li> + <li class="current"><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="files.html"><span>File List</span></a></li> + <li><a href="globals.html"><span>File Members</span></a></li> + </ul> + </div> +<!-- 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>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(11)"><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 id="nav-path" class="navpath"> + <ul> +<li class="navelem"><a class="el" href="dir_0a5be4b85c8e2c05f7a9f5a803f53125.html">yage</a></li><li class="navelem"><a class="el" href="dir_b47bccbdb192fb141a0ffded67f346da.html">entity</a></li> </ul> +</div> +</div><!-- top --> +<div class="header"> + <div class="headertitle"> +<div class="title">entity.h</div> </div> +</div><!--header--> +<div class="contents"> +<a href="entity_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> </div> +<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="preprocessor">#pragma once</span></div> +<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="preprocessor"></span></div> +<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="preprocessor">#include <vector></span></div> +<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="preprocessor">#include <memory></span></div> +<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> </div> +<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="keyword">namespace </span>yage</div> +<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> {</div> +<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> </div> +<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="keyword">class </span>Space;</div> +<div class="line"><a name="l00018"></a><span class="lineno"><a class="line" href="namespaceyage.html#aa8bc60c76b5240a55672ce5b8e288764"> 18</a></span> <span class="keyword">class </span><a class="code" href="classyage_1_1ComponentGroup.html">ComponentGroup</a>;</div> +<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> </div> +<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="keyword">typedef</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="namespaceyage.html#aa8bc60c76b5240a55672ce5b8e288764">Entity</a>;</div> +<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> </div> +<div class="line"><a name="l00024"></a><span class="lineno"><a class="line" href="classyage_1_1EntityManager.html"> 24</a></span> <span class="keyword">class </span><a class="code" href="classyage_1_1EntityManager.html">EntityManager</a></div> +<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> {</div> +<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="keyword">public</span>:</div> +<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  <a class="code" href="classyage_1_1EntityManager.html#a255fa9aff3e6b208eea0c38d8caf08f8">EntityManager</a>() = <span class="keywordflow">default</span>;</div> +<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> </div> +<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  <a class="code" href="classyage_1_1EntityManager.html#a255fa9aff3e6b208eea0c38d8caf08f8">EntityManager</a>(<a class="code" href="classyage_1_1Space.html">Space</a> *space);</div> +<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> </div> +<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <a class="code" href="classyage_1_1EntityManager.html#a255fa9aff3e6b208eea0c38d8caf08f8">EntityManager</a>(<a class="code" href="classyage_1_1Space.html">Space</a> *space, std::size_t n);</div> +<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> </div> +<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <a class="code" href="namespaceyage.html#aa8bc60c76b5240a55672ce5b8e288764">Entity</a> <a class="code" href="classyage_1_1EntityManager.html#a646cf1110abdc0a4398c994ead5f537d">createEntity</a>();</div> +<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> </div> +<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="keywordtype">void</span> <a class="code" href="classyage_1_1EntityManager.html#a246e10663f55a9f4817cbde23a7a36c9">deleteEntity</a>(<a class="code" href="namespaceyage.html#aa8bc60c76b5240a55672ce5b8e288764">Entity</a> entity);</div> +<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> </div> +<div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="keyword">private</span>:</div> +<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <a class="code" href="namespaceyage.html#aa8bc60c76b5240a55672ce5b8e288764">Entity</a> next_entity_ = 0;</div> +<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> </div> +<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <a class="code" href="classyage_1_1Space.html">Space</a> *space_ = <span class="keyword">nullptr</span>;</div> +<div class="line"><a name="l00064"></a><span class="lineno"> 64</span> </div> +<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  std::vector<Entity> entities_;</div> +<div class="line"><a name="l00068"></a><span class="lineno"> 68</span> </div> +<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  std::vector<std::unique_ptr<ComponentGroup>> components;</div> +<div class="line"><a name="l00073"></a><span class="lineno"> 73</span> };</div> +<div class="line"><a name="l00074"></a><span class="lineno"> 74</span> </div> +<div class="line"><a name="l00080"></a><span class="lineno"><a class="line" href="classyage_1_1BaseComponent.html"> 80</a></span> <span class="keyword">class </span><a class="code" href="classyage_1_1BaseComponent.html">BaseComponent</a> {</div> +<div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="keyword">public</span>:</div> +<div class="line"><a name="l00085"></a><span class="lineno"><a class="line" href="classyage_1_1BaseComponent.html#a55b026d7deb37888f67636ff22fc32c8"> 85</a></span>  <span class="keyword">typedef</span> <span class="keywordtype">unsigned</span> <a class="code" href="classyage_1_1BaseComponent.html#a55b026d7deb37888f67636ff22fc32c8">Group</a>;</div> +<div class="line"><a name="l00086"></a><span class="lineno"> 86</span> </div> +<div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="keyword">protected</span>:</div> +<div class="line"><a name="l00088"></a><span class="lineno"><a class="line" href="classyage_1_1BaseComponent.html#a529f6d4864bac810a9f5419bb0fccd92"> 88</a></span>  <span class="keyword">static</span> <a class="code" href="classyage_1_1BaseComponent.html#a55b026d7deb37888f67636ff22fc32c8">Group</a> <a class="code" href="classyage_1_1BaseComponent.html#a529f6d4864bac810a9f5419bb0fccd92">group_id_counter_</a>;</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="l00096"></a><span class="lineno"> 96</span> <span class="keyword">template</span> <<span class="keyword">typename</span> Derived></div> +<div class="line"><a name="l00097"></a><span class="lineno"><a class="line" href="classyage_1_1Component.html"> 97</a></span> <span class="keyword">class </span><a class="code" href="classyage_1_1Component.html">Component</a> : <span class="keyword">public</span> <a class="code" href="classyage_1_1BaseComponent.html">BaseComponent</a> {</div> +<div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <span class="keyword">private</span>:</div> +<div class="line"><a name="l00099"></a><span class="lineno"><a class="line" href="classyage_1_1Component.html#a6f579cda6059d102e9074e11a27e0282"> 99</a></span>  <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classyage_1_1EntityManager.html">EntityManager</a>;</div> +<div class="line"><a name="l00100"></a><span class="lineno"> 100</span> </div> +<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  <a class="code" href="classyage_1_1BaseComponent.html#a55b026d7deb37888f67636ff22fc32c8">BaseComponent::Group</a> group();</div> +<div class="line"><a name="l00102"></a><span class="lineno"> 102</span> };</div> +<div class="line"><a name="l00103"></a><span class="lineno"> 103</span> </div> +<div class="line"><a name="l00107"></a><span class="lineno"><a class="line" href="classyage_1_1ComponentGroup.html"> 107</a></span> <span class="keyword">class </span><a class="code" href="classyage_1_1ComponentGroup.html">ComponentGroup</a> {</div> +<div class="line"><a name="l00108"></a><span class="lineno"> 108</span> <span class="keyword">private</span>:</div> +<div class="line"><a name="l00109"></a><span class="lineno"><a class="line" href="classyage_1_1ComponentGroup.html#a6f579cda6059d102e9074e11a27e0282"> 109</a></span>  <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classyage_1_1EntityManager.html">EntityManager</a>;</div> +<div class="line"><a name="l00110"></a><span class="lineno"> 110</span> </div> +<div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  std::vector<BaseComponent *> components_;</div> +<div class="line"><a name="l00112"></a><span class="lineno"> 112</span> };</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> <span class="comment">// Template definitions</span></div> +<div class="line"><a name="l00115"></a><span class="lineno"> 115</span> </div> +<div class="line"><a name="l00116"></a><span class="lineno"> 116</span> <span class="keyword">template</span> <<span class="keyword">typename</span> Derived></div> +<div class="line"><a name="l00117"></a><span class="lineno"> 117</span> <a class="code" href="classyage_1_1BaseComponent.html#a55b026d7deb37888f67636ff22fc32c8">BaseComponent::Group</a> <a class="code" href="classyage_1_1Component.html">Component<Derived>::group</a>()</div> +<div class="line"><a name="l00118"></a><span class="lineno"> 118</span> {</div> +<div class="line"><a name="l00119"></a><span class="lineno"> 119</span>  <span class="keyword">static</span> Group group_id = group_id_counter_++;</div> +<div class="line"><a name="l00120"></a><span class="lineno"> 120</span>  <span class="keywordflow">return</span> group_id;</div> +<div class="line"><a name="l00121"></a><span class="lineno"> 121</span> }</div> +<div class="line"><a name="l00122"></a><span class="lineno"> 122</span> </div> +<div class="line"><a name="l00123"></a><span class="lineno"> 123</span> } <span class="comment">// namespace yage</span></div> +<div class="ttc" id="classyage_1_1BaseComponent_html"><div class="ttname"><a href="classyage_1_1BaseComponent.html">yage::BaseComponent</a></div><div class="ttdoc">Base component used to store components. </div><div class="ttdef"><b>Definition:</b> entity.h:80</div></div> +<div class="ttc" id="classyage_1_1EntityManager_html"><div class="ttname"><a href="classyage_1_1EntityManager.html">yage::EntityManager</a></div><div class="ttdoc">Manages entities in a space. </div><div class="ttdef"><b>Definition:</b> entity.h:24</div></div> +<div class="ttc" id="classyage_1_1BaseComponent_html_a55b026d7deb37888f67636ff22fc32c8"><div class="ttname"><a href="classyage_1_1BaseComponent.html#a55b026d7deb37888f67636ff22fc32c8">yage::BaseComponent::Group</a></div><div class="ttdeci">unsigned Group</div><div class="ttdoc">Group used to register a specific component internally with the entity manager. </div><div class="ttdef"><b>Definition:</b> entity.h:85</div></div> +<div class="ttc" id="classyage_1_1EntityManager_html_a646cf1110abdc0a4398c994ead5f537d"><div class="ttname"><a href="classyage_1_1EntityManager.html#a646cf1110abdc0a4398c994ead5f537d">yage::EntityManager::createEntity</a></div><div class="ttdeci">Entity createEntity()</div><div class="ttdoc">Creates an Entity and returns the handle to the entity, which can then be used by the user to do oper...</div><div class="ttdef"><b>Definition:</b> entity.cpp:25</div></div> +<div class="ttc" id="namespaceyage_html_aa8bc60c76b5240a55672ce5b8e288764"><div class="ttname"><a href="namespaceyage.html#aa8bc60c76b5240a55672ce5b8e288764">yage::Entity</a></div><div class="ttdeci">unsigned int Entity</div><div class="ttdef"><b>Definition:</b> entity.h:18</div></div> +<div class="ttc" id="classyage_1_1EntityManager_html_a255fa9aff3e6b208eea0c38d8caf08f8"><div class="ttname"><a href="classyage_1_1EntityManager.html#a255fa9aff3e6b208eea0c38d8caf08f8">yage::EntityManager::EntityManager</a></div><div class="ttdeci">EntityManager()=default</div><div class="ttdoc">Default instance of an EntityManager. </div></div> +<div class="ttc" id="classyage_1_1ComponentGroup_html"><div class="ttname"><a href="classyage_1_1ComponentGroup.html">yage::ComponentGroup</a></div><div class="ttdoc">Contains a list of all components that belong to a sepecific group, these are then stored in the main...</div><div class="ttdef"><b>Definition:</b> entity.h:107</div></div> +<div class="ttc" id="classyage_1_1BaseComponent_html_a529f6d4864bac810a9f5419bb0fccd92"><div class="ttname"><a href="classyage_1_1BaseComponent.html#a529f6d4864bac810a9f5419bb0fccd92">yage::BaseComponent::group_id_counter_</a></div><div class="ttdeci">static Group group_id_counter_</div><div class="ttdef"><b>Definition:</b> entity.h:88</div></div> +<div class="ttc" id="classyage_1_1EntityManager_html_a246e10663f55a9f4817cbde23a7a36c9"><div class="ttname"><a href="classyage_1_1EntityManager.html#a246e10663f55a9f4817cbde23a7a36c9">yage::EntityManager::deleteEntity</a></div><div class="ttdeci">void deleteEntity(Entity entity)</div><div class="ttdoc">Delete an entity. </div><div class="ttdef"><b>Definition:</b> entity.cpp:32</div></div> +<div class="ttc" id="classyage_1_1Component_html"><div class="ttname"><a href="classyage_1_1Component.html">yage::Component</a></div><div class="ttdoc">The main component that is used to make a component from a defined struct. </div><div class="ttdef"><b>Definition:</b> entity.h:97</div></div> +<div class="ttc" id="classyage_1_1Space_html"><div class="ttname"><a href="classyage_1_1Space.html">yage::Space</a></div><div class="ttdoc">Space that keeps track of all the entities, componenets and runs the systems on the data to update th...</div><div class="ttdef"><b>Definition:</b> space.h:34</div></div> +</div><!-- fragment --></div><!-- contents --> +<!-- start footer part --> +<hr class="footer"/><address class="footer"><small> +Generated on Sat Jun 2 2018 13:53:39 by  <a href="http://www.doxygen.org/index.html"> +<img class="footer" src="doxygen.png" alt="doxygen"/> +</a> 1.8.6 +</small></address> +</body> +</html> |