amuse/classamuse_1_1_engine.html

672 lines
34 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.11"/>
<title>Amuse: amuse::Engine 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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</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>
<script type="text/javascript">
$(document).ready(function() { init_search(); });
</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">Amuse
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="classes.html"><span>Class&#160;Index</span></a></li>
<li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('classamuse_1_1_engine.html','');});
</script>
<div id="doc-content">
<!-- 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 class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#friends">Friends</a> &#124;
<a href="classamuse_1_1_engine-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">amuse::Engine Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="_engine_8hpp_source.html">Engine.hpp</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for amuse::Engine:</div>
<div class="dyncontent">
<div class="center"><img src="classamuse_1_1_engine__coll__graph.png" border="0" usemap="#amuse_1_1_engine_coll__map" alt="Collaboration graph"/></div>
<map name="amuse_1_1_engine_coll__map" id="amuse_1_1_engine_coll__map">
</map>
</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:ae1668341d79208264f6d5e02acc50e76"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae1668341d79208264f6d5e02acc50e76"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>Engine</b> (<a class="el" href="classamuse_1_1_i_backend_voice_allocator.html">IBackendVoiceAllocator</a> &amp;backend)</td></tr>
<tr class="separator:ae1668341d79208264f6d5e02acc50e76"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a906ba1909a00555c3396a65c518056f2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classamuse_1_1_i_backend_voice_allocator.html">IBackendVoiceAllocator</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classamuse_1_1_engine.html#a906ba1909a00555c3396a65c518056f2">getBackend</a> ()</td></tr>
<tr class="separator:a906ba1909a00555c3396a65c518056f2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6815677808d2b00abeebacec19b5a291"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classamuse_1_1_engine.html#a6815677808d2b00abeebacec19b5a291">pumpEngine</a> (double dt)</td></tr>
<tr class="separator:a6815677808d2b00abeebacec19b5a291"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a695432906627c5cfcb18b83487e72f92"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classamuse_1_1_audio_group.html">AudioGroup</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classamuse_1_1_engine.html#a695432906627c5cfcb18b83487e72f92">addAudioGroup</a> (const <a class="el" href="classamuse_1_1_audio_group_data.html">AudioGroupData</a> &amp;data)</td></tr>
<tr class="separator:a695432906627c5cfcb18b83487e72f92"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1458ddca8cc76b93f6b71d4d62cb1d91"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classamuse_1_1_engine.html#a1458ddca8cc76b93f6b71d4d62cb1d91">removeAudioGroup</a> (const <a class="el" href="classamuse_1_1_audio_group_data.html">AudioGroupData</a> &amp;data)</td></tr>
<tr class="separator:a1458ddca8cc76b93f6b71d4d62cb1d91"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abd19d3a4db827b2b9e65a9ae9caaac0d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classamuse_1_1_submix.html">Submix</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classamuse_1_1_engine.html#abd19d3a4db827b2b9e65a9ae9caaac0d">addSubmix</a> (<a class="el" href="classamuse_1_1_submix.html">Submix</a> *parent=nullptr)</td></tr>
<tr class="separator:abd19d3a4db827b2b9e65a9ae9caaac0d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a681a9c5b3c05676a36180fb27a20f68d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classamuse_1_1_engine.html#a681a9c5b3c05676a36180fb27a20f68d">removeSubmix</a> (<a class="el" href="classamuse_1_1_submix.html">Submix</a> *smx)</td></tr>
<tr class="separator:a681a9c5b3c05676a36180fb27a20f68d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac03ae79986617e18b4428ae038aea80c"><td class="memItemLeft" align="right" valign="top">std::shared_ptr&lt; <a class="el" href="classamuse_1_1_voice.html">Voice</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classamuse_1_1_engine.html#ac03ae79986617e18b4428ae038aea80c">fxStart</a> (int sfxId, float vol, float pan, <a class="el" href="classamuse_1_1_submix.html">Submix</a> *smx=nullptr)</td></tr>
<tr class="separator:ac03ae79986617e18b4428ae038aea80c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac81c9299c8ba08cfaa857d0f1c4233a3"><td class="memItemLeft" align="right" valign="top">std::shared_ptr&lt; <a class="el" href="classamuse_1_1_emitter.html">Emitter</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classamuse_1_1_engine.html#ac81c9299c8ba08cfaa857d0f1c4233a3">addEmitter</a> (const Vector3f &amp;pos, const Vector3f &amp;dir, float maxDist, float falloff, int sfxId, float minVol, float maxVol, <a class="el" href="classamuse_1_1_submix.html">Submix</a> *smx=nullptr)</td></tr>
<tr class="separator:ac81c9299c8ba08cfaa857d0f1c4233a3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a82b8c2a0785a128ed59cbc404eb66a64"><td class="memItemLeft" align="right" valign="top">std::shared_ptr&lt; <a class="el" href="classamuse_1_1_sequencer.html">Sequencer</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classamuse_1_1_engine.html#a82b8c2a0785a128ed59cbc404eb66a64">seqPlay</a> (int groupId, int songId, const unsigned char *arrData, <a class="el" href="classamuse_1_1_submix.html">Submix</a> *smx=nullptr)</td></tr>
<tr class="separator:a82b8c2a0785a128ed59cbc404eb66a64"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aea32232a059d5a9d4bfa2695a0c6c1f4"><td class="memItemLeft" align="right" valign="top">std::shared_ptr&lt; <a class="el" href="classamuse_1_1_voice.html">Voice</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classamuse_1_1_engine.html#aea32232a059d5a9d4bfa2695a0c6c1f4">findVoice</a> (int vid)</td></tr>
<tr class="separator:aea32232a059d5a9d4bfa2695a0c6c1f4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aeb3ece0d4e5d074b4e26dc4694750e70"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classamuse_1_1_engine.html#aeb3ece0d4e5d074b4e26dc4694750e70">killKeygroup</a> (uint8_t kg, bool now)</td></tr>
<tr class="separator:aeb3ece0d4e5d074b4e26dc4694750e70"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9fb7f33d3ec86d257ee9b64817b39aa6"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classamuse_1_1_engine.html#a9fb7f33d3ec86d257ee9b64817b39aa6">sendMacroMessage</a> (ObjectId macroId, int32_t val)</td></tr>
<tr class="separator:a9fb7f33d3ec86d257ee9b64817b39aa6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af4fc1348b89f07b36a28ad45c84c0390"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classamuse_1_1_engine.html#af4fc1348b89f07b36a28ad45c84c0390">nextRandom</a> ()</td></tr>
<tr class="separator:af4fc1348b89f07b36a28ad45c84c0390"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:a24657954e9f1d12330a031c549e6e850"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a24657954e9f1d12330a031c549e6e850"></a>
class&#160;</td><td class="memItemRight" valign="bottom"><b>Voice</b></td></tr>
<tr class="separator:a24657954e9f1d12330a031c549e6e850"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1cad71ec309b8c8b0beee324b9b65e5a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1cad71ec309b8c8b0beee324b9b65e5a"></a>
class&#160;</td><td class="memItemRight" valign="bottom"><b>Emitter</b></td></tr>
<tr class="separator:a1cad71ec309b8c8b0beee324b9b65e5a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a52a69080aff30f06654e72959d45db49"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a52a69080aff30f06654e72959d45db49"></a>
class&#160;</td><td class="memItemRight" valign="bottom"><b>Sequencer</b></td></tr>
<tr class="separator:a52a69080aff30f06654e72959d45db49"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae200076577c44cea683fc55b601b8fb4"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae200076577c44cea683fc55b601b8fb4"></a>
class&#160;</td><td class="memItemRight" valign="bottom"><b>Sequencer::ChannelState</b></td></tr>
<tr class="separator:ae200076577c44cea683fc55b601b8fb4"><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>Main audio playback system for a single audio output </p>
<p>Definition at line <a class="el" href="_engine_8hpp_source.html#l00023">23</a> of file <a class="el" href="_engine_8hpp_source.html">Engine.hpp</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a695432906627c5cfcb18b83487e72f92"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classamuse_1_1_audio_group.html">AudioGroup</a>* amuse::Engine::addAudioGroup </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classamuse_1_1_audio_group_data.html">AudioGroupData</a> &amp;&#160;</td>
<td class="paramname"><em>data</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Add audio group data pointers to engine; must remain resident! </p>
<p><div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="classamuse_1_1_engine_a695432906627c5cfcb18b83487e72f92_icgraph.png" border="0" usemap="#classamuse_1_1_engine_a695432906627c5cfcb18b83487e72f92_icgraph" alt=""/></div>
<map name="classamuse_1_1_engine_a695432906627c5cfcb18b83487e72f92_icgraph" id="classamuse_1_1_engine_a695432906627c5cfcb18b83487e72f92_icgraph">
<area shape="rect" id="node2" href="classamuse_1_1_engine.html#a906ba1909a00555c3396a65c518056f2" title="amuse::Engine::getBackend" alt="" coords="271,5,465,32"/>
</map>
</div>
</p>
</div>
</div>
<a class="anchor" id="ac81c9299c8ba08cfaa857d0f1c4233a3"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::shared_ptr&lt;<a class="el" href="classamuse_1_1_emitter.html">Emitter</a>&gt; amuse::Engine::addEmitter </td>
<td>(</td>
<td class="paramtype">const Vector3f &amp;&#160;</td>
<td class="paramname"><em>pos</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const Vector3f &amp;&#160;</td>
<td class="paramname"><em>dir</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float&#160;</td>
<td class="paramname"><em>maxDist</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float&#160;</td>
<td class="paramname"><em>falloff</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>sfxId</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float&#160;</td>
<td class="paramname"><em>minVol</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float&#160;</td>
<td class="paramname"><em>maxVol</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classamuse_1_1_submix.html">Submix</a> *&#160;</td>
<td class="paramname"><em>smx</em> = <code>nullptr</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Start soundFX playing from loaded audio groups, attach to positional emitter </p>
<p><div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="classamuse_1_1_engine_ac81c9299c8ba08cfaa857d0f1c4233a3_icgraph.png" border="0" usemap="#classamuse_1_1_engine_ac81c9299c8ba08cfaa857d0f1c4233a3_icgraph" alt=""/></div>
<map name="classamuse_1_1_engine_ac81c9299c8ba08cfaa857d0f1c4233a3_icgraph" id="classamuse_1_1_engine_ac81c9299c8ba08cfaa857d0f1c4233a3_icgraph">
<area shape="rect" id="node2" href="classamuse_1_1_engine.html#a906ba1909a00555c3396a65c518056f2" title="amuse::Engine::getBackend" alt="" coords="240,5,435,32"/>
</map>
</div>
</p>
</div>
</div>
<a class="anchor" id="abd19d3a4db827b2b9e65a9ae9caaac0d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classamuse_1_1_submix.html">Submix</a>* amuse::Engine::addSubmix </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classamuse_1_1_submix.html">Submix</a> *&#160;</td>
<td class="paramname"><em>parent</em> = <code>nullptr</code></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create new <a class="el" href="classamuse_1_1_submix.html">Submix</a> (a.k.a 'Studio') within root mix engine </p>
<p><div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="classamuse_1_1_engine_abd19d3a4db827b2b9e65a9ae9caaac0d_icgraph.png" border="0" usemap="#classamuse_1_1_engine_abd19d3a4db827b2b9e65a9ae9caaac0d_icgraph" alt=""/></div>
<map name="classamuse_1_1_engine_abd19d3a4db827b2b9e65a9ae9caaac0d_icgraph" id="classamuse_1_1_engine_abd19d3a4db827b2b9e65a9ae9caaac0d_icgraph">
<area shape="rect" id="node2" href="classamuse_1_1_engine.html#a906ba1909a00555c3396a65c518056f2" title="amuse::Engine::getBackend" alt="" coords="240,5,435,32"/>
</map>
</div>
</p>
</div>
</div>
<a class="anchor" id="aea32232a059d5a9d4bfa2695a0c6c1f4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::shared_ptr&lt;<a class="el" href="classamuse_1_1_voice.html">Voice</a>&gt; amuse::Engine::findVoice </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>vid</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Find voice from VoiceId </p>
<p><div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="classamuse_1_1_engine_aea32232a059d5a9d4bfa2695a0c6c1f4_icgraph.png" border="0" usemap="#classamuse_1_1_engine_aea32232a059d5a9d4bfa2695a0c6c1f4_icgraph" alt=""/></div>
<map name="classamuse_1_1_engine_aea32232a059d5a9d4bfa2695a0c6c1f4_icgraph" id="classamuse_1_1_engine_aea32232a059d5a9d4bfa2695a0c6c1f4_icgraph">
<area shape="rect" id="node2" href="classamuse_1_1_engine.html#a906ba1909a00555c3396a65c518056f2" title="amuse::Engine::getBackend" alt="" coords="231,5,425,32"/>
</map>
</div>
</p>
</div>
</div>
<a class="anchor" id="ac03ae79986617e18b4428ae038aea80c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::shared_ptr&lt;<a class="el" href="classamuse_1_1_voice.html">Voice</a>&gt; amuse::Engine::fxStart </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>sfxId</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float&#160;</td>
<td class="paramname"><em>vol</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float&#160;</td>
<td class="paramname"><em>pan</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classamuse_1_1_submix.html">Submix</a> *&#160;</td>
<td class="paramname"><em>smx</em> = <code>nullptr</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Start soundFX playing from loaded audio groups </p>
<p><div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="classamuse_1_1_engine_ac03ae79986617e18b4428ae038aea80c_icgraph.png" border="0" usemap="#classamuse_1_1_engine_ac03ae79986617e18b4428ae038aea80c_icgraph" alt=""/></div>
<map name="classamuse_1_1_engine_ac03ae79986617e18b4428ae038aea80c_icgraph" id="classamuse_1_1_engine_ac03ae79986617e18b4428ae038aea80c_icgraph">
<area shape="rect" id="node2" href="classamuse_1_1_engine.html#a906ba1909a00555c3396a65c518056f2" title="amuse::Engine::getBackend" alt="" coords="213,5,408,32"/>
</map>
</div>
</p>
</div>
</div>
<a class="anchor" id="a906ba1909a00555c3396a65c518056f2"></a>
<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="classamuse_1_1_i_backend_voice_allocator.html">IBackendVoiceAllocator</a>&amp; amuse::Engine::getBackend </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Access voice backend of engine </p>
<p>Definition at line <a class="el" href="_engine_8hpp_source.html#l00058">58</a> of file <a class="el" href="_engine_8hpp_source.html">Engine.hpp</a>.</p>
<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="classamuse_1_1_engine_a906ba1909a00555c3396a65c518056f2_cgraph.png" border="0" usemap="#classamuse_1_1_engine_a906ba1909a00555c3396a65c518056f2_cgraph" alt=""/></div>
<map name="classamuse_1_1_engine_a906ba1909a00555c3396a65c518056f2_cgraph" id="classamuse_1_1_engine_a906ba1909a00555c3396a65c518056f2_cgraph">
<area shape="rect" id="node2" href="classamuse_1_1_engine.html#a6815677808d2b00abeebacec19b5a291" title="amuse::Engine::pumpEngine" alt="" coords="258,5,455,32"/>
<area shape="rect" id="node3" href="classamuse_1_1_engine.html#a695432906627c5cfcb18b83487e72f92" title="amuse::Engine::addAudioGroup" alt="" coords="248,56,465,83"/>
<area shape="rect" id="node4" href="classamuse_1_1_engine.html#a1458ddca8cc76b93f6b71d4d62cb1d91" title="amuse::Engine::removeAudio\lGroup" alt="" coords="256,107,457,149"/>
<area shape="rect" id="node5" href="classamuse_1_1_engine.html#abd19d3a4db827b2b9e65a9ae9caaac0d" title="amuse::Engine::addSubmix" alt="" coords="263,173,450,200"/>
<area shape="rect" id="node6" href="classamuse_1_1_engine.html#a681a9c5b3c05676a36180fb27a20f68d" title="amuse::Engine::removeSubmix" alt="" coords="251,224,462,251"/>
<area shape="rect" id="node7" href="classamuse_1_1_engine.html#ac03ae79986617e18b4428ae038aea80c" title="amuse::Engine::fxStart" alt="" coords="277,275,437,301"/>
<area shape="rect" id="node8" href="classamuse_1_1_engine.html#ac81c9299c8ba08cfaa857d0f1c4233a3" title="amuse::Engine::addEmitter" alt="" coords="263,325,450,352"/>
<area shape="rect" id="node9" href="classamuse_1_1_engine.html#a82b8c2a0785a128ed59cbc404eb66a64" title="amuse::Engine::seqPlay" alt="" coords="272,376,441,403"/>
<area shape="rect" id="node10" href="classamuse_1_1_engine.html#aea32232a059d5a9d4bfa2695a0c6c1f4" title="amuse::Engine::findVoice" alt="" coords="268,427,445,453"/>
<area shape="rect" id="node11" href="classamuse_1_1_engine.html#aeb3ece0d4e5d074b4e26dc4694750e70" title="amuse::Engine::killKeygroup" alt="" coords="259,477,454,504"/>
<area shape="rect" id="node12" href="classamuse_1_1_engine.html#a9fb7f33d3ec86d257ee9b64817b39aa6" title="amuse::Engine::sendMacro\lMessage" alt="" coords="261,529,452,570"/>
</map>
</div>
</p>
</div>
</div>
<a class="anchor" id="aeb3ece0d4e5d074b4e26dc4694750e70"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void amuse::Engine::killKeygroup </td>
<td>(</td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>kg</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>now</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Stop all voices in <code>kg</code>, stops immediately (no KeyOff) when <code>now</code> set </p>
<p><div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="classamuse_1_1_engine_aeb3ece0d4e5d074b4e26dc4694750e70_icgraph.png" border="0" usemap="#classamuse_1_1_engine_aeb3ece0d4e5d074b4e26dc4694750e70_icgraph" alt=""/></div>
<map name="classamuse_1_1_engine_aeb3ece0d4e5d074b4e26dc4694750e70_icgraph" id="classamuse_1_1_engine_aeb3ece0d4e5d074b4e26dc4694750e70_icgraph">
<area shape="rect" id="node2" href="classamuse_1_1_engine.html#a906ba1909a00555c3396a65c518056f2" title="amuse::Engine::getBackend" alt="" coords="248,5,443,32"/>
</map>
</div>
</p>
</div>
</div>
<a class="anchor" id="af4fc1348b89f07b36a28ad45c84c0390"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">uint32_t amuse::Engine::nextRandom </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Obtain next random number from engine's PRNG </p>
<p>Definition at line <a class="el" href="_engine_8hpp_source.html#l00097">97</a> of file <a class="el" href="_engine_8hpp_source.html">Engine.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="a6815677808d2b00abeebacec19b5a291"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void amuse::Engine::pumpEngine </td>
<td>(</td>
<td class="paramtype">double&#160;</td>
<td class="paramname"><em>dt</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Update all active audio entities and fill OS audio buffers as needed </p>
<p><div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="classamuse_1_1_engine_a6815677808d2b00abeebacec19b5a291_icgraph.png" border="0" usemap="#classamuse_1_1_engine_a6815677808d2b00abeebacec19b5a291_icgraph" alt=""/></div>
<map name="classamuse_1_1_engine_a6815677808d2b00abeebacec19b5a291_icgraph" id="classamuse_1_1_engine_a6815677808d2b00abeebacec19b5a291_icgraph">
<area shape="rect" id="node2" href="classamuse_1_1_engine.html#a906ba1909a00555c3396a65c518056f2" title="amuse::Engine::getBackend" alt="" coords="251,5,445,32"/>
</map>
</div>
</p>
</div>
</div>
<a class="anchor" id="a1458ddca8cc76b93f6b71d4d62cb1d91"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void amuse::Engine::removeAudioGroup </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classamuse_1_1_audio_group_data.html">AudioGroupData</a> &amp;&#160;</td>
<td class="paramname"><em>data</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Remove audio group from engine </p>
<p><div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="classamuse_1_1_engine_a1458ddca8cc76b93f6b71d4d62cb1d91_icgraph.png" border="0" usemap="#classamuse_1_1_engine_a1458ddca8cc76b93f6b71d4d62cb1d91_icgraph" alt=""/></div>
<map name="classamuse_1_1_engine_a1458ddca8cc76b93f6b71d4d62cb1d91_icgraph" id="classamuse_1_1_engine_a1458ddca8cc76b93f6b71d4d62cb1d91_icgraph">
<area shape="rect" id="node2" href="classamuse_1_1_engine.html#a906ba1909a00555c3396a65c518056f2" title="amuse::Engine::getBackend" alt="" coords="255,13,449,39"/>
</map>
</div>
</p>
</div>
</div>
<a class="anchor" id="a681a9c5b3c05676a36180fb27a20f68d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void amuse::Engine::removeSubmix </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classamuse_1_1_submix.html">Submix</a> *&#160;</td>
<td class="paramname"><em>smx</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Remove <a class="el" href="classamuse_1_1_submix.html">Submix</a> and deallocate </p>
<p><div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="classamuse_1_1_engine_a681a9c5b3c05676a36180fb27a20f68d_icgraph.png" border="0" usemap="#classamuse_1_1_engine_a681a9c5b3c05676a36180fb27a20f68d_icgraph" alt=""/></div>
<map name="classamuse_1_1_engine_a681a9c5b3c05676a36180fb27a20f68d_icgraph" id="classamuse_1_1_engine_a681a9c5b3c05676a36180fb27a20f68d_icgraph">
<area shape="rect" id="node2" href="classamuse_1_1_engine.html#a906ba1909a00555c3396a65c518056f2" title="amuse::Engine::getBackend" alt="" coords="264,5,459,32"/>
</map>
</div>
</p>
</div>
</div>
<a class="anchor" id="a9fb7f33d3ec86d257ee9b64817b39aa6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void amuse::Engine::sendMacroMessage </td>
<td>(</td>
<td class="paramtype">ObjectId&#160;</td>
<td class="paramname"><em>macroId</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t&#160;</td>
<td class="paramname"><em>val</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Send all voices using <code>macroId</code> the message <code>val</code> </p>
<p><div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="classamuse_1_1_engine_a9fb7f33d3ec86d257ee9b64817b39aa6_icgraph.png" border="0" usemap="#classamuse_1_1_engine_a9fb7f33d3ec86d257ee9b64817b39aa6_icgraph" alt=""/></div>
<map name="classamuse_1_1_engine_a9fb7f33d3ec86d257ee9b64817b39aa6_icgraph" id="classamuse_1_1_engine_a9fb7f33d3ec86d257ee9b64817b39aa6_icgraph">
<area shape="rect" id="node2" href="classamuse_1_1_engine.html#a906ba1909a00555c3396a65c518056f2" title="amuse::Engine::getBackend" alt="" coords="244,13,439,39"/>
</map>
</div>
</p>
</div>
</div>
<a class="anchor" id="a82b8c2a0785a128ed59cbc404eb66a64"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::shared_ptr&lt;<a class="el" href="classamuse_1_1_sequencer.html">Sequencer</a>&gt; amuse::Engine::seqPlay </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>groupId</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>songId</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const unsigned char *&#160;</td>
<td class="paramname"><em>arrData</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classamuse_1_1_submix.html">Submix</a> *&#160;</td>
<td class="paramname"><em>smx</em> = <code>nullptr</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Start song playing from loaded audio groups </p>
<p><div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="classamuse_1_1_engine_a82b8c2a0785a128ed59cbc404eb66a64_icgraph.png" border="0" usemap="#classamuse_1_1_engine_a82b8c2a0785a128ed59cbc404eb66a64_icgraph" alt=""/></div>
<map name="classamuse_1_1_engine_a82b8c2a0785a128ed59cbc404eb66a64_icgraph" id="classamuse_1_1_engine_a82b8c2a0785a128ed59cbc404eb66a64_icgraph">
<area shape="rect" id="node2" href="classamuse_1_1_engine.html#a906ba1909a00555c3396a65c518056f2" title="amuse::Engine::getBackend" alt="" coords="223,5,417,32"/>
</map>
</div>
</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>include/amuse/<a class="el" href="_engine_8hpp_source.html">Engine.hpp</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><b>amuse</b></li><li class="navelem"><a class="el" href="classamuse_1_1_engine.html">Engine</a></li>
<li class="footer">Generated on Wed May 18 2016 20:05:19 for Amuse by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
</ul>
</div>
</body>
</html>