mirror of
https://github.com/zoriya/Bomberman.git
synced 2026-06-03 10:26:29 +00:00
AnonymusRaccoon
147 lines
19 KiB
HTML
147 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: sources/Component/Music/MusicComponent.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&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&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_0d71312609313d14d9d57b6221c54b29.html">Music</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">MusicComponent.hpp</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="MusicComponent_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> <span class="comment">//</span></div>
|
|
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">// Created by Tom Augier on 05/06/2021</span></div>
|
|
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">//</span></div>
|
|
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>  </div>
|
|
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="preprocessor">#pragma once</span></div>
|
|
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>  </div>
|
|
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="preprocessor">#include "<a class="code" href="Component_8hpp.html">Component/Component.hpp</a>"</span></div>
|
|
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="preprocessor">#include <map></span></div>
|
|
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="preprocessor">#include "<a class="code" href="Music_8hpp.html">Audio/Music.hpp</a>"</span></div>
|
|
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>  </div>
|
|
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="keyword">namespace </span><a class="code" href="namespaceBBM.html">BBM</a></div>
|
|
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> {</div>
|
|
<div class="line"><a name="l00014"></a><span class="lineno"><a class="line" href="classBBM_1_1MusicComponent.html"> 14</a></span>  <span class="keyword">class </span><a class="code" href="classBBM_1_1MusicComponent.html">MusicComponent</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>  {</div>
|
|
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>  <span class="keyword">public</span>:</div>
|
|
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>  <span class="keywordtype">void</span> <a class="code" href="classBBM_1_1MusicComponent.html#a19a6be0e1df5470b7ddb1b342b2d40cb">playMusic</a>();</div>
|
|
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>  </div>
|
|
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>  <span class="keywordtype">void</span> <a class="code" href="classBBM_1_1MusicComponent.html#aa67408ffd6176d010f213f996fce5bba">stopMusic</a>();</div>
|
|
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  </div>
|
|
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>  <span class="keywordtype">void</span> <a class="code" href="classBBM_1_1MusicComponent.html#ada272cc4bf8602317cd9916f1c20e005">pauseMusic</a>();</div>
|
|
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  </div>
|
|
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  <span class="keywordtype">void</span> <a class="code" href="classBBM_1_1MusicComponent.html#a4b5c0010e15ec51a672d3aec2f6eb025">setVolume</a>(<span class="keywordtype">float</span>);</div>
|
|
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  </div>
|
|
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  <span class="keywordtype">void</span> <a class="code" href="classBBM_1_1MusicComponent.html#ab13e4f8cfcc504b0ad110da7bf27b606">turnDownVolume</a>();</div>
|
|
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  </div>
|
|
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  <span class="keywordtype">void</span> <a class="code" href="classBBM_1_1MusicComponent.html#adadebeafceb80d1ccf27317d592b40cf">turnUpVolume</a>();</div>
|
|
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  </div>
|
|
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  <span class="keywordtype">void</span> <a class="code" href="classBBM_1_1MusicComponent.html#ae7917a9e515f44d857152dc304cdba6c">setPitch</a>(<span class="keywordtype">float</span>);</div>
|
|
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  </div>
|
|
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <span class="keywordtype">bool</span> <a class="code" href="classBBM_1_1MusicComponent.html#a1750cf1cec1ac97879352aab28c3e44b">isPlaying</a>(<span class="keywordtype">void</span>);</div>
|
|
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="keywordtype">void</span> <a class="code" href="classBBM_1_1MusicComponent.html#a4a45bd292f7a4a24eca25fe847478ccd">updateMusicStream</a>(<span class="keywordtype">void</span>);</div>
|
|
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <a class="code" href="classWAL_1_1Component.html">WAL::Component</a> *<a class="code" href="classBBM_1_1MusicComponent.html#a33d95a88477b5c537e7822be5f0a5602">clone</a>(<a class="code" href="classWAL_1_1Entity.html">WAL::Entity</a> &entity) <span class="keyword">const override</span>;</div>
|
|
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <span class="keyword">explicit</span> <a class="code" href="classBBM_1_1MusicComponent.html#a1be8965ed0e213babd30400584382c4b">MusicComponent</a>(<a class="code" href="classWAL_1_1Entity.html">WAL::Entity</a> &entity, <span class="keyword">const</span> std::string &musicPath);</div>
|
|
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <a class="code" href="classBBM_1_1MusicComponent.html#a1be8965ed0e213babd30400584382c4b">MusicComponent</a>(<span class="keyword">const</span> <a class="code" href="classBBM_1_1MusicComponent.html">MusicComponent</a> &) = <span class="keywordflow">default</span>;</div>
|
|
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <a class="code" href="classBBM_1_1MusicComponent.html#a1fa1e353935dd87b4975b9209168af09">~MusicComponent</a>() <span class="keyword">override</span> = <span class="keywordflow">default</span>;</div>
|
|
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <a class="code" href="classBBM_1_1MusicComponent.html">MusicComponent</a> &<a class="code" href="classBBM_1_1MusicComponent.html#af132b55f14dec079a66d2589ccbdb222">operator=</a>(<span class="keyword">const</span> <a class="code" href="classBBM_1_1MusicComponent.html">MusicComponent</a> &) = <span class="keyword">delete</span>;</div>
|
|
<div class="line"><a name="l00053"></a><span class="lineno"><a class="line" href="classBBM_1_1MusicComponent.html#af6dec26d07ed21a379fcd615daf3dbb9"> 53</a></span>  <span class="keyword">static</span> <span class="keywordtype">float</span> <a class="code" href="classBBM_1_1MusicComponent.html#af6dec26d07ed21a379fcd615daf3dbb9">volume</a>;</div>
|
|
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="keyword">private</span>:</div>
|
|
<div class="line"><a name="l00056"></a><span class="lineno"><a class="line" href="classBBM_1_1MusicComponent.html#af7de05efbd8a45b3e49ece4bbb793103"> 56</a></span>  <a class="code" href="classRAY_1_1Audio_1_1Music.html">RAY::Audio::Music</a> <a class="code" href="classBBM_1_1MusicComponent.html#af7de05efbd8a45b3e49ece4bbb793103">_music</a>;</div>
|
|
<div class="line"><a name="l00058"></a><span class="lineno"><a class="line" href="classBBM_1_1MusicComponent.html#ad75f261e5146c728f83383c68afab661"> 58</a></span>  <span class="keyword">const</span> std::string <a class="code" href="classBBM_1_1MusicComponent.html#ad75f261e5146c728f83383c68afab661">_musicPath</a>;</div>
|
|
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  };</div>
|
|
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  </div>
|
|
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> } <span class="comment">// namespace BBM</span></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<div class="ttc" id="aclassBBM_1_1MusicComponent_html_a19a6be0e1df5470b7ddb1b342b2d40cb"><div class="ttname"><a href="classBBM_1_1MusicComponent.html#a19a6be0e1df5470b7ddb1b342b2d40cb">BBM::MusicComponent::playMusic</a></div><div class="ttdeci">void playMusic()</div><div class="ttdoc">start music</div><div class="ttdef"><b>Definition:</b> MusicComponent.cpp:24</div></div>
|
|
<div class="ttc" id="aclassRAY_1_1Audio_1_1Music_html"><div class="ttname"><a href="classRAY_1_1Audio_1_1Music.html">RAY::Audio::Music</a></div><div class="ttdoc">A manager for music stream.</div><div class="ttdef"><b>Definition:</b> Music.hpp:18</div></div>
|
|
<div class="ttc" id="aclassBBM_1_1MusicComponent_html_ada272cc4bf8602317cd9916f1c20e005"><div class="ttname"><a href="classBBM_1_1MusicComponent.html#ada272cc4bf8602317cd9916f1c20e005">BBM::MusicComponent::pauseMusic</a></div><div class="ttdeci">void pauseMusic()</div><div class="ttdoc">put music on hold</div><div class="ttdef"><b>Definition:</b> MusicComponent.cpp:37</div></div>
|
|
<div class="ttc" id="aclassBBM_1_1MusicComponent_html_a1750cf1cec1ac97879352aab28c3e44b"><div class="ttname"><a href="classBBM_1_1MusicComponent.html#a1750cf1cec1ac97879352aab28c3e44b">BBM::MusicComponent::isPlaying</a></div><div class="ttdeci">bool isPlaying(void)</div><div class="ttdoc">is music playing</div><div class="ttdef"><b>Definition:</b> MusicComponent.cpp:55</div></div>
|
|
<div class="ttc" id="aclassBBM_1_1MusicComponent_html_a4a45bd292f7a4a24eca25fe847478ccd"><div class="ttname"><a href="classBBM_1_1MusicComponent.html#a4a45bd292f7a4a24eca25fe847478ccd">BBM::MusicComponent::updateMusicStream</a></div><div class="ttdeci">void updateMusicStream(void)</div><div class="ttdoc">update music stream</div><div class="ttdef"><b>Definition:</b> MusicComponent.cpp:60</div></div>
|
|
<div class="ttc" id="aclassBBM_1_1MusicComponent_html_ad75f261e5146c728f83383c68afab661"><div class="ttname"><a href="classBBM_1_1MusicComponent.html#ad75f261e5146c728f83383c68afab661">BBM::MusicComponent::_musicPath</a></div><div class="ttdeci">const std::string _musicPath</div><div class="ttdoc">patht to the music assets</div><div class="ttdef"><b>Definition:</b> MusicComponent.hpp:58</div></div>
|
|
<div class="ttc" id="aclassBBM_1_1MusicComponent_html_ae7917a9e515f44d857152dc304cdba6c"><div class="ttname"><a href="classBBM_1_1MusicComponent.html#ae7917a9e515f44d857152dc304cdba6c">BBM::MusicComponent::setPitch</a></div><div class="ttdeci">void setPitch(float)</div><div class="ttdoc">set pitch volume</div><div class="ttdef"><b>Definition:</b> MusicComponent.cpp:50</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="aclassBBM_1_1MusicComponent_html_af132b55f14dec079a66d2589ccbdb222"><div class="ttname"><a href="classBBM_1_1MusicComponent.html#af132b55f14dec079a66d2589ccbdb222">BBM::MusicComponent::operator=</a></div><div class="ttdeci">MusicComponent & operator=(const MusicComponent &)=delete</div><div class="ttdoc">A Music component is not assignable.</div></div>
|
|
<div class="ttc" id="aMusic_8hpp_html"><div class="ttname"><a href="Music_8hpp.html">Music.hpp</a></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="aclassBBM_1_1MusicComponent_html_a4b5c0010e15ec51a672d3aec2f6eb025"><div class="ttname"><a href="classBBM_1_1MusicComponent.html#a4b5c0010e15ec51a672d3aec2f6eb025">BBM::MusicComponent::setVolume</a></div><div class="ttdeci">void setVolume(float)</div><div class="ttdoc">set music volume</div><div class="ttdef"><b>Definition:</b> MusicComponent.cpp:42</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="aclassBBM_1_1MusicComponent_html_ab13e4f8cfcc504b0ad110da7bf27b606"><div class="ttname"><a href="classBBM_1_1MusicComponent.html#ab13e4f8cfcc504b0ad110da7bf27b606">BBM::MusicComponent::turnDownVolume</a></div><div class="ttdeci">void turnDownVolume()</div><div class="ttdoc">volume -= 0.1</div><div class="ttdef"><b>Definition:</b> MusicComponent.cpp:65</div></div>
|
|
<div class="ttc" id="aclassBBM_1_1MusicComponent_html_af6dec26d07ed21a379fcd615daf3dbb9"><div class="ttname"><a href="classBBM_1_1MusicComponent.html#af6dec26d07ed21a379fcd615daf3dbb9">BBM::MusicComponent::volume</a></div><div class="ttdeci">static float volume</div><div class="ttdoc">Volume of the muisc.</div><div class="ttdef"><b>Definition:</b> MusicComponent.hpp:53</div></div>
|
|
<div class="ttc" id="aclassBBM_1_1MusicComponent_html_af7de05efbd8a45b3e49ece4bbb793103"><div class="ttname"><a href="classBBM_1_1MusicComponent.html#af7de05efbd8a45b3e49ece4bbb793103">BBM::MusicComponent::_music</a></div><div class="ttdeci">RAY::Audio::Music _music</div><div class="ttdoc">music of this entity</div><div class="ttdef"><b>Definition:</b> MusicComponent.hpp:56</div></div>
|
|
<div class="ttc" id="aclassBBM_1_1MusicComponent_html_a1be8965ed0e213babd30400584382c4b"><div class="ttname"><a href="classBBM_1_1MusicComponent.html#a1be8965ed0e213babd30400584382c4b">BBM::MusicComponent::MusicComponent</a></div><div class="ttdeci">MusicComponent(WAL::Entity &entity, const std::string &musicPath)</div><div class="ttdoc">Create a new MusicComponent at a certain Music.</div><div class="ttdef"><b>Definition:</b> MusicComponent.cpp:12</div></div>
|
|
<div class="ttc" id="aclassBBM_1_1MusicComponent_html_adadebeafceb80d1ccf27317d592b40cf"><div class="ttname"><a href="classBBM_1_1MusicComponent.html#adadebeafceb80d1ccf27317d592b40cf">BBM::MusicComponent::turnUpVolume</a></div><div class="ttdeci">void turnUpVolume()</div><div class="ttdoc">volume += 0.1</div><div class="ttdef"><b>Definition:</b> MusicComponent.cpp:70</div></div>
|
|
<div class="ttc" id="aclassBBM_1_1MusicComponent_html_aa67408ffd6176d010f213f996fce5bba"><div class="ttname"><a href="classBBM_1_1MusicComponent.html#aa67408ffd6176d010f213f996fce5bba">BBM::MusicComponent::stopMusic</a></div><div class="ttdeci">void stopMusic()</div><div class="ttdoc">stop music</div><div class="ttdef"><b>Definition:</b> MusicComponent.cpp:31</div></div>
|
|
<div class="ttc" id="aclassBBM_1_1MusicComponent_html_a1fa1e353935dd87b4975b9209168af09"><div class="ttname"><a href="classBBM_1_1MusicComponent.html#a1fa1e353935dd87b4975b9209168af09">BBM::MusicComponent::~MusicComponent</a></div><div class="ttdeci">~MusicComponent() override=default</div><div class="ttdoc">A default destructor.</div></div>
|
|
<div class="ttc" id="aclassBBM_1_1MusicComponent_html_a33d95a88477b5c537e7822be5f0a5602"><div class="ttname"><a href="classBBM_1_1MusicComponent.html#a33d95a88477b5c537e7822be5f0a5602">BBM::MusicComponent::clone</a></div><div class="ttdeci">WAL::Component * clone(WAL::Entity &entity) const override</div><div class="ttdoc">Clone a component for another or the same entity.</div><div class="ttdef"><b>Definition:</b> MusicComponent.cpp:19</div></div>
|
|
<div class="ttc" id="aclassBBM_1_1MusicComponent_html"><div class="ttname"><a href="classBBM_1_1MusicComponent.html">BBM::MusicComponent</a></div><div class="ttdoc">A basic Music component.</div><div class="ttdef"><b>Definition:</b> MusicComponent.hpp:14</div></div>
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.17
|
|
</small></address>
|
|
</body>
|
|
</html>
|