zoriya/Bomberman
1
0
Fork 0
mirror of https://github.com/zoriya/Bomberman.git synced 2026-06-03 10:26:29 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
Documentation
Bomberman/classBBM_1_1MusicComponent.html
T
AnonymusRaccoon adc7dd8d5c Deploying the documentation
2021-06-26 11:31:13 +00:00

604 lines
35 KiB
HTML
Raw Permalink Blame History

<!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: BBM::MusicComponent Class Reference</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="namespaceBBM.html">BBM</a></li><li class="navelem"><a class="el" href="classBBM_1_1MusicComponent.html">MusicComponent</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-attribs">Static Public Attributes</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="classBBM_1_1MusicComponent-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">BBM::MusicComponent Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>A basic Music component.
<a href="classBBM_1_1MusicComponent.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="MusicComponent_8hpp_source.html">MusicComponent.hpp</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for BBM::MusicComponent:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="classBBM_1_1MusicComponent__inherit__graph.svg" width="188" height="522"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
</div>
<div class="dynheader">
Collaboration diagram for BBM::MusicComponent:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="classBBM_1_1MusicComponent__coll__graph.svg" width="558" height="1403"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
</div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a19a6be0e1df5470b7ddb1b342b2d40cb"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBBM_1_1MusicComponent.html#a19a6be0e1df5470b7ddb1b342b2d40cb">playMusic</a> ()</td></tr>
<tr class="memdesc:a19a6be0e1df5470b7ddb1b342b2d40cb"><td class="mdescLeft">&#160;</td><td class="mdescRight">start music <a href="classBBM_1_1MusicComponent.html#a19a6be0e1df5470b7ddb1b342b2d40cb">More...</a><br /></td></tr>
<tr class="separator:a19a6be0e1df5470b7ddb1b342b2d40cb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa67408ffd6176d010f213f996fce5bba"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBBM_1_1MusicComponent.html#aa67408ffd6176d010f213f996fce5bba">stopMusic</a> ()</td></tr>
<tr class="memdesc:aa67408ffd6176d010f213f996fce5bba"><td class="mdescLeft">&#160;</td><td class="mdescRight">stop music <a href="classBBM_1_1MusicComponent.html#aa67408ffd6176d010f213f996fce5bba">More...</a><br /></td></tr>
<tr class="separator:aa67408ffd6176d010f213f996fce5bba"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ada272cc4bf8602317cd9916f1c20e005"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBBM_1_1MusicComponent.html#ada272cc4bf8602317cd9916f1c20e005">pauseMusic</a> ()</td></tr>
<tr class="memdesc:ada272cc4bf8602317cd9916f1c20e005"><td class="mdescLeft">&#160;</td><td class="mdescRight">put music on hold <a href="classBBM_1_1MusicComponent.html#ada272cc4bf8602317cd9916f1c20e005">More...</a><br /></td></tr>
<tr class="separator:ada272cc4bf8602317cd9916f1c20e005"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4b5c0010e15ec51a672d3aec2f6eb025"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBBM_1_1MusicComponent.html#a4b5c0010e15ec51a672d3aec2f6eb025">setVolume</a> (float)</td></tr>
<tr class="memdesc:a4b5c0010e15ec51a672d3aec2f6eb025"><td class="mdescLeft">&#160;</td><td class="mdescRight">set music volume <a href="classBBM_1_1MusicComponent.html#a4b5c0010e15ec51a672d3aec2f6eb025">More...</a><br /></td></tr>
<tr class="separator:a4b5c0010e15ec51a672d3aec2f6eb025"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab13e4f8cfcc504b0ad110da7bf27b606"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBBM_1_1MusicComponent.html#ab13e4f8cfcc504b0ad110da7bf27b606">turnDownVolume</a> ()</td></tr>
<tr class="memdesc:ab13e4f8cfcc504b0ad110da7bf27b606"><td class="mdescLeft">&#160;</td><td class="mdescRight">volume -= 0.1 <a href="classBBM_1_1MusicComponent.html#ab13e4f8cfcc504b0ad110da7bf27b606">More...</a><br /></td></tr>
<tr class="separator:ab13e4f8cfcc504b0ad110da7bf27b606"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adadebeafceb80d1ccf27317d592b40cf"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBBM_1_1MusicComponent.html#adadebeafceb80d1ccf27317d592b40cf">turnUpVolume</a> ()</td></tr>
<tr class="memdesc:adadebeafceb80d1ccf27317d592b40cf"><td class="mdescLeft">&#160;</td><td class="mdescRight">volume += 0.1 <a href="classBBM_1_1MusicComponent.html#adadebeafceb80d1ccf27317d592b40cf">More...</a><br /></td></tr>
<tr class="separator:adadebeafceb80d1ccf27317d592b40cf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae7917a9e515f44d857152dc304cdba6c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBBM_1_1MusicComponent.html#ae7917a9e515f44d857152dc304cdba6c">setPitch</a> (float)</td></tr>
<tr class="memdesc:ae7917a9e515f44d857152dc304cdba6c"><td class="mdescLeft">&#160;</td><td class="mdescRight">set pitch volume <a href="classBBM_1_1MusicComponent.html#ae7917a9e515f44d857152dc304cdba6c">More...</a><br /></td></tr>
<tr class="separator:ae7917a9e515f44d857152dc304cdba6c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1750cf1cec1ac97879352aab28c3e44b"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBBM_1_1MusicComponent.html#a1750cf1cec1ac97879352aab28c3e44b">isPlaying</a> (void)</td></tr>
<tr class="memdesc:a1750cf1cec1ac97879352aab28c3e44b"><td class="mdescLeft">&#160;</td><td class="mdescRight">is music playing <a href="classBBM_1_1MusicComponent.html#a1750cf1cec1ac97879352aab28c3e44b">More...</a><br /></td></tr>
<tr class="separator:a1750cf1cec1ac97879352aab28c3e44b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4a45bd292f7a4a24eca25fe847478ccd"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBBM_1_1MusicComponent.html#a4a45bd292f7a4a24eca25fe847478ccd">updateMusicStream</a> (void)</td></tr>
<tr class="memdesc:a4a45bd292f7a4a24eca25fe847478ccd"><td class="mdescLeft">&#160;</td><td class="mdescRight">update music stream <a href="classBBM_1_1MusicComponent.html#a4a45bd292f7a4a24eca25fe847478ccd">More...</a><br /></td></tr>
<tr class="separator:a4a45bd292f7a4a24eca25fe847478ccd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a33d95a88477b5c537e7822be5f0a5602"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classWAL_1_1Component.html">WAL::Component</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBBM_1_1MusicComponent.html#a33d95a88477b5c537e7822be5f0a5602">clone</a> (<a class="el" href="classWAL_1_1Entity.html">WAL::Entity</a> &amp;entity) const override</td></tr>
<tr class="memdesc:a33d95a88477b5c537e7822be5f0a5602"><td class="mdescLeft">&#160;</td><td class="mdescRight">Clone a component for another or the same entity. <a href="classBBM_1_1MusicComponent.html#a33d95a88477b5c537e7822be5f0a5602">More...</a><br /></td></tr>
<tr class="separator:a33d95a88477b5c537e7822be5f0a5602"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1be8965ed0e213babd30400584382c4b"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBBM_1_1MusicComponent.html#a1be8965ed0e213babd30400584382c4b">MusicComponent</a> (<a class="el" href="classWAL_1_1Entity.html">WAL::Entity</a> &amp;entity, const std::string &amp;musicPath)</td></tr>
<tr class="memdesc:a1be8965ed0e213babd30400584382c4b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a new <a class="el" href="classBBM_1_1MusicComponent.html" title="A basic Music component.">MusicComponent</a> at a certain Music. <a href="classBBM_1_1MusicComponent.html#a1be8965ed0e213babd30400584382c4b">More...</a><br /></td></tr>
<tr class="separator:a1be8965ed0e213babd30400584382c4b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a53695898b51f1db3a93cd7bc6c42f047"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBBM_1_1MusicComponent.html#a53695898b51f1db3a93cd7bc6c42f047">MusicComponent</a> (const <a class="el" href="classBBM_1_1MusicComponent.html">MusicComponent</a> &amp;)=default</td></tr>
<tr class="memdesc:a53695898b51f1db3a93cd7bc6c42f047"><td class="mdescLeft">&#160;</td><td class="mdescRight">A Music component is copy constructable. <a href="classBBM_1_1MusicComponent.html#a53695898b51f1db3a93cd7bc6c42f047">More...</a><br /></td></tr>
<tr class="separator:a53695898b51f1db3a93cd7bc6c42f047"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1fa1e353935dd87b4975b9209168af09"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBBM_1_1MusicComponent.html#a1fa1e353935dd87b4975b9209168af09">~MusicComponent</a> () override=default</td></tr>
<tr class="memdesc:a1fa1e353935dd87b4975b9209168af09"><td class="mdescLeft">&#160;</td><td class="mdescRight">A default destructor. <a href="classBBM_1_1MusicComponent.html#a1fa1e353935dd87b4975b9209168af09">More...</a><br /></td></tr>
<tr class="separator:a1fa1e353935dd87b4975b9209168af09"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af132b55f14dec079a66d2589ccbdb222"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classBBM_1_1MusicComponent.html">MusicComponent</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBBM_1_1MusicComponent.html#af132b55f14dec079a66d2589ccbdb222">operator=</a> (const <a class="el" href="classBBM_1_1MusicComponent.html">MusicComponent</a> &amp;)=delete</td></tr>
<tr class="memdesc:af132b55f14dec079a66d2589ccbdb222"><td class="mdescLeft">&#160;</td><td class="mdescRight">A Music component is not assignable. <a href="classBBM_1_1MusicComponent.html#af132b55f14dec079a66d2589ccbdb222">More...</a><br /></td></tr>
<tr class="separator:af132b55f14dec079a66d2589ccbdb222"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classWAL_1_1Component"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classWAL_1_1Component')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classWAL_1_1Component.html">WAL::Component</a></td></tr>
<tr class="memitem:a155fb97f22714a0f489af7442d7d3253 inherit pub_methods_classWAL_1_1Component"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classWAL_1_1Component.html">Component</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWAL_1_1Component.html#a155fb97f22714a0f489af7442d7d3253">operator=</a> (const <a class="el" href="classWAL_1_1Component.html">Component</a> &amp;)=delete</td></tr>
<tr class="memdesc:a155fb97f22714a0f489af7442d7d3253 inherit pub_methods_classWAL_1_1Component"><td class="mdescLeft">&#160;</td><td class="mdescRight">A component can't be assigned. <a href="classWAL_1_1Component.html#a155fb97f22714a0f489af7442d7d3253">More...</a><br /></td></tr>
<tr class="separator:a155fb97f22714a0f489af7442d7d3253 inherit pub_methods_classWAL_1_1Component"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3d8e13fdc53a63b0b1f8d15576f98cf8 inherit pub_methods_classWAL_1_1Component"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWAL_1_1Component.html#a3d8e13fdc53a63b0b1f8d15576f98cf8">~Component</a> ()=default</td></tr>
<tr class="memdesc:a3d8e13fdc53a63b0b1f8d15576f98cf8 inherit pub_methods_classWAL_1_1Component"><td class="mdescLeft">&#160;</td><td class="mdescRight">A virtual destructor. <a href="classWAL_1_1Component.html#a3d8e13fdc53a63b0b1f8d15576f98cf8">More...</a><br /></td></tr>
<tr class="separator:a3d8e13fdc53a63b0b1f8d15576f98cf8 inherit pub_methods_classWAL_1_1Component"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4acae0960f4232caf8395b2465dde8cc inherit pub_methods_classWAL_1_1Component"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWAL_1_1Component.html#a4acae0960f4232caf8395b2465dde8cc">onStart</a> ()</td></tr>
<tr class="memdesc:a4acae0960f4232caf8395b2465dde8cc inherit pub_methods_classWAL_1_1Component"><td class="mdescLeft">&#160;</td><td class="mdescRight">The entity or this component has just been enabled. <a href="classWAL_1_1Component.html#a4acae0960f4232caf8395b2465dde8cc">More...</a><br /></td></tr>
<tr class="separator:a4acae0960f4232caf8395b2465dde8cc inherit pub_methods_classWAL_1_1Component"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0f3f4fe54fd06de1e685835977fef050 inherit pub_methods_classWAL_1_1Component"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWAL_1_1Component.html#a0f3f4fe54fd06de1e685835977fef050">onStop</a> ()</td></tr>
<tr class="memdesc:a0f3f4fe54fd06de1e685835977fef050 inherit pub_methods_classWAL_1_1Component"><td class="mdescLeft">&#160;</td><td class="mdescRight">The entity or this component has just been disable. <a href="classWAL_1_1Component.html#a0f3f4fe54fd06de1e685835977fef050">More...</a><br /></td></tr>
<tr class="separator:a0f3f4fe54fd06de1e685835977fef050 inherit pub_methods_classWAL_1_1Component"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-attribs"></a>
Static Public Attributes</h2></td></tr>
<tr class="memitem:af6dec26d07ed21a379fcd615daf3dbb9"><td class="memItemLeft" align="right" valign="top">static float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBBM_1_1MusicComponent.html#af6dec26d07ed21a379fcd615daf3dbb9">volume</a> = 0.75</td></tr>
<tr class="memdesc:af6dec26d07ed21a379fcd615daf3dbb9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Volume of the muisc. <a href="classBBM_1_1MusicComponent.html#af6dec26d07ed21a379fcd615daf3dbb9">More...</a><br /></td></tr>
<tr class="separator:af6dec26d07ed21a379fcd615daf3dbb9"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:af7de05efbd8a45b3e49ece4bbb793103"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classRAY_1_1Audio_1_1Music.html">RAY::Audio::Music</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBBM_1_1MusicComponent.html#af7de05efbd8a45b3e49ece4bbb793103">_music</a></td></tr>
<tr class="memdesc:af7de05efbd8a45b3e49ece4bbb793103"><td class="mdescLeft">&#160;</td><td class="mdescRight">music of this entity <a href="classBBM_1_1MusicComponent.html#af7de05efbd8a45b3e49ece4bbb793103">More...</a><br /></td></tr>
<tr class="separator:af7de05efbd8a45b3e49ece4bbb793103"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad75f261e5146c728f83383c68afab661"><td class="memItemLeft" align="right" valign="top">const std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBBM_1_1MusicComponent.html#ad75f261e5146c728f83383c68afab661">_musicPath</a></td></tr>
<tr class="memdesc:ad75f261e5146c728f83383c68afab661"><td class="mdescLeft">&#160;</td><td class="mdescRight">patht to the music assets <a href="classBBM_1_1MusicComponent.html#ad75f261e5146c728f83383c68afab661">More...</a><br /></td></tr>
<tr class="separator:ad75f261e5146c728f83383c68afab661"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pro_methods_classWAL_1_1Component"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classWAL_1_1Component')"><img src="closed.png" alt="-"/>&#160;Protected Member Functions inherited from <a class="el" href="classWAL_1_1Component.html">WAL::Component</a></td></tr>
<tr class="memitem:ad27cb4b0bdc95b6245f6b5a8c56cc78a inherit pro_methods_classWAL_1_1Component"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWAL_1_1Component.html#ad27cb4b0bdc95b6245f6b5a8c56cc78a">Component</a> (<a class="el" href="classWAL_1_1Entity.html">Entity</a> &amp;entity)</td></tr>
<tr class="memdesc:ad27cb4b0bdc95b6245f6b5a8c56cc78a inherit pro_methods_classWAL_1_1Component"><td class="mdescLeft">&#160;</td><td class="mdescRight">A component can't be instantiated, it should be derived. <a href="classWAL_1_1Component.html#ad27cb4b0bdc95b6245f6b5a8c56cc78a">More...</a><br /></td></tr>
<tr class="separator:ad27cb4b0bdc95b6245f6b5a8c56cc78a inherit pro_methods_classWAL_1_1Component"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3a3306df3733bfa77c70d789b650984b inherit pro_methods_classWAL_1_1Component"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWAL_1_1Component.html#a3a3306df3733bfa77c70d789b650984b">Component</a> (const <a class="el" href="classWAL_1_1Component.html">Component</a> &amp;)=default</td></tr>
<tr class="memdesc:a3a3306df3733bfa77c70d789b650984b inherit pro_methods_classWAL_1_1Component"><td class="mdescLeft">&#160;</td><td class="mdescRight">A component can't be instantiated, it should be derived. <a href="classWAL_1_1Component.html#a3a3306df3733bfa77c70d789b650984b">More...</a><br /></td></tr>
<tr class="separator:a3a3306df3733bfa77c70d789b650984b inherit pro_methods_classWAL_1_1Component"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pro_attribs_classWAL_1_1Component"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_classWAL_1_1Component')"><img src="closed.png" alt="-"/>&#160;Protected Attributes inherited from <a class="el" href="classWAL_1_1Component.html">WAL::Component</a></td></tr>
<tr class="memitem:a3841f7c8cc4eeb9d1e97b3182976d89f inherit pro_attribs_classWAL_1_1Component"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classWAL_1_1Entity.html">Entity</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWAL_1_1Component.html#a3841f7c8cc4eeb9d1e97b3182976d89f">_entity</a></td></tr>
<tr class="memdesc:a3841f7c8cc4eeb9d1e97b3182976d89f inherit pro_attribs_classWAL_1_1Component"><td class="mdescLeft">&#160;</td><td class="mdescRight">The entity that own this component. <a href="classWAL_1_1Component.html#a3841f7c8cc4eeb9d1e97b3182976d89f">More...</a><br /></td></tr>
<tr class="separator:a3841f7c8cc4eeb9d1e97b3182976d89f inherit pro_attribs_classWAL_1_1Component"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>A basic Music component. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a1be8965ed0e213babd30400584382c4b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1be8965ed0e213babd30400584382c4b">&#9670;&nbsp;</a></span>MusicComponent() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">BBM::MusicComponent::MusicComponent </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classWAL_1_1Entity.html">WAL::Entity</a> &amp;&#160;</td>
<td class="paramname"><em>entity</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>musicPath</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">explicit</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a new <a class="el" href="classBBM_1_1MusicComponent.html" title="A basic Music component.">MusicComponent</a> at a certain Music. </p>
</div>
</div>
<a id="a53695898b51f1db3a93cd7bc6c42f047"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a53695898b51f1db3a93cd7bc6c42f047">&#9670;&nbsp;</a></span>MusicComponent() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">BBM::MusicComponent::MusicComponent </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classBBM_1_1MusicComponent.html">MusicComponent</a> &amp;&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">default</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>A Music component is copy constructable. </p>
</div>
</div>
<a id="a1fa1e353935dd87b4975b9209168af09"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1fa1e353935dd87b4975b9209168af09">&#9670;&nbsp;</a></span>~MusicComponent()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">BBM::MusicComponent::~MusicComponent </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">default</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>A default destructor. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a33d95a88477b5c537e7822be5f0a5602"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a33d95a88477b5c537e7822be5f0a5602">&#9670;&nbsp;</a></span>clone()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classWAL_1_1Component.html">WAL::Component</a> * BBM::MusicComponent::clone </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classWAL_1_1Entity.html">WAL::Entity</a> &amp;&#160;</td>
<td class="paramname"><em>entity</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Clone a component for another or the same entity. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">entity</td><td>The entity that owns the ne component. </td></tr>
</table>
</dd>
</dl>
<p>Implements <a class="el" href="classWAL_1_1Component.html#a0bbee4f657e10fd190a28d15afe63e93">WAL::Component</a>.</p>
</div>
</div>
<a id="a1750cf1cec1ac97879352aab28c3e44b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1750cf1cec1ac97879352aab28c3e44b">&#9670;&nbsp;</a></span>isPlaying()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool BBM::MusicComponent::isPlaying </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>is music playing </p>
</div>
</div>
<a id="af132b55f14dec079a66d2589ccbdb222"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af132b55f14dec079a66d2589ccbdb222">&#9670;&nbsp;</a></span>operator=()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classBBM_1_1MusicComponent.html">MusicComponent</a>&amp; BBM::MusicComponent::operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classBBM_1_1MusicComponent.html">MusicComponent</a> &amp;&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">delete</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>A Music component is not assignable. </p>
</div>
</div>
<a id="ada272cc4bf8602317cd9916f1c20e005"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ada272cc4bf8602317cd9916f1c20e005">&#9670;&nbsp;</a></span>pauseMusic()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void BBM::MusicComponent::pauseMusic </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>put music on hold </p>
</div>
</div>
<a id="a19a6be0e1df5470b7ddb1b342b2d40cb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a19a6be0e1df5470b7ddb1b342b2d40cb">&#9670;&nbsp;</a></span>playMusic()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void BBM::MusicComponent::playMusic </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>start music </p>
</div>
</div>
<a id="ae7917a9e515f44d857152dc304cdba6c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae7917a9e515f44d857152dc304cdba6c">&#9670;&nbsp;</a></span>setPitch()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void BBM::MusicComponent::setPitch </td>
<td>(</td>
<td class="paramtype">float&#160;</td>
<td class="paramname"><em>pitch</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>set pitch volume </p>
</div>
</div>
<a id="a4b5c0010e15ec51a672d3aec2f6eb025"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4b5c0010e15ec51a672d3aec2f6eb025">&#9670;&nbsp;</a></span>setVolume()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void BBM::MusicComponent::setVolume </td>
<td>(</td>
<td class="paramtype">float&#160;</td>
<td class="paramname"><em>volumeUpdate</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>set music volume </p>
</div>
</div>
<a id="aa67408ffd6176d010f213f996fce5bba"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa67408ffd6176d010f213f996fce5bba">&#9670;&nbsp;</a></span>stopMusic()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void BBM::MusicComponent::stopMusic </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>stop music </p>
</div>
</div>
<a id="ab13e4f8cfcc504b0ad110da7bf27b606"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab13e4f8cfcc504b0ad110da7bf27b606">&#9670;&nbsp;</a></span>turnDownVolume()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void BBM::MusicComponent::turnDownVolume </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>volume -= 0.1 </p>
</div>
</div>
<a id="adadebeafceb80d1ccf27317d592b40cf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adadebeafceb80d1ccf27317d592b40cf">&#9670;&nbsp;</a></span>turnUpVolume()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void BBM::MusicComponent::turnUpVolume </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>volume += 0.1 </p>
</div>
</div>
<a id="a4a45bd292f7a4a24eca25fe847478ccd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4a45bd292f7a4a24eca25fe847478ccd">&#9670;&nbsp;</a></span>updateMusicStream()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void BBM::MusicComponent::updateMusicStream </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>update music stream </p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="af7de05efbd8a45b3e49ece4bbb793103"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af7de05efbd8a45b3e49ece4bbb793103">&#9670;&nbsp;</a></span>_music</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classRAY_1_1Audio_1_1Music.html">RAY::Audio::Music</a> BBM::MusicComponent::_music</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>music of this entity </p>
</div>
</div>
<a id="ad75f261e5146c728f83383c68afab661"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad75f261e5146c728f83383c68afab661">&#9670;&nbsp;</a></span>_musicPath</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const std::string BBM::MusicComponent::_musicPath</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>patht to the music assets </p>
</div>
</div>
<a id="af6dec26d07ed21a379fcd615daf3dbb9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af6dec26d07ed21a379fcd615daf3dbb9">&#9670;&nbsp;</a></span>volume</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">float BBM::MusicComponent::volume = 0.75</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Volume of the muisc. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>sources/Component/Music/<a class="el" href="MusicComponent_8hpp_source.html">MusicComponent.hpp</a></li>
<li>sources/Component/Music/<a class="el" href="MusicComponent_8cpp.html">MusicComponent.cpp</a></li>
</ul>
</div><!-- contents -->
<!-- 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>
Reference in New Issue View Git Blame Copy Permalink