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

151 lines
20 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: sources/Component/Renderer/Drawable2DComponent.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_08d237fc27d4ecd563f71c5d52f2fecc.html">sources</a></li><li class="navelem"><a class="el" href="dir_1625c0207da71ef5bcc742f7d87fc397.html">Component</a></li><li class="navelem"><a class="el" href="dir_0bdc1f114aa34b6ab2d85546a660ebf2.html">Renderer</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">Drawable2DComponent.hpp</div> </div>
</div><!--header-->
<div class="contents">
<a href="Drawable2DComponent_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 cbihan on 24/05/2021.</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;<a class="code" href="TypeHolder_8hpp.html">Models/TypeHolder.hpp</a>&gt;</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="Component_8hpp.html">Component/Component.hpp</a>&quot;</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="ADrawable2D_8hpp.html">Drawables/ADrawable2D.hpp</a>&quot;</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="Model_8hpp.html">Model/Model.hpp</a>&quot;</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160; </div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespaceBBM.html">BBM</a></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;{</div>
<div class="line"><a name="l00014"></a><span class="lineno"><a class="line" href="classBBM_1_1Drawable2DComponent.html"> 14</a></span>&#160; <span class="keyword">class </span><a class="code" href="classBBM_1_1Drawable2DComponent.html">Drawable2DComponent</a> : <span class="keyword">public</span> <a class="code" href="classWAL_1_1Component.html">WAL::Component</a></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160; {</div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160; <span class="keyword">public</span>:</div>
<div class="line"><a name="l00018"></a><span class="lineno"><a class="line" href="classBBM_1_1Drawable2DComponent.html#a7a8f15177eb5679ea38d6c791720e08c"> 18</a></span>&#160; <span class="keywordtype">bool</span> <a class="code" href="classBBM_1_1Drawable2DComponent.html#a7a8f15177eb5679ea38d6c791720e08c">drawBefore3D</a> = <span class="keyword">false</span>;</div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160; </div>
<div class="line"><a name="l00021"></a><span class="lineno"><a class="line" href="classBBM_1_1Drawable2DComponent.html#ab237218d38376037256a8943750747e5"> 21</a></span>&#160; std::shared_ptr&lt;RAY::Drawables::ADrawable2D&gt; <a class="code" href="classBBM_1_1Drawable2DComponent.html#ab237218d38376037256a8943750747e5">drawable</a>;</div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; </div>
<div class="line"><a name="l00024"></a><span class="lineno"><a class="line" href="classBBM_1_1Drawable2DComponent.html#abc04fe96351a513d79e4bf9c2685cf73"> 24</a></span>&#160; <a class="code" href="classBBM_1_1Drawable2DComponent.html#abc04fe96351a513d79e4bf9c2685cf73">Drawable2DComponent</a>(<a class="code" href="classWAL_1_1Entity.html">WAL::Entity</a> &amp;entity, std::shared_ptr&lt;RAY::Drawables::ADrawable2D&gt; drawable2D, <span class="keywordtype">bool</span> drawBehind3D = <span class="keyword">false</span>)</div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; : <a class="code" href="namespaceWAL.html">WAL</a>::<a class="code" href="classWAL_1_1Component.html#ad27cb4b0bdc95b6245f6b5a8c56cc78a">Component</a>(entity),</div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; <a class="code" href="classBBM_1_1Drawable2DComponent.html#a7a8f15177eb5679ea38d6c791720e08c">drawBefore3D</a>(drawBehind3D),</div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; <a class="code" href="classBBM_1_1Drawable2DComponent.html#ab237218d38376037256a8943750747e5">drawable</a>(<a class="code" href="namespacestd.html">std</a>::move(drawable2D))</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; {}</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"> 31</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> T, <span class="keyword">typename</span> ...Params&gt;</div>
<div class="line"><a name="l00032"></a><span class="lineno"><a class="line" href="classBBM_1_1Drawable2DComponent.html#a11a5bc704ecad6d04c9a4bb15c21b981"> 32</a></span>&#160; <span class="keyword">explicit</span> <a class="code" href="classBBM_1_1Drawable2DComponent.html#a11a5bc704ecad6d04c9a4bb15c21b981">Drawable2DComponent</a>(<a class="code" href="classWAL_1_1Entity.html">WAL::Entity</a> &amp;entity, <a class="code" href="classWAL_1_1TypeHolder.html">WAL::TypeHolder&lt;T&gt;</a>, Params &amp;&amp;...params)</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; : <a class="code" href="namespaceWAL.html">WAL</a>::<a class="code" href="classWAL_1_1Component.html#ad27cb4b0bdc95b6245f6b5a8c56cc78a">Component</a>(entity),</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; <a class="code" href="classBBM_1_1Drawable2DComponent.html#a7a8f15177eb5679ea38d6c791720e08c">drawBefore3D</a>(false),</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; <a class="code" href="classBBM_1_1Drawable2DComponent.html#ab237218d38376037256a8943750747e5">drawable</a>(new T(<a class="code" href="namespacestd.html">std</a>::forward&lt;Params&gt;(params)...))</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; {}</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; </div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> T, <span class="keyword">typename</span> ...Params&gt;</div>
<div class="line"><a name="l00040"></a><span class="lineno"><a class="line" href="classBBM_1_1Drawable2DComponent.html#accfbd003d470b8dcc7f7aaa267670c1a"> 40</a></span>&#160; <span class="keyword">explicit</span> <a class="code" href="classBBM_1_1Drawable2DComponent.html#accfbd003d470b8dcc7f7aaa267670c1a">Drawable2DComponent</a>(<a class="code" href="classWAL_1_1Entity.html">WAL::Entity</a> &amp;entity, <a class="code" href="classWAL_1_1TypeHolder.html">WAL::TypeHolder&lt;T&gt;</a>, <span class="keywordtype">bool</span> drawBehind3D, Params &amp;&amp;...params)</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; : <a class="code" href="namespaceWAL.html">WAL</a>::<a class="code" href="classWAL_1_1Component.html#ad27cb4b0bdc95b6245f6b5a8c56cc78a">Component</a>(entity),</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; <a class="code" href="classBBM_1_1Drawable2DComponent.html#a7a8f15177eb5679ea38d6c791720e08c">drawBefore3D</a>(drawBehind3D),</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; <a class="code" href="classBBM_1_1Drawable2DComponent.html#ab237218d38376037256a8943750747e5">drawable</a>(new T(<a class="code" href="namespacestd.html">std</a>::forward&lt;Params&gt;(params)...))</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; {}</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="classBBM_1_1Drawable2DComponent.html#a0a2d90e754f54f2355cd7232c8518328"> 48</a></span>&#160; <a class="code" href="classWAL_1_1Component.html">WAL::Component</a> *<a class="code" href="classBBM_1_1Drawable2DComponent.html#a0a2d90e754f54f2355cd7232c8518328">clone</a>(<a class="code" href="classWAL_1_1Entity.html">WAL::Entity</a> &amp;entity)<span class="keyword"> const override</span></div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160;<span class="keyword"> </span>{</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; <span class="keywordflow">return</span> <span class="keyword">new</span> <a class="code" href="classBBM_1_1Drawable2DComponent.html#abc04fe96351a513d79e4bf9c2685cf73">Drawable2DComponent</a>(entity, this-&gt;drawable, this-&gt;drawBefore3D);</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; }</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; </div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; <a class="code" href="classBBM_1_1Drawable2DComponent.html#abc04fe96351a513d79e4bf9c2685cf73">Drawable2DComponent</a>(<span class="keyword">const</span> <a class="code" href="classBBM_1_1Drawable2DComponent.html">Drawable2DComponent</a> &amp;) = <span class="keywordflow">default</span>;</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; <a class="code" href="classBBM_1_1Drawable2DComponent.html#a21ef0b3322687f382107bf41a8954fd2">~Drawable2DComponent</a>() <span class="keyword">override</span> = <span class="keywordflow">default</span>;</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; <a class="code" href="classBBM_1_1Drawable2DComponent.html">Drawable2DComponent</a> &amp;<a class="code" href="classBBM_1_1Drawable2DComponent.html#ad3fc654cf030372c503d7608724b2bdc">operator=</a>(<span class="keyword">const</span> <a class="code" href="classBBM_1_1Drawable2DComponent.html">Drawable2DComponent</a> &amp;) = <span class="keyword">delete</span>;</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; };</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160;}</div>
</div><!-- fragment --></div><!-- contents -->
<div class="ttc" id="aclassBBM_1_1Drawable2DComponent_html_a11a5bc704ecad6d04c9a4bb15c21b981"><div class="ttname"><a href="classBBM_1_1Drawable2DComponent.html#a11a5bc704ecad6d04c9a4bb15c21b981">BBM::Drawable2DComponent::Drawable2DComponent</a></div><div class="ttdeci">Drawable2DComponent(WAL::Entity &amp;entity, WAL::TypeHolder&lt; T &gt;, Params &amp;&amp;...params)</div><div class="ttdoc">ctor</div><div class="ttdef"><b>Definition:</b> Drawable2DComponent.hpp:32</div></div>
<div class="ttc" id="aclassBBM_1_1Drawable2DComponent_html"><div class="ttname"><a href="classBBM_1_1Drawable2DComponent.html">BBM::Drawable2DComponent</a></div><div class="ttdef"><b>Definition:</b> Drawable2DComponent.hpp:14</div></div>
<div class="ttc" id="aclassBBM_1_1Drawable2DComponent_html_a7a8f15177eb5679ea38d6c791720e08c"><div class="ttname"><a href="classBBM_1_1Drawable2DComponent.html#a7a8f15177eb5679ea38d6c791720e08c">BBM::Drawable2DComponent::drawBefore3D</a></div><div class="ttdeci">bool drawBefore3D</div><div class="ttdoc">Tells the renderer to draw in a particular order.</div><div class="ttdef"><b>Definition:</b> Drawable2DComponent.hpp:18</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="aclassBBM_1_1Drawable2DComponent_html_ab237218d38376037256a8943750747e5"><div class="ttname"><a href="classBBM_1_1Drawable2DComponent.html#ab237218d38376037256a8943750747e5">BBM::Drawable2DComponent::drawable</a></div><div class="ttdeci">std::shared_ptr&lt; RAY::Drawables::ADrawable2D &gt; drawable</div><div class="ttdoc">The type of the component.</div><div class="ttdef"><b>Definition:</b> Drawable2DComponent.hpp:21</div></div>
<div class="ttc" id="aclassWAL_1_1Component_html"><div class="ttname"><a href="classWAL_1_1Component.html">WAL::Component</a></div><div class="ttdoc">Represent a single component of WAL.</div><div class="ttdef"><b>Definition:</b> Component.hpp:17</div></div>
<div class="ttc" id="anamespaceBBM_html"><div class="ttname"><a href="namespaceBBM.html">BBM</a></div><div class="ttdef"><b>Definition:</b> AnimationsComponent.cpp:9</div></div>
<div class="ttc" id="aclassWAL_1_1Entity_html"><div class="ttname"><a href="classWAL_1_1Entity.html">WAL::Entity</a></div><div class="ttdoc">An entity of the WAL's ECS.</div><div class="ttdef"><b>Definition:</b> Entity.hpp:20</div></div>
<div class="ttc" id="aComponent_8hpp_html"><div class="ttname"><a href="Component_8hpp.html">Component.hpp</a></div></div>
<div class="ttc" id="aclassWAL_1_1Component_html_ad27cb4b0bdc95b6245f6b5a8c56cc78a"><div class="ttname"><a href="classWAL_1_1Component.html#ad27cb4b0bdc95b6245f6b5a8c56cc78a">WAL::Component::Component</a></div><div class="ttdeci">Component(Entity &amp;entity)</div><div class="ttdoc">A component can't be instantiated, it should be derived.</div><div class="ttdef"><b>Definition:</b> Component.cpp:9</div></div>
<div class="ttc" id="aclassWAL_1_1TypeHolder_html"><div class="ttname"><a href="classWAL_1_1TypeHolder.html">WAL::TypeHolder</a></div><div class="ttdoc">A class only used to specify template arguments.</div><div class="ttdef"><b>Definition:</b> TypeHolder.hpp:12</div></div>
<div class="ttc" id="aModel_8hpp_html"><div class="ttname"><a href="Model_8hpp.html">Model.hpp</a></div></div>
<div class="ttc" id="aclassBBM_1_1Drawable2DComponent_html_a21ef0b3322687f382107bf41a8954fd2"><div class="ttname"><a href="classBBM_1_1Drawable2DComponent.html#a21ef0b3322687f382107bf41a8954fd2">BBM::Drawable2DComponent::~Drawable2DComponent</a></div><div class="ttdeci">~Drawable2DComponent() override=default</div><div class="ttdoc">Default dtor.</div></div>
<div class="ttc" id="aclassBBM_1_1Drawable2DComponent_html_abc04fe96351a513d79e4bf9c2685cf73"><div class="ttname"><a href="classBBM_1_1Drawable2DComponent.html#abc04fe96351a513d79e4bf9c2685cf73">BBM::Drawable2DComponent::Drawable2DComponent</a></div><div class="ttdeci">Drawable2DComponent(WAL::Entity &amp;entity, std::shared_ptr&lt; RAY::Drawables::ADrawable2D &gt; drawable2D, bool drawBehind3D=false)</div><div class="ttdoc">ctor</div><div class="ttdef"><b>Definition:</b> Drawable2DComponent.hpp:24</div></div>
<div class="ttc" id="aclassBBM_1_1Drawable2DComponent_html_ad3fc654cf030372c503d7608724b2bdc"><div class="ttname"><a href="classBBM_1_1Drawable2DComponent.html#ad3fc654cf030372c503d7608724b2bdc">BBM::Drawable2DComponent::operator=</a></div><div class="ttdeci">Drawable2DComponent &amp; operator=(const Drawable2DComponent &amp;)=delete</div><div class="ttdoc">Default assignment operator.</div></div>
<div class="ttc" id="anamespacestd_html"><div class="ttname"><a href="namespacestd.html">std</a></div><div class="ttdef"><b>Definition:</b> View.hpp:210</div></div>
<div class="ttc" id="aclassBBM_1_1Drawable2DComponent_html_a0a2d90e754f54f2355cd7232c8518328"><div class="ttname"><a href="classBBM_1_1Drawable2DComponent.html#a0a2d90e754f54f2355cd7232c8518328">BBM::Drawable2DComponent::clone</a></div><div class="ttdeci">WAL::Component * clone(WAL::Entity &amp;entity) const override</div><div class="ttdoc">Clone a component for another or the same entity.</div><div class="ttdef"><b>Definition:</b> Drawable2DComponent.hpp:48</div></div>
<div class="ttc" id="aTypeHolder_8hpp_html"><div class="ttname"><a href="TypeHolder_8hpp.html">TypeHolder.hpp</a></div></div>
<div class="ttc" id="aclassBBM_1_1Drawable2DComponent_html_accfbd003d470b8dcc7f7aaa267670c1a"><div class="ttname"><a href="classBBM_1_1Drawable2DComponent.html#accfbd003d470b8dcc7f7aaa267670c1a">BBM::Drawable2DComponent::Drawable2DComponent</a></div><div class="ttdeci">Drawable2DComponent(WAL::Entity &amp;entity, WAL::TypeHolder&lt; T &gt;, bool drawBehind3D, Params &amp;&amp;...params)</div><div class="ttdoc">ctor</div><div class="ttdef"><b>Definition:</b> Drawable2DComponent.hpp:40</div></div>
<div class="ttc" id="aADrawable2D_8hpp_html"><div class="ttname"><a href="ADrawable2D_8hpp.html">ADrawable2D.hpp</a></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>