mirror of https://github.com/AxioDL/amuse.git
211 lines
14 KiB
HTML
211 lines
14 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::Entity 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 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 List</span></a></li>
|
||
|
|
<li><a href="classes.html"><span>Class Index</span></a></li>
|
||
|
|
<li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
|
||
|
|
<li><a href="functions.html"><span>Class 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_entity.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> |
|
||
|
|
<a href="#pro-methods">Protected Member Functions</a> |
|
||
|
|
<a href="#pro-attribs">Protected Attributes</a> |
|
||
|
|
<a href="#friends">Friends</a> |
|
||
|
|
<a href="classamuse_1_1_entity-members.html">List of all members</a> </div>
|
||
|
|
<div class="headertitle">
|
||
|
|
<div class="title">amuse::Entity Class Reference</div> </div>
|
||
|
|
</div><!--header-->
|
||
|
|
<div class="contents">
|
||
|
|
|
||
|
|
<p><code>#include <<a class="el" href="_entity_8hpp_source.html">Entity.hpp</a>></code></p>
|
||
|
|
<div class="dynheader">
|
||
|
|
Inheritance diagram for amuse::Entity:</div>
|
||
|
|
<div class="dyncontent">
|
||
|
|
<div class="center"><img src="classamuse_1_1_entity__inherit__graph.png" border="0" usemap="#amuse_1_1_entity_inherit__map" alt="Inheritance graph"/></div>
|
||
|
|
<map name="amuse_1_1_entity_inherit__map" id="amuse_1_1_entity_inherit__map">
|
||
|
|
<area shape="rect" id="node2" href="classamuse_1_1_emitter.html" title="{amuse::Emitter\n||+ ~Emitter()\l+ Emitter()\l+ setPos()\l+ setDir()\l+ setMaxDist()\l+ setMaxVol()\l+ setMinVol()\l+ setFalloff()\l+ getVoice()\l}" alt="" coords="5,292,120,487"/>
|
||
|
|
<area shape="rect" id="node3" href="classamuse_1_1_listener.html" title="{amuse::Listener\n||}" alt="" coords="144,351,264,428"/>
|
||
|
|
<area shape="rect" id="node4" href="classamuse_1_1_sequencer.html" title="{amuse::Sequencer\n||+ ~Sequencer()\l+ Sequencer()\l+ advance()\l+ getSubmix()\l+ state()\l+ getVoiceCount()\l+ keyOn()\l+ keyOff()\l+ setCtrlValue()\l+ setPitchWheel()\land 12 more...\l}" alt="" coords="289,277,426,501"/>
|
||
|
|
<area shape="rect" id="node5" href="classamuse_1_1_voice.html" title="{amuse::Voice\n||+ ~Voice()\l+ Voice()\l+ Voice()\l+ supplyAudio()\l+ getSubmix()\l+ state()\l+ vid()\l+ maxVid()\l+ startChildMacro()\l+ loadSoundObject()\land 38 more...\l}" alt="" coords="451,277,603,501"/>
|
||
|
|
</map>
|
||
|
|
</div>
|
||
|
|
<div class="dynheader">
|
||
|
|
Collaboration diagram for amuse::Entity:</div>
|
||
|
|
<div class="dyncontent">
|
||
|
|
<div class="center"><img src="classamuse_1_1_entity__coll__graph.png" border="0" usemap="#amuse_1_1_entity_coll__map" alt="Collaboration graph"/></div>
|
||
|
|
<map name="amuse_1_1_entity_coll__map" id="amuse_1_1_entity_coll__map">
|
||
|
|
<area shape="rect" id="node2" href="classamuse_1_1_audio_group.html" title="{amuse::AudioGroup\n||+ operator bool()\l+ AudioGroup()\l+ getSample()\l+ getSampleData()\l+ getProj()\l+ getPool()\l}" alt="" coords="5,71,148,222"/>
|
||
|
|
<area shape="rect" id="node3" href="classamuse_1_1_engine.html" title="{amuse::Engine\n||+ ~Engine()\l+ Engine()\l+ getBackend()\l+ pumpEngine()\l+ addAudioGroup()\l+ removeAudioGroup()\l+ addSubmix()\l+ removeSubmix()\l+ fxStart()\l+ addEmitter()\l+ seqPlay()\l+ findVoice()\l+ killKeygroup()\l+ sendMacroMessage()\l+ nextRandom()\l}" alt="" coords="172,5,347,288"/>
|
||
|
|
</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:a47a992c8b6652668c5dd950408988070"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a47a992c8b6652668c5dd950408988070"></a>
|
||
|
|
 </td><td class="memItemRight" valign="bottom"><b>Entity</b> (<a class="el" href="classamuse_1_1_engine.html">Engine</a> &engine, const <a class="el" href="classamuse_1_1_audio_group.html">AudioGroup</a> &group, int groupId, ObjectId oid=ObjectId())</td></tr>
|
||
|
|
<tr class="separator:a47a992c8b6652668c5dd950408988070"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a7a80d0bba104fea407a0f0369bf8615c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7a80d0bba104fea407a0f0369bf8615c"></a>
|
||
|
|
<a class="el" href="classamuse_1_1_engine.html">Engine</a> & </td><td class="memItemRight" valign="bottom"><b>getEngine</b> ()</td></tr>
|
||
|
|
<tr class="separator:a7a80d0bba104fea407a0f0369bf8615c"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a2b495ce425cca1cec48a4d998f65e369"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2b495ce425cca1cec48a4d998f65e369"></a>
|
||
|
|
const <a class="el" href="classamuse_1_1_audio_group.html">AudioGroup</a> & </td><td class="memItemRight" valign="bottom"><b>getAudioGroup</b> () const </td></tr>
|
||
|
|
<tr class="separator:a2b495ce425cca1cec48a4d998f65e369"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a56322c8946faee72551194459233f46b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a56322c8946faee72551194459233f46b"></a>
|
||
|
|
int </td><td class="memItemRight" valign="bottom"><b>getGroupId</b> () const </td></tr>
|
||
|
|
<tr class="separator:a56322c8946faee72551194459233f46b"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:aa992a4b2d56f6345b20820ade0a0bc8e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa992a4b2d56f6345b20820ade0a0bc8e"></a>
|
||
|
|
ObjectId </td><td class="memItemRight" valign="bottom"><b>getObjectId</b> () const </td></tr>
|
||
|
|
<tr class="separator:aa992a4b2d56f6345b20820ade0a0bc8e"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
</table><table class="memberdecls">
|
||
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
|
||
|
|
Protected Member Functions</h2></td></tr>
|
||
|
|
<tr class="memitem:a6128f61bb44144f9f3fab353b90bf6f2"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6128f61bb44144f9f3fab353b90bf6f2"></a>
|
||
|
|
void </td><td class="memItemRight" valign="bottom"><b>_destroy</b> ()</td></tr>
|
||
|
|
<tr class="separator:a6128f61bb44144f9f3fab353b90bf6f2"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
</table><table class="memberdecls">
|
||
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
|
||
|
|
Protected Attributes</h2></td></tr>
|
||
|
|
<tr class="memitem:a8daa80960e618e3553f2092051c44ebe"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8daa80960e618e3553f2092051c44ebe"></a>
|
||
|
|
bool </td><td class="memItemRight" valign="bottom"><b>m_destroyed</b> = false</td></tr>
|
||
|
|
<tr class="separator:a8daa80960e618e3553f2092051c44ebe"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a1382e56f563ec3fc772b3fc027e02b0c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1382e56f563ec3fc772b3fc027e02b0c"></a>
|
||
|
|
<a class="el" href="classamuse_1_1_engine.html">Engine</a> & </td><td class="memItemRight" valign="bottom"><b>m_engine</b></td></tr>
|
||
|
|
<tr class="separator:a1382e56f563ec3fc772b3fc027e02b0c"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:aa71a4031b665176c49cebf9f5ccf7d6f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa71a4031b665176c49cebf9f5ccf7d6f"></a>
|
||
|
|
const <a class="el" href="classamuse_1_1_audio_group.html">AudioGroup</a> & </td><td class="memItemRight" valign="bottom"><b>m_audioGroup</b></td></tr>
|
||
|
|
<tr class="separator:aa71a4031b665176c49cebf9f5ccf7d6f"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a62c7f163ca10b1e68bdadbab5156537b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a62c7f163ca10b1e68bdadbab5156537b"></a>
|
||
|
|
int </td><td class="memItemRight" valign="bottom"><b>m_groupId</b></td></tr>
|
||
|
|
<tr class="separator:a62c7f163ca10b1e68bdadbab5156537b"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a0359d16c7e02c42002b0eb3f40a8ec3b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0359d16c7e02c42002b0eb3f40a8ec3b"></a>
|
||
|
|
ObjectId </td><td class="memItemRight" valign="bottom"><b>m_objectId</b> = 0xffff</td></tr>
|
||
|
|
<tr class="separator:a0359d16c7e02c42002b0eb3f40a8ec3b"><td class="memSeparator" colspan="2"> </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:a3e1914489e4bed4f9f23cdeab34a43dc"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3e1914489e4bed4f9f23cdeab34a43dc"></a>
|
||
|
|
class </td><td class="memItemRight" valign="bottom"><b>Engine</b></td></tr>
|
||
|
|
<tr class="separator:a3e1914489e4bed4f9f23cdeab34a43dc"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a7e534c4c56668d740c959235bc8ed4ec"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7e534c4c56668d740c959235bc8ed4ec"></a>
|
||
|
|
class </td><td class="memItemRight" valign="bottom"><b>SoundMacroState</b></td></tr>
|
||
|
|
<tr class="separator:a7e534c4c56668d740c959235bc8ed4ec"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
</table>
|
||
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
||
|
|
<div class="textblock"><p>Common 'engine child' class </p>
|
||
|
|
|
||
|
|
<p>Definition at line <a class="el" href="_entity_8hpp_source.html#l00018">18</a> of file <a class="el" href="_entity_8hpp_source.html">Entity.hpp</a>.</p>
|
||
|
|
</div><hr/>The documentation for this class was generated from the following file:<ul>
|
||
|
|
<li>include/amuse/<a class="el" href="_entity_8hpp_source.html">Entity.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_entity.html">Entity</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>
|