amuse/classamuse_1_1_effect_rever...

210 lines
17 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::EffectReverbStdImp&lt; T &gt; Class Template 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_effect_reverb_std_imp.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="classamuse_1_1_effect_reverb_std_imp-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">amuse::EffectReverbStdImp&lt; T &gt; Class Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="_effect_reverb_8hpp_source.html">EffectReverb.hpp</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for amuse::EffectReverbStdImp&lt; T &gt;:</div>
<div class="dyncontent">
<div class="center"><img src="classamuse_1_1_effect_reverb_std_imp__inherit__graph.png" border="0" usemap="#amuse_1_1_effect_reverb_std_imp_3_01_t_01_4_inherit__map" alt="Inheritance graph"/></div>
<map name="amuse_1_1_effect_reverb_std_imp_3_01_t_01_4_inherit__map" id="amuse_1_1_effect_reverb_std_imp_3_01_t_01_4_inherit__map">
<area shape="rect" id="node2" href="classamuse_1_1_effect_base.html" title="{amuse::EffectBase\&lt; T \&gt;\n||+ applyEffect()\l}" alt="" coords="17,204,188,281"/>
<area shape="rect" id="node3" href="classamuse_1_1_effect_base_typeless.html" title="{amuse::EffectBaseTypeless\n||+ ~EffectBaseTypeless()\l}" alt="" coords="5,5,200,83"/>
<area shape="rect" id="node4" href="classamuse_1_1_effect_reverb_std.html" title="{amuse::EffectReverbStd\n|# x140_x1c8_coloration\l# x144_x1cc_mix\l# x148_x1d0_time\l# x14c_x1d4_damping\l# x150_x1d8_preDelay\l# m_dirty\l|+ setColoration()\l+ setMix()\l+ setTime()\l+ setDamping()\l+ setPreDelay()\l# EffectReverbStd()\l}" alt="" coords="212,131,385,355"/>
</map>
</div>
<div class="dynheader">
Collaboration diagram for amuse::EffectReverbStdImp&lt; T &gt;:</div>
<div class="dyncontent">
<div class="center"><img src="classamuse_1_1_effect_reverb_std_imp__coll__graph.png" border="0" usemap="#amuse_1_1_effect_reverb_std_imp_3_01_t_01_4_coll__map" alt="Collaboration graph"/></div>
<map name="amuse_1_1_effect_reverb_std_imp_3_01_t_01_4_coll__map" id="amuse_1_1_effect_reverb_std_imp_3_01_t_01_4_coll__map">
<area shape="rect" id="node2" href="classamuse_1_1_effect_base.html" title="{amuse::EffectBase\&lt; T \&gt;\n||+ applyEffect()\l}" alt="" coords="17,204,188,281"/>
<area shape="rect" id="node3" href="classamuse_1_1_effect_base_typeless.html" title="{amuse::EffectBaseTypeless\n||+ ~EffectBaseTypeless()\l}" alt="" coords="5,5,200,83"/>
<area shape="rect" id="node4" href="classamuse_1_1_effect_reverb_std.html" title="{amuse::EffectReverbStd\n|# x140_x1c8_coloration\l# x144_x1cc_mix\l# x148_x1d0_time\l# x14c_x1d4_damping\l# x150_x1d8_preDelay\l# m_dirty\l|+ setColoration()\l+ setMix()\l+ setTime()\l+ setDamping()\l+ setPreDelay()\l# EffectReverbStd()\l}" alt="" coords="212,131,385,355"/>
</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:a64293815b146a418b1e54b60b8b6dca2"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a64293815b146a418b1e54b60b8b6dca2"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>EffectReverbStdImp</b> (float coloration, float mix, float time, float damping, float preDelay, double sampleRate)</td></tr>
<tr class="separator:a64293815b146a418b1e54b60b8b6dca2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9ad95039903e5adf44cf5c7c4e3cea0e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9ad95039903e5adf44cf5c7c4e3cea0e"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>applyEffect</b> (T *audio, size_t frameCount, const <a class="el" href="structamuse_1_1_channel_map.html">ChannelMap</a> &amp;chanMap)</td></tr>
<tr class="separator:a9ad95039903e5adf44cf5c7c4e3cea0e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classamuse_1_1_effect_reverb_std"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classamuse_1_1_effect_reverb_std')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classamuse_1_1_effect_reverb_std.html">amuse::EffectReverbStd</a></td></tr>
<tr class="memitem:a73ed0393b915cbe182fbaeba3e5172b5 inherit pub_methods_classamuse_1_1_effect_reverb_std"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a73ed0393b915cbe182fbaeba3e5172b5"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>setColoration</b> (float coloration)</td></tr>
<tr class="separator:a73ed0393b915cbe182fbaeba3e5172b5 inherit pub_methods_classamuse_1_1_effect_reverb_std"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a637a8deb6c4ca56d9c801490a79c51fa inherit pub_methods_classamuse_1_1_effect_reverb_std"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a637a8deb6c4ca56d9c801490a79c51fa"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>setMix</b> (float mix)</td></tr>
<tr class="separator:a637a8deb6c4ca56d9c801490a79c51fa inherit pub_methods_classamuse_1_1_effect_reverb_std"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aca76c6fb1bea207ed768a218f1434016 inherit pub_methods_classamuse_1_1_effect_reverb_std"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aca76c6fb1bea207ed768a218f1434016"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>setTime</b> (float time)</td></tr>
<tr class="separator:aca76c6fb1bea207ed768a218f1434016 inherit pub_methods_classamuse_1_1_effect_reverb_std"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5507418919eafd8641e2f9f46cfc3553 inherit pub_methods_classamuse_1_1_effect_reverb_std"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5507418919eafd8641e2f9f46cfc3553"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>setDamping</b> (float damping)</td></tr>
<tr class="separator:a5507418919eafd8641e2f9f46cfc3553 inherit pub_methods_classamuse_1_1_effect_reverb_std"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a45d3d4d5a63ef00cb602dc24be2409b8 inherit pub_methods_classamuse_1_1_effect_reverb_std"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a45d3d4d5a63ef00cb602dc24be2409b8"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>setPreDelay</b> (float preDelay)</td></tr>
<tr class="separator:a45d3d4d5a63ef00cb602dc24be2409b8 inherit pub_methods_classamuse_1_1_effect_reverb_std"><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 pub_types_classamuse_1_1_effect_reverb_std"><td colspan="2" onclick="javascript:toggleInherit('pub_types_classamuse_1_1_effect_reverb_std')"><img src="closed.png" alt="-"/>&#160;Public Types inherited from <a class="el" href="classamuse_1_1_effect_reverb_std.html">amuse::EffectReverbStd</a></td></tr>
<tr class="memitem:a4c328bf72fe6e68f508efabb2bcbea5b inherit pub_types_classamuse_1_1_effect_reverb_std"><td class="memTemplParams" colspan="2"><a class="anchor" id="a4c328bf72fe6e68f508efabb2bcbea5b"></a>
template&lt;typename T &gt; </td></tr>
<tr class="memitem:a4c328bf72fe6e68f508efabb2bcbea5b inherit pub_types_classamuse_1_1_effect_reverb_std"><td class="memTemplItemLeft" align="right" valign="top">using&#160;</td><td class="memTemplItemRight" valign="bottom"><b>ImpType</b> = <a class="el" href="classamuse_1_1_effect_reverb_std_imp.html">EffectReverbStdImp</a>&lt; T &gt;</td></tr>
<tr class="separator:a4c328bf72fe6e68f508efabb2bcbea5b inherit pub_types_classamuse_1_1_effect_reverb_std"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pro_methods_classamuse_1_1_effect_reverb_std"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classamuse_1_1_effect_reverb_std')"><img src="closed.png" alt="-"/>&#160;Protected Member Functions inherited from <a class="el" href="classamuse_1_1_effect_reverb_std.html">amuse::EffectReverbStd</a></td></tr>
<tr class="memitem:a6231d37f009c1dad8e3565956ad85c02 inherit pro_methods_classamuse_1_1_effect_reverb_std"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6231d37f009c1dad8e3565956ad85c02"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>EffectReverbStd</b> (float coloration, float mix, float time, float damping, float preDelay)</td></tr>
<tr class="separator:a6231d37f009c1dad8e3565956ad85c02 inherit pro_methods_classamuse_1_1_effect_reverb_std"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pro_attribs_classamuse_1_1_effect_reverb_std"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_classamuse_1_1_effect_reverb_std')"><img src="closed.png" alt="-"/>&#160;Protected Attributes inherited from <a class="el" href="classamuse_1_1_effect_reverb_std.html">amuse::EffectReverbStd</a></td></tr>
<tr class="memitem:a3db6110d680e34ddb85d537d96de44cf inherit pro_attribs_classamuse_1_1_effect_reverb_std"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classamuse_1_1_effect_reverb_std.html#a3db6110d680e34ddb85d537d96de44cf">x140_x1c8_coloration</a></td></tr>
<tr class="separator:a3db6110d680e34ddb85d537d96de44cf inherit pro_attribs_classamuse_1_1_effect_reverb_std"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0b3713683469fa19b9caf9b34ca19c1c inherit pro_attribs_classamuse_1_1_effect_reverb_std"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classamuse_1_1_effect_reverb_std.html#a0b3713683469fa19b9caf9b34ca19c1c">x144_x1cc_mix</a></td></tr>
<tr class="separator:a0b3713683469fa19b9caf9b34ca19c1c inherit pro_attribs_classamuse_1_1_effect_reverb_std"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac6696cd6a34cd6ec4071a571a755dd34 inherit pro_attribs_classamuse_1_1_effect_reverb_std"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classamuse_1_1_effect_reverb_std.html#ac6696cd6a34cd6ec4071a571a755dd34">x148_x1d0_time</a></td></tr>
<tr class="separator:ac6696cd6a34cd6ec4071a571a755dd34 inherit pro_attribs_classamuse_1_1_effect_reverb_std"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a33c4e8523dfeed17690ebc303888eeed inherit pro_attribs_classamuse_1_1_effect_reverb_std"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classamuse_1_1_effect_reverb_std.html#a33c4e8523dfeed17690ebc303888eeed">x14c_x1d4_damping</a></td></tr>
<tr class="separator:a33c4e8523dfeed17690ebc303888eeed inherit pro_attribs_classamuse_1_1_effect_reverb_std"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a206bb6f4c31b532998f7acb14987603b inherit pro_attribs_classamuse_1_1_effect_reverb_std"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classamuse_1_1_effect_reverb_std.html#a206bb6f4c31b532998f7acb14987603b">x150_x1d8_preDelay</a></td></tr>
<tr class="separator:a206bb6f4c31b532998f7acb14987603b inherit pro_attribs_classamuse_1_1_effect_reverb_std"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a82c5d2e55f794320825076eb27e63c25 inherit pro_attribs_classamuse_1_1_effect_reverb_std"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classamuse_1_1_effect_reverb_std.html#a82c5d2e55f794320825076eb27e63c25">m_dirty</a> = true</td></tr>
<tr class="separator:a82c5d2e55f794320825076eb27e63c25 inherit pro_attribs_classamuse_1_1_effect_reverb_std"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template&lt;typename T&gt;<br />
class amuse::EffectReverbStdImp&lt; T &gt;</h3>
<p>Standard-quality 2-stage reverb </p>
<p>Definition at line <a class="el" href="_effect_reverb_8hpp_source.html#l00025">25</a> of file <a class="el" href="_effect_reverb_8hpp_source.html">EffectReverb.hpp</a>.</p>
</div><hr/>The documentation for this class was generated from the following file:<ul>
<li>include/amuse/<a class="el" href="_effect_reverb_8hpp_source.html">EffectReverb.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_effect_reverb_std_imp.html">EffectReverbStdImp</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>