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

151 lines
19 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/Model/ModelAnimations.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_79ecb0ce0e948a3a1fecb8bbc85b6cc1.html">Model</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">ModelAnimations.hpp</div> </div>
</div><!--header-->
<div class="contents">
<a href="ModelAnimations_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">** ModelAnimations</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 MODELANIMATIONS_HPP_</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="preprocessor">#define MODELANIMATIONS_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 &quot;<a class="code" href="ModelAnimation_8hpp.html">Model/ModelAnimation.hpp</a>&quot;</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="preprocessor">#include &lt;vector&gt;</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="preprocessor">#include &lt;string&gt;</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="Cache_8hpp.html">Utils/Cache.hpp</a>&quot;</span></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">namespace </span><a class="code" href="namespaceRAY.html">RAY</a> {</div>
<div class="line"><a name="l00018"></a><span class="lineno"><a class="line" href="classRAY_1_1ModelAnimations.html"> 18</a></span>&#160; <span class="keyword">class </span><a class="code" href="classRAY_1_1ModelAnimations.html">ModelAnimations</a> {</div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160; <span class="keyword">public</span>:</div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; <span class="keyword">explicit</span> <a class="code" href="classRAY_1_1ModelAnimations.html#adf9bb72a9f726d0a892a1ab0cec50ae5">ModelAnimations</a>(<span class="keyword">const</span> std::string &amp;filePath);</div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160; </div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; <a class="code" href="classRAY_1_1ModelAnimations.html#adf9bb72a9f726d0a892a1ab0cec50ae5">ModelAnimations</a>(<span class="keyword">const</span> <a class="code" href="classRAY_1_1ModelAnimations.html">ModelAnimations</a> &amp;) = <span class="keywordflow">default</span>;</div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; </div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; <a class="code" href="classRAY_1_1ModelAnimations.html#adc6ac6bfd0465e5f7269e753b27d4588">~ModelAnimations</a>() = <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"> 31</span>&#160; <a class="code" href="classRAY_1_1ModelAnimations.html">ModelAnimations</a> &amp;<a class="code" href="classRAY_1_1ModelAnimations.html#a52d83fe6a9136f9d9b8d83a0d5173445">operator=</a>(<span class="keyword">const</span> <a class="code" href="classRAY_1_1ModelAnimations.html">ModelAnimations</a> &amp;) = <span class="keywordflow">default</span>;</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; </div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; <a class="code" href="classRAY_1_1ModelAnimation.html">ModelAnimation</a> &amp;<a class="code" href="classRAY_1_1ModelAnimations.html#a8ba8448b39ae9c6e8198ccd73a0755d4">operator[]</a>(<span class="keywordtype">int</span> index);</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; </div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; <span class="keyword">const</span> <a class="code" href="classRAY_1_1ModelAnimation.html">ModelAnimation</a> &amp;<a class="code" href="classRAY_1_1ModelAnimations.html#a8ba8448b39ae9c6e8198ccd73a0755d4">operator[]</a>(<span class="keywordtype">int</span> index) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; </div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; <span class="keyword">const</span> <a class="code" href="classRAY_1_1ModelAnimation.html">ModelAnimation</a> &amp;<a class="code" href="classRAY_1_1ModelAnimations.html#a9c7cab28c414011893beb07c82f9cf1e">at</a>(<span class="keywordtype">int</span> index) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; </div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; <a class="code" href="classRAY_1_1ModelAnimation.html">ModelAnimation</a> &amp;<a class="code" href="classRAY_1_1ModelAnimations.html#a9c7cab28c414011893beb07c82f9cf1e">at</a>(<span class="keywordtype">int</span> index);</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; </div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; <span class="keywordtype">size_t</span> <a class="code" href="classRAY_1_1ModelAnimations.html#a13a2590157632886cf086346b3909b97">getAnimationsCount</a>() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; </div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; std::string <a class="code" href="classRAY_1_1ModelAnimations.html#a2674d2846eb7c088d84b911b38427788">getFilePath</a>() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; </div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; <span class="keyword">private</span>:</div>
<div class="line"><a name="l00053"></a><span class="lineno"><a class="line" href="classRAY_1_1ModelAnimations.html#a5f5bbd9e5eb2b2295c12fefbecdecf22"> 53</a></span>&#160; std::shared_ptr&lt;::ModelAnimation&gt; <a class="code" href="classRAY_1_1ModelAnimations.html#a5f5bbd9e5eb2b2295c12fefbecdecf22">_animationsPtr</a>;</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; </div>
<div class="line"><a name="l00056"></a><span class="lineno"><a class="line" href="classRAY_1_1ModelAnimations.html#a32df7913b2435c0fb15aa0d7b38bc394"> 56</a></span>&#160; std::vector&lt;ModelAnimation&gt; <a class="code" href="classRAY_1_1ModelAnimations.html#a32df7913b2435c0fb15aa0d7b38bc394">_animations</a>;</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; </div>
<div class="line"><a name="l00059"></a><span class="lineno"><a class="line" href="classRAY_1_1ModelAnimations.html#af42a70825f0c4382e9c16fcfd4550255"> 59</a></span>&#160; <span class="keywordtype">int</span> <a class="code" href="classRAY_1_1ModelAnimations.html#af42a70825f0c4382e9c16fcfd4550255">_animationCount</a>;</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; </div>
<div class="line"><a name="l00062"></a><span class="lineno"><a class="line" href="classRAY_1_1ModelAnimations.html#a83298babbbe21473b44762919c5dcd0a"> 62</a></span>&#160; std::string <a class="code" href="classRAY_1_1ModelAnimations.html#a83298babbbe21473b44762919c5dcd0a">_filePath</a>;</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"><a class="line" href="classRAY_1_1ModelAnimations.html#a11f187f98a736033cc670254020b331e"> 64</a></span>&#160; <span class="keyword">static</span> <a class="code" href="classRAY_1_1Cache_3_1_1ModelAnimation_01_4.html">Cache&lt;::ModelAnimation&gt;</a> <a class="code" href="classRAY_1_1ModelAnimations.html#a11f187f98a736033cc670254020b331e">_animationsCache</a>;</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; };</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; </div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160;<span class="preprocessor">#endif </span><span class="comment">/* !MODELANIMATIONS_HPP_ */</span><span class="preprocessor"></span></div>
</div><!-- fragment --></div><!-- contents -->
<div class="ttc" id="aclassRAY_1_1ModelAnimations_html_a52d83fe6a9136f9d9b8d83a0d5173445"><div class="ttname"><a href="classRAY_1_1ModelAnimations.html#a52d83fe6a9136f9d9b8d83a0d5173445">RAY::ModelAnimations::operator=</a></div><div class="ttdeci">ModelAnimations &amp; operator=(const ModelAnimations &amp;)=default</div><div class="ttdoc">Default assignment operator.</div></div>
<div class="ttc" id="aclassRAY_1_1ModelAnimations_html_a83298babbbe21473b44762919c5dcd0a"><div class="ttname"><a href="classRAY_1_1ModelAnimations.html#a83298babbbe21473b44762919c5dcd0a">RAY::ModelAnimations::_filePath</a></div><div class="ttdeci">std::string _filePath</div><div class="ttdoc">The file where the animations were loaded (used to create a copy of this class)</div><div class="ttdef"><b>Definition:</b> ModelAnimations.hpp:62</div></div>
<div class="ttc" id="aCache_8hpp_html"><div class="ttname"><a href="Cache_8hpp.html">Cache.hpp</a></div></div>
<div class="ttc" id="aclassRAY_1_1ModelAnimations_html_a5f5bbd9e5eb2b2295c12fefbecdecf22"><div class="ttname"><a href="classRAY_1_1ModelAnimations.html#a5f5bbd9e5eb2b2295c12fefbecdecf22">RAY::ModelAnimations::_animationsPtr</a></div><div class="ttdeci">std::shared_ptr&lt;::ModelAnimation &gt; _animationsPtr</div><div class="ttdoc">Holds the pointer returned by the loading function.</div><div class="ttdef"><b>Definition:</b> ModelAnimations.hpp:53</div></div>
<div class="ttc" id="aclassRAY_1_1ModelAnimation_html"><div class="ttname"><a href="classRAY_1_1ModelAnimation.html">RAY::ModelAnimation</a></div><div class="ttdoc">A Holder for Model Animations.</div><div class="ttdef"><b>Definition:</b> ModelAnimation.hpp:16</div></div>
<div class="ttc" id="aclassRAY_1_1ModelAnimations_html_a11f187f98a736033cc670254020b331e"><div class="ttname"><a href="classRAY_1_1ModelAnimations.html#a11f187f98a736033cc670254020b331e">RAY::ModelAnimations::_animationsCache</a></div><div class="ttdeci">static Cache&lt;::ModelAnimation &gt; _animationsCache</div><div class="ttdef"><b>Definition:</b> ModelAnimations.hpp:64</div></div>
<div class="ttc" id="aModelAnimation_8hpp_html"><div class="ttname"><a href="ModelAnimation_8hpp.html">ModelAnimation.hpp</a></div></div>
<div class="ttc" id="aclassRAY_1_1ModelAnimations_html_a32df7913b2435c0fb15aa0d7b38bc394"><div class="ttname"><a href="classRAY_1_1ModelAnimations.html#a32df7913b2435c0fb15aa0d7b38bc394">RAY::ModelAnimations::_animations</a></div><div class="ttdeci">std::vector&lt; ModelAnimation &gt; _animations</div><div class="ttdoc">A holder for animations.</div><div class="ttdef"><b>Definition:</b> ModelAnimations.hpp:56</div></div>
<div class="ttc" id="aclassRAY_1_1ModelAnimations_html_adc6ac6bfd0465e5f7269e753b27d4588"><div class="ttname"><a href="classRAY_1_1ModelAnimations.html#adc6ac6bfd0465e5f7269e753b27d4588">RAY::ModelAnimations::~ModelAnimations</a></div><div class="ttdeci">~ModelAnimations()=default</div><div class="ttdoc">Default constructor.</div></div>
<div class="ttc" id="anamespaceRAY_html"><div class="ttname"><a href="namespaceRAY.html">RAY</a></div><div class="ttdef"><b>Definition:</b> IAudio.hpp:12</div></div>
<div class="ttc" id="aclassRAY_1_1ModelAnimations_html_a8ba8448b39ae9c6e8198ccd73a0755d4"><div class="ttname"><a href="classRAY_1_1ModelAnimations.html#a8ba8448b39ae9c6e8198ccd73a0755d4">RAY::ModelAnimations::operator[]</a></div><div class="ttdeci">ModelAnimation &amp; operator[](int index)</div><div class="ttdoc">Castin Object to raw model animation pointer.</div><div class="ttdef"><b>Definition:</b> ModelAnimations.cpp:28</div></div>
<div class="ttc" id="aclassRAY_1_1ModelAnimations_html_a13a2590157632886cf086346b3909b97"><div class="ttname"><a href="classRAY_1_1ModelAnimations.html#a13a2590157632886cf086346b3909b97">RAY::ModelAnimations::getAnimationsCount</a></div><div class="ttdeci">size_t getAnimationsCount() const</div><div class="ttdef"><b>Definition:</b> ModelAnimations.cpp:33</div></div>
<div class="ttc" id="aclassRAY_1_1ModelAnimations_html_a9c7cab28c414011893beb07c82f9cf1e"><div class="ttname"><a href="classRAY_1_1ModelAnimations.html#a9c7cab28c414011893beb07c82f9cf1e">RAY::ModelAnimations::at</a></div><div class="ttdeci">const ModelAnimation &amp; at(int index) const</div><div class="ttdoc">std at const</div><div class="ttdef"><b>Definition:</b> ModelAnimations.cpp:43</div></div>
<div class="ttc" id="aclassRAY_1_1ModelAnimations_html_a2674d2846eb7c088d84b911b38427788"><div class="ttname"><a href="classRAY_1_1ModelAnimations.html#a2674d2846eb7c088d84b911b38427788">RAY::ModelAnimations::getFilePath</a></div><div class="ttdeci">std::string getFilePath() const</div><div class="ttdoc">Get the creation file.</div><div class="ttdef"><b>Definition:</b> ModelAnimations.cpp:38</div></div>
<div class="ttc" id="aclassRAY_1_1ModelAnimations_html"><div class="ttname"><a href="classRAY_1_1ModelAnimations.html">RAY::ModelAnimations</a></div><div class="ttdoc">A Holder for Model Animations.</div><div class="ttdef"><b>Definition:</b> ModelAnimations.hpp:18</div></div>
<div class="ttc" id="aclassRAY_1_1ModelAnimations_html_af42a70825f0c4382e9c16fcfd4550255"><div class="ttname"><a href="classRAY_1_1ModelAnimations.html#af42a70825f0c4382e9c16fcfd4550255">RAY::ModelAnimations::_animationCount</a></div><div class="ttdeci">int _animationCount</div><div class="ttdoc">the number of loaded animations</div><div class="ttdef"><b>Definition:</b> ModelAnimations.hpp:59</div></div>
<div class="ttc" id="aclassRAY_1_1ModelAnimations_html_adf9bb72a9f726d0a892a1ab0cec50ae5"><div class="ttname"><a href="classRAY_1_1ModelAnimations.html#adf9bb72a9f726d0a892a1ab0cec50ae5">RAY::ModelAnimations::ModelAnimations</a></div><div class="ttdeci">ModelAnimations(const std::string &amp;filePath)</div><div class="ttdoc">A Model animation constructor.</div><div class="ttdef"><b>Definition:</b> ModelAnimations.cpp:18</div></div>
<div class="ttc" id="aclassRAY_1_1Cache_3_1_1ModelAnimation_01_4_html"><div class="ttname"><a href="classRAY_1_1Cache_3_1_1ModelAnimation_01_4.html">RAY::Cache&lt;::ModelAnimation &gt;</a></div><div class="ttdef"><b>Definition:</b> Cache.hpp:75</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>