Files
Bomberman/System_8hpp_source.html
2021-06-26 11:31:13 +00:00

162 lines
21 KiB
HTML

<!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=9"/>
<meta name="generator" content="Doxygen 1.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Bomberman: lib/wal/sources/System/System.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>
<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 style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Bomberman
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @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:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- 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">
<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_97aefd0d527b934f1d99a682da8fe6a9.html">lib</a></li><li class="navelem"><a class="el" href="dir_0b4831311044d013096ae27e916683ee.html">wal</a></li><li class="navelem"><a class="el" href="dir_d2f550de4c275647d2c0a50b557bd3a7.html">sources</a></li><li class="navelem"><a class="el" href="dir_0e8fdb163997de6349c8666347cb10a5.html">System</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">System.hpp</div> </div>
</div><!--header-->
<div class="contents">
<a href="System_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment">// Created by Zoe Roux on 2021-05-14.</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160; </div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="preprocessor">#pragma once</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160; </div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="preprocessor">#include &lt;chrono&gt;</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="preprocessor">#include &lt;vector&gt;</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="preprocessor">#include &lt;typeinfo&gt;</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="preprocessor">#include &lt;typeindex&gt;</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="Entity_8hpp.html">Entity/Entity.hpp</a>&quot;</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="Wal_8hpp.html">Wal.hpp</a>&quot;</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="View_8hpp.html">View/View.hpp</a>&quot;</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="ISystem_8hpp.html">ISystem.hpp</a>&quot;</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="preprocessor">#include &lt;iostream&gt;</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160; </div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespaceWAL.html">WAL</a></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;{</div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> ...Dependencies&gt;</div>
<div class="line"><a name="l00022"></a><span class="lineno"><a class="line" href="classWAL_1_1System.html"> 22</a></span>&#160; <span class="keyword">class </span><a class="code" href="classWAL_1_1System.html">System</a> : <span class="keyword">public</span> <a class="code" href="classWAL_1_1ISystem.html">ISystem</a></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160; {</div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; <span class="keyword">public</span>:</div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; <a class="code" href="classWAL_1_1System.html#a0d85848f1b0c0561d6f120b04d6b2149">~System</a>() <span class="keyword">override</span> = <span class="keywordflow">default</span>;</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; <a class="code" href="classWAL_1_1System.html#a6df60c35efd50fe389245a92c8b8a682">System</a>(<a class="code" href="classWAL_1_1System.html">System</a> &amp;&amp;) noexcept = <span class="keywordflow">default</span>;</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; </div>
<div class="line"><a name="l00031"></a><span class="lineno"><a class="line" href="classWAL_1_1System.html#ad9a9809572eaad4e575753797d5ebc83"> 31</a></span>&#160; <a class="code" href="classWAL_1_1View.html">View</a>&lt;Dependencies...&gt; &amp;<a class="code" href="classWAL_1_1System.html#ad9a9809572eaad4e575753797d5ebc83">getView</a>()<span class="keyword"> override</span></div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;<span class="keyword"> </span>{</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; <span class="keywordflow">return</span> this-&gt;<a class="code" href="classWAL_1_1System.html#a00b29f6adf3ae16541f68f36706bdac9">_wal</a>.<a class="code" href="classWAL_1_1Wal.html#afcee9d67a8530cc86d40b2de999f91bf">getScene</a>()-&gt;template view&lt;Dependencies...&gt;();</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; }</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; </div>
<div class="line"><a name="l00039"></a><span class="lineno"><a class="line" href="classWAL_1_1System.html#ac06ea339c14af184afb7fe59aa0c77dd"> 39</a></span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classWAL_1_1System.html#ac06ea339c14af184afb7fe59aa0c77dd">onUpdate</a>(<a class="code" href="classWAL_1_1ViewEntity.html">ViewEntity&lt;Dependencies...&gt;</a> &amp;entity, std::chrono::nanoseconds dtime) {}</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; </div>
<div class="line"><a name="l00044"></a><span class="lineno"><a class="line" href="classWAL_1_1System.html#aa0609c8ecdbde2100827dbf9e386b0cf"> 44</a></span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classWAL_1_1System.html#aa0609c8ecdbde2100827dbf9e386b0cf">onFixedUpdate</a>(<a class="code" href="classWAL_1_1ViewEntity.html">ViewEntity&lt;Dependencies...&gt;</a> &amp;entity) {}</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; </div>
<div class="line"><a name="l00048"></a><span class="lineno"><a class="line" href="classWAL_1_1System.html#a83c3c86e8ad1e35e94db423d512e11e5"> 48</a></span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classWAL_1_1System.html#a83c3c86e8ad1e35e94db423d512e11e5">onSelfUpdate</a>(std::chrono::nanoseconds dtime) {}</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; </div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; </div>
<div class="line"><a name="l00053"></a><span class="lineno"><a class="line" href="classWAL_1_1System.html#a160c40e1e9ae6b5f7a509a061f9596ff"> 53</a></span>&#160; <span class="keywordtype">void</span> <a class="code" href="classWAL_1_1System.html#a160c40e1e9ae6b5f7a509a061f9596ff">update</a>(std::chrono::nanoseconds dtime) <span class="keyword">final</span></div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; {</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; <span class="keywordflow">for</span> (<span class="keyword">auto</span> &amp;entity : this-&gt;<a class="code" href="classWAL_1_1System.html#ad9a9809572eaad4e575753797d5ebc83">getView</a>())</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; this-&gt;<a class="code" href="classWAL_1_1System.html#ac06ea339c14af184afb7fe59aa0c77dd">onUpdate</a>(entity, dtime);</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; this-&gt;<a class="code" href="classWAL_1_1System.html#a83c3c86e8ad1e35e94db423d512e11e5">onSelfUpdate</a>(dtime);</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; }</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; </div>
<div class="line"><a name="l00062"></a><span class="lineno"><a class="line" href="classWAL_1_1System.html#af23891a01001a6fb56eb9acecc0ff9b0"> 62</a></span>&#160; <span class="keywordtype">void</span> <a class="code" href="classWAL_1_1System.html#af23891a01001a6fb56eb9acecc0ff9b0">fixedUpdate</a>() final</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; {</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; <span class="keywordflow">for</span> (<span class="keyword">auto</span> &amp;entity : this-&gt;<a class="code" href="classWAL_1_1System.html#ad9a9809572eaad4e575753797d5ebc83">getView</a>())</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; this-&gt;<a class="code" href="classWAL_1_1System.html#aa0609c8ecdbde2100827dbf9e386b0cf">onFixedUpdate</a>(entity);</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; }</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; <span class="keyword">protected</span>:</div>
<div class="line"><a name="l00069"></a><span class="lineno"><a class="line" href="classWAL_1_1System.html#a00b29f6adf3ae16541f68f36706bdac9"> 69</a></span>&#160; <a class="code" href="classWAL_1_1Wal.html">Wal</a> &amp;<a class="code" href="classWAL_1_1System.html#a00b29f6adf3ae16541f68f36706bdac9">_wal</a>;</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; </div>
<div class="line"><a name="l00072"></a><span class="lineno"><a class="line" href="classWAL_1_1System.html#a726f3ce440c29bf07bd82d9391baf64f"> 72</a></span>&#160; <span class="keyword">explicit</span> <a class="code" href="classWAL_1_1System.html#a726f3ce440c29bf07bd82d9391baf64f">System</a>(<a class="code" href="classWAL_1_1Wal.html">Wal</a> &amp;wal)</div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; : <a class="code" href="classWAL_1_1System.html#a00b29f6adf3ae16541f68f36706bdac9">_wal</a>(wal)</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; {}</div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; <a class="code" href="classWAL_1_1System.html#a6df60c35efd50fe389245a92c8b8a682">System</a>(<span class="keyword">const</span> <a class="code" href="classWAL_1_1System.html">System</a> &amp;) = <span class="keywordflow">default</span>;</div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; <a class="code" href="classWAL_1_1System.html">System</a> &amp;<a class="code" href="classWAL_1_1System.html#a9a67e285bd1597de8dcab8889df4fa13">operator=</a>(<span class="keyword">const</span> <a class="code" href="classWAL_1_1System.html">System</a> &amp;) = <span class="keywordflow">default</span>;</div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; };</div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160;} <span class="comment">// namespace WAL</span></div>
</div><!-- fragment --></div><!-- contents -->
<div class="ttc" id="aclassWAL_1_1ViewEntity_html"><div class="ttname"><a href="classWAL_1_1ViewEntity.html">WAL::ViewEntity</a></div><div class="ttdef"><b>Definition:</b> View.hpp:19</div></div>
<div class="ttc" id="anamespaceWAL_html"><div class="ttname"><a href="namespaceWAL.html">WAL</a></div><div class="ttdef"><b>Definition:</b> Component.cpp:7</div></div>
<div class="ttc" id="aclassWAL_1_1Wal_html_afcee9d67a8530cc86d40b2de999f91bf"><div class="ttname"><a href="classWAL_1_1Wal.html#afcee9d67a8530cc86d40b2de999f91bf">WAL::Wal::getScene</a></div><div class="ttdeci">std::shared_ptr&lt; Scene &gt; getScene() const</div><div class="ttdoc">Retrieve the current scene.</div><div class="ttdef"><b>Definition:</b> Wal.hpp:94</div></div>
<div class="ttc" id="aView_8hpp_html"><div class="ttname"><a href="View_8hpp.html">View.hpp</a></div></div>
<div class="ttc" id="aclassWAL_1_1System_html_a83c3c86e8ad1e35e94db423d512e11e5"><div class="ttname"><a href="classWAL_1_1System.html#a83c3c86e8ad1e35e94db423d512e11e5">WAL::System::onSelfUpdate</a></div><div class="ttdeci">virtual void onSelfUpdate(std::chrono::nanoseconds dtime)</div><div class="ttdoc">A method called after all entities that this system manage has been updated.</div><div class="ttdef"><b>Definition:</b> System.hpp:48</div></div>
<div class="ttc" id="aclassWAL_1_1System_html_a726f3ce440c29bf07bd82d9391baf64f"><div class="ttname"><a href="classWAL_1_1System.html#a726f3ce440c29bf07bd82d9391baf64f">WAL::System::System</a></div><div class="ttdeci">System(Wal &amp;wal)</div><div class="ttdoc">A system can't be instantiated, it should be derived.</div><div class="ttdef"><b>Definition:</b> System.hpp:72</div></div>
<div class="ttc" id="aclassWAL_1_1System_html_a6df60c35efd50fe389245a92c8b8a682"><div class="ttname"><a href="classWAL_1_1System.html#a6df60c35efd50fe389245a92c8b8a682">WAL::System::System</a></div><div class="ttdeci">System(System &amp;&amp;) noexcept=default</div><div class="ttdoc">A system can be moved.</div></div>
<div class="ttc" id="aclassWAL_1_1System_html_ad9a9809572eaad4e575753797d5ebc83"><div class="ttname"><a href="classWAL_1_1System.html#ad9a9809572eaad4e575753797d5ebc83">WAL::System::getView</a></div><div class="ttdeci">View&lt; Dependencies... &gt; &amp; getView() override</div><div class="ttdoc">Get a view of all entities containing every dependencies of this system.</div><div class="ttdef"><b>Definition:</b> System.hpp:31</div></div>
<div class="ttc" id="aclassWAL_1_1ISystem_html"><div class="ttname"><a href="classWAL_1_1ISystem.html">WAL::ISystem</a></div><div class="ttdoc">A base class that represent a system.</div><div class="ttdef"><b>Definition:</b> ISystem.hpp:15</div></div>
<div class="ttc" id="aclassWAL_1_1Wal_html"><div class="ttname"><a href="classWAL_1_1Wal.html">WAL::Wal</a></div><div class="ttdoc">The main WAL class, it is used to setup and run the ECS.</div><div class="ttdef"><b>Definition:</b> Wal.hpp:27</div></div>
<div class="ttc" id="aEntity_8hpp_html"><div class="ttname"><a href="Entity_8hpp.html">Entity.hpp</a></div></div>
<div class="ttc" id="aclassWAL_1_1System_html_a00b29f6adf3ae16541f68f36706bdac9"><div class="ttname"><a href="classWAL_1_1System.html#a00b29f6adf3ae16541f68f36706bdac9">WAL::System::_wal</a></div><div class="ttdeci">Wal &amp; _wal</div><div class="ttdoc">A reference to the ECS.</div><div class="ttdef"><b>Definition:</b> System.hpp:69</div></div>
<div class="ttc" id="aclassWAL_1_1System_html_aa0609c8ecdbde2100827dbf9e386b0cf"><div class="ttname"><a href="classWAL_1_1System.html#aa0609c8ecdbde2100827dbf9e386b0cf">WAL::System::onFixedUpdate</a></div><div class="ttdeci">virtual void onFixedUpdate(ViewEntity&lt; Dependencies... &gt; &amp;entity)</div><div class="ttdoc">An alternative of onUpdate that is called every 8ms (120 times per seconds). If the system slow down,...</div><div class="ttdef"><b>Definition:</b> System.hpp:44</div></div>
<div class="ttc" id="aclassWAL_1_1System_html_a0d85848f1b0c0561d6f120b04d6b2149"><div class="ttname"><a href="classWAL_1_1System.html#a0d85848f1b0c0561d6f120b04d6b2149">WAL::System::~System</a></div><div class="ttdeci">~System() override=default</div><div class="ttdoc">A virtual, default, destructor.</div></div>
<div class="ttc" id="aclassWAL_1_1System_html_af23891a01001a6fb56eb9acecc0ff9b0"><div class="ttname"><a href="classWAL_1_1System.html#af23891a01001a6fb56eb9acecc0ff9b0">WAL::System::fixedUpdate</a></div><div class="ttdeci">void fixedUpdate() final</div><div class="ttdoc">An alternative of update that is called every 8ms (120 times per seconds). If the system slow down,...</div><div class="ttdef"><b>Definition:</b> System.hpp:62</div></div>
<div class="ttc" id="aclassWAL_1_1System_html_a160c40e1e9ae6b5f7a509a061f9596ff"><div class="ttname"><a href="classWAL_1_1System.html#a160c40e1e9ae6b5f7a509a061f9596ff">WAL::System::update</a></div><div class="ttdeci">void update(std::chrono::nanoseconds dtime) final</div><div class="ttdoc">Update the whole system (every entities that this system is responsible can be updated.</div><div class="ttdef"><b>Definition:</b> System.hpp:53</div></div>
<div class="ttc" id="aclassWAL_1_1View_html"><div class="ttname"><a href="classWAL_1_1View.html">WAL::View</a></div><div class="ttdoc">A view allowing one to easily access entities containing a set list of component. A view is always up...</div><div class="ttdef"><b>Definition:</b> View.hpp:133</div></div>
<div class="ttc" id="aISystem_8hpp_html"><div class="ttname"><a href="ISystem_8hpp.html">ISystem.hpp</a></div></div>
<div class="ttc" id="aclassWAL_1_1System_html"><div class="ttname"><a href="classWAL_1_1System.html">WAL::System</a></div><div class="ttdoc">A base system of WAL.</div><div class="ttdef"><b>Definition:</b> System.hpp:22</div></div>
<div class="ttc" id="aWal_8hpp_html"><div class="ttname"><a href="Wal_8hpp.html">Wal.hpp</a></div></div>
<div class="ttc" id="aclassWAL_1_1System_html_ac06ea339c14af184afb7fe59aa0c77dd"><div class="ttname"><a href="classWAL_1_1System.html#ac06ea339c14af184afb7fe59aa0c77dd">WAL::System::onUpdate</a></div><div class="ttdeci">virtual void onUpdate(ViewEntity&lt; Dependencies... &gt; &amp;entity, std::chrono::nanoseconds dtime)</div><div class="ttdoc">Update the corresponding component of the given entity.</div><div class="ttdef"><b>Definition:</b> System.hpp:39</div></div>
<div class="ttc" id="aclassWAL_1_1System_html_a9a67e285bd1597de8dcab8889df4fa13"><div class="ttname"><a href="classWAL_1_1System.html#a9a67e285bd1597de8dcab8889df4fa13">WAL::System::operator=</a></div><div class="ttdeci">System &amp; operator=(const System &amp;)=default</div><div class="ttdoc">A system can't be instantiated, it should be derived.</div></div>
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>