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

133 lines
15 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/Ray/sources/Drawables/3D/Plane.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_97e082ce3407cc227854e8f48930bd75.html">Ray</a></li><li class="navelem"><a class="el" href="dir_6a062873ed3e64cc8025242d19396498.html">sources</a></li><li class="navelem"><a class="el" href="dir_fbaef1213b89c2c136e136e5f4a6fca1.html">Drawables</a></li><li class="navelem"><a class="el" href="dir_ddc9688aedd3355ae1cfabfe7f2dfe6d.html">3D</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">Plane.hpp</div> </div>
</div><!--header-->
<div class="contents">
<a href="Plane_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">** EPITECH PROJECT, 2021</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment">** Bomberman</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment">** File description:</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment">** Pixel</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment">*/</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160; </div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="preprocessor">#ifndef PLANE_HPP_</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="preprocessor">#define PLANE_HPP_</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160; </div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="preprocessor">#include &lt;raylib.h&gt;</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="ADrawable3D_8hpp.html">Drawables/ADrawable3D.hpp</a>&quot;</span></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"> 14</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespaceRAY_1_1Drawables_1_1Drawables3D.html">RAY::Drawables::Drawables3D</a> {</div>
<div class="line"><a name="l00016"></a><span class="lineno"><a class="line" href="classRAY_1_1Drawables_1_1Drawables3D_1_1Plane.html"> 16</a></span>&#160; <span class="keyword">class </span><a class="code" href="classRAY_1_1Drawables_1_1Drawables3D_1_1Plane.html">Plane</a>: <span class="keyword">public</span> <a class="code" href="classRAY_1_1Drawables_1_1ADrawable3D.html">ADrawable3D</a></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160; {</div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160; <span class="keyword">public</span>:</div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160; <a class="code" href="classRAY_1_1Drawables_1_1Drawables3D_1_1Plane.html#a2f34239fc6495eaa0d2feb368ce13a34">Plane</a>(<span class="keyword">const</span> <a class="code" href="classRAY_1_1Vector3.html">Vector3</a> &amp;position, <span class="keyword">const</span> <a class="code" href="classRAY_1_1Vector2.html">Vector2</a> &amp;dimensions, <span class="keyword">const</span> <a class="code" href="classRAY_1_1Color.html">Color</a> &amp;color);</div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; </div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; <a class="code" href="classRAY_1_1Drawables_1_1Drawables3D_1_1Plane.html#a2f34239fc6495eaa0d2feb368ce13a34">Plane</a>(<span class="keyword">const</span> <a class="code" href="classRAY_1_1Drawables_1_1Drawables3D_1_1Plane.html">Plane</a> &amp;) = <span class="keywordflow">default</span>;</div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; </div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; <a class="code" href="classRAY_1_1Drawables_1_1Drawables3D_1_1Plane.html">Plane</a> &amp;<a class="code" href="classRAY_1_1Drawables_1_1Drawables3D_1_1Plane.html#adbe81ead968675d007696cf0010d45d3">operator=</a>(<span class="keyword">const</span> <a class="code" href="classRAY_1_1Drawables_1_1Drawables3D_1_1Plane.html">Plane</a> &amp;) = <span class="keywordflow">default</span>;</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; </div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; <a class="code" href="classRAY_1_1Drawables_1_1Drawables3D_1_1Plane.html#a05b984acd3a7ebbb2b9e0799cc6d6e90">~Plane</a>() <span class="keyword">override</span> = <span class="keywordflow">default</span>;</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; </div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; <span class="keyword">const</span> <a class="code" href="classRAY_1_1Vector2.html">Vector2</a> &amp;<a class="code" href="classRAY_1_1Drawables_1_1Drawables3D_1_1Plane.html#a983bf6487862ee416268e79467c4a2a6">getDimensions</a>(<span class="keywordtype">void</span>) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; </div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; <a class="code" href="classRAY_1_1Drawables_1_1Drawables3D_1_1Plane.html">Plane</a> &amp;<a class="code" href="classRAY_1_1Drawables_1_1Drawables3D_1_1Plane.html#afdcbf386afc035e65ae537cc1b6384bb">setDimensions</a>(<span class="keyword">const</span> <a class="code" href="classRAY_1_1Vector2.html">Vector2</a> &amp;dimensions);</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; </div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classRAY_1_1Drawables_1_1Drawables3D_1_1Plane.html#a0e4c3309cd4fb7a3953acf2e67669cfb">drawOn</a>(<a class="code" href="classRAY_1_1Window.html">RAY::Window</a> &amp;) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; </div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; <span class="keyword">private</span>:</div>
<div class="line"><a name="l00045"></a><span class="lineno"><a class="line" href="classRAY_1_1Drawables_1_1Drawables3D_1_1Plane.html#ac12bce17798065773527734e3a5bd617"> 45</a></span>&#160; <a class="code" href="classRAY_1_1Vector2.html">Vector2</a> <a class="code" href="classRAY_1_1Drawables_1_1Drawables3D_1_1Plane.html#ac12bce17798065773527734e3a5bd617">_dimensions</a>;</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; };</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;};</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; </div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160;<span class="preprocessor">#endif </span><span class="comment">/* !PIXEL_HPP_ */</span><span class="preprocessor"></span></div>
</div><!-- fragment --></div><!-- contents -->
<div class="ttc" id="aclassRAY_1_1Vector3_html"><div class="ttname"><a href="classRAY_1_1Vector3.html">RAY::Vector3</a></div><div class="ttdoc">A Three-dimensionnal Vector data type.</div><div class="ttdef"><b>Definition:</b> Vector3.hpp:15</div></div>
<div class="ttc" id="aclassRAY_1_1Drawables_1_1Drawables3D_1_1Plane_html_a983bf6487862ee416268e79467c4a2a6"><div class="ttname"><a href="classRAY_1_1Drawables_1_1Drawables3D_1_1Plane.html#a983bf6487862ee416268e79467c4a2a6">RAY::Drawables::Drawables3D::Plane::getDimensions</a></div><div class="ttdeci">const Vector2 &amp; getDimensions(void) const</div><div class="ttdef"><b>Definition:</b> Plane.cpp:19</div></div>
<div class="ttc" id="aclassRAY_1_1Window_html"><div class="ttname"><a href="classRAY_1_1Window.html">RAY::Window</a></div><div class="ttdef"><b>Definition:</b> Window.hpp:32</div></div>
<div class="ttc" id="aclassRAY_1_1Drawables_1_1Drawables3D_1_1Plane_html_afdcbf386afc035e65ae537cc1b6384bb"><div class="ttname"><a href="classRAY_1_1Drawables_1_1Drawables3D_1_1Plane.html#afdcbf386afc035e65ae537cc1b6384bb">RAY::Drawables::Drawables3D::Plane::setDimensions</a></div><div class="ttdeci">Plane &amp; setDimensions(const Vector2 &amp;dimensions)</div><div class="ttdoc">Set dimensions.</div><div class="ttdef"><b>Definition:</b> Plane.cpp:24</div></div>
<div class="ttc" id="aADrawable3D_8hpp_html"><div class="ttname"><a href="ADrawable3D_8hpp.html">ADrawable3D.hpp</a></div></div>
<div class="ttc" id="aclassRAY_1_1Drawables_1_1Drawables3D_1_1Plane_html_a05b984acd3a7ebbb2b9e0799cc6d6e90"><div class="ttname"><a href="classRAY_1_1Drawables_1_1Drawables3D_1_1Plane.html#a05b984acd3a7ebbb2b9e0799cc6d6e90">RAY::Drawables::Drawables3D::Plane::~Plane</a></div><div class="ttdeci">~Plane() override=default</div><div class="ttdoc">A default destructor.</div></div>
<div class="ttc" id="aclassRAY_1_1Vector2_html"><div class="ttname"><a href="classRAY_1_1Vector2.html">RAY::Vector2</a></div><div class="ttdoc">A Two-dimensionnal Vector data type.</div><div class="ttdef"><b>Definition:</b> Vector2.hpp:15</div></div>
<div class="ttc" id="aclassRAY_1_1Drawables_1_1Drawables3D_1_1Plane_html_adbe81ead968675d007696cf0010d45d3"><div class="ttname"><a href="classRAY_1_1Drawables_1_1Drawables3D_1_1Plane.html#adbe81ead968675d007696cf0010d45d3">RAY::Drawables::Drawables3D::Plane::operator=</a></div><div class="ttdeci">Plane &amp; operator=(const Plane &amp;)=default</div><div class="ttdoc">A plane is assignable.</div></div>
<div class="ttc" id="aclassRAY_1_1Drawables_1_1Drawables3D_1_1Plane_html_a0e4c3309cd4fb7a3953acf2e67669cfb"><div class="ttname"><a href="classRAY_1_1Drawables_1_1Drawables3D_1_1Plane.html#a0e4c3309cd4fb7a3953acf2e67669cfb">RAY::Drawables::Drawables3D::Plane::drawOn</a></div><div class="ttdeci">void drawOn(RAY::Window &amp;) override</div><div class="ttdoc">Draw point on window.</div><div class="ttdef"><b>Definition:</b> Plane.cpp:30</div></div>
<div class="ttc" id="aclassRAY_1_1Drawables_1_1Drawables3D_1_1Plane_html"><div class="ttname"><a href="classRAY_1_1Drawables_1_1Drawables3D_1_1Plane.html">RAY::Drawables::Drawables3D::Plane</a></div><div class="ttdoc">Plane in a three-dimensionnal space.</div><div class="ttdef"><b>Definition:</b> Plane.hpp:16</div></div>
<div class="ttc" id="aclassRAY_1_1Drawables_1_1ADrawable3D_html"><div class="ttname"><a href="classRAY_1_1Drawables_1_1ADrawable3D.html">RAY::Drawables::ADrawable3D</a></div><div class="ttdoc">Abstraction of any three-dimensionnal drawable.</div><div class="ttdef"><b>Definition:</b> ADrawable3D.hpp:17</div></div>
<div class="ttc" id="anamespaceRAY_1_1Drawables_1_1Drawables3D_html"><div class="ttname"><a href="namespaceRAY_1_1Drawables_1_1Drawables3D.html">RAY::Drawables::Drawables3D</a></div><div class="ttdef"><b>Definition:</b> Circle.cpp:10</div></div>
<div class="ttc" id="aclassRAY_1_1Drawables_1_1Drawables3D_1_1Plane_html_a2f34239fc6495eaa0d2feb368ce13a34"><div class="ttname"><a href="classRAY_1_1Drawables_1_1Drawables3D_1_1Plane.html#a2f34239fc6495eaa0d2feb368ce13a34">RAY::Drawables::Drawables3D::Plane::Plane</a></div><div class="ttdeci">Plane(const Vector3 &amp;position, const Vector2 &amp;dimensions, const Color &amp;color)</div><div class="ttdoc">Plane constructor.</div><div class="ttdef"><b>Definition:</b> Plane.cpp:13</div></div>
<div class="ttc" id="aclassRAY_1_1Color_html"><div class="ttname"><a href="classRAY_1_1Color.html">RAY::Color</a></div><div class="ttdoc">Object representation of color.</div><div class="ttdef"><b>Definition:</b> Color.hpp:15</div></div>
<div class="ttc" id="aclassRAY_1_1Drawables_1_1Drawables3D_1_1Plane_html_ac12bce17798065773527734e3a5bd617"><div class="ttname"><a href="classRAY_1_1Drawables_1_1Drawables3D_1_1Plane.html#ac12bce17798065773527734e3a5bd617">RAY::Drawables::Drawables3D::Plane::_dimensions</a></div><div class="ttdeci">Vector2 _dimensions</div><div class="ttdoc">plane dimensions</div><div class="ttdef"><b>Definition:</b> Plane.hpp:45</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>