mirror of https://github.com/AxioDL/amuse.git
176 lines
8.7 KiB
HTML
176 lines
8.7 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::Envelope 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_envelope.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-types">Public Types</a> |
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="classamuse_1_1_envelope-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">amuse::Envelope Class Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p><code>#include <<a class="el" href="_envelope_8hpp_source.html">Envelope.hpp</a>></code></p>
|
|
<div class="dynheader">
|
|
Collaboration diagram for amuse::Envelope:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="classamuse_1_1_envelope__coll__graph.png" border="0" usemap="#amuse_1_1_envelope_coll__map" alt="Collaboration graph"/></div>
|
|
<map name="amuse_1_1_envelope_coll__map" id="amuse_1_1_envelope_coll__map">
|
|
</map>
|
|
</div>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
|
|
Public Types</h2></td></tr>
|
|
<tr class="memitem:a6473d516db26b8a5ce617440fa8739d7"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6473d516db26b8a5ce617440fa8739d7"></a>enum  </td><td class="memItemRight" valign="bottom"><b>State</b> { <br />
|
|
  <b>Attack</b>,
|
|
<b>Decay</b>,
|
|
<b>Sustain</b>,
|
|
<b>Release</b>,
|
|
<br />
|
|
  <b>Complete</b>
|
|
<br />
|
|
}</td></tr>
|
|
<tr class="separator:a6473d516db26b8a5ce617440fa8739d7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><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:a5acc9dd27103145b13405f17ec53cd80"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5acc9dd27103145b13405f17ec53cd80"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>reset</b> (const <a class="el" href="structamuse_1_1_a_d_s_r.html">ADSR</a> *adsr)</td></tr>
|
|
<tr class="separator:a5acc9dd27103145b13405f17ec53cd80"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a112ccb35895d15b297527a4d7c346398"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a112ccb35895d15b297527a4d7c346398"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>reset</b> (const <a class="el" href="structamuse_1_1_a_d_s_r_d_l_s.html">ADSRDLS</a> *adsr, int8_t note, int8_t vel)</td></tr>
|
|
<tr class="separator:a112ccb35895d15b297527a4d7c346398"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a50ca95d3ee55e86a66a34d16a3109a2e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a50ca95d3ee55e86a66a34d16a3109a2e"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>keyOff</b> ()</td></tr>
|
|
<tr class="separator:a50ca95d3ee55e86a66a34d16a3109a2e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0d7eeca07b5c698874f72c07f8d50cc0"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0d7eeca07b5c698874f72c07f8d50cc0"></a>
|
|
float </td><td class="memItemRight" valign="bottom"><b>nextSample</b> (double sampleRate)</td></tr>
|
|
<tr class="separator:a0d7eeca07b5c698874f72c07f8d50cc0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6a45f94e26eec2a27cc8141fc560e187"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6a45f94e26eec2a27cc8141fc560e187"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><b>isComplete</b> () const </td></tr>
|
|
<tr class="separator:a6a45f94e26eec2a27cc8141fc560e187"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Per-sample state tracker for <a class="el" href="structamuse_1_1_a_d_s_r.html">ADSR</a> envelope data </p>
|
|
|
|
<p>Definition at line <a class="el" href="_envelope_8hpp_source.html#l00010">10</a> of file <a class="el" href="_envelope_8hpp_source.html">Envelope.hpp</a>.</p>
|
|
</div><hr/>The documentation for this class was generated from the following file:<ul>
|
|
<li>include/amuse/<a class="el" href="_envelope_8hpp_source.html">Envelope.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_envelope.html">Envelope</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>
|