amuse/classamuse_1_1_effect_rever...

<!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::EffectReverbStd 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_effect_reverb_std.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> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="#friends">Friends</a> &#124;
<a href="classamuse_1_1_effect_reverb_std-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">amuse::EffectReverbStd Class 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::EffectReverbStd:</div>
<div class="dyncontent">
<div class="center"><img src="classamuse_1_1_effect_reverb_std__inherit__graph.png" border="0" usemap="#amuse_1_1_effect_reverb_std_inherit__map" alt="Inheritance graph"/></div>
<map name="amuse_1_1_effect_reverb_std_inherit__map" id="amuse_1_1_effect_reverb_std_inherit__map">
<area shape="rect" id="node2" href="classamuse_1_1_effect_reverb_hi.html" title="{amuse::EffectReverbHi\n||+ setCrosstalk()\l}" alt="" coords="33,285,196,362"/>
<area shape="rect" id="node4" href="classamuse_1_1_effect_reverb_std_imp.html" title="{amuse::EffectReverbStdImp\&lt; T \&gt;\n||+ EffectReverbStdImp()\l+ applyEffect()\l}" alt="" coords="220,277,447,369"/>
<area shape="rect" id="node3" href="classamuse_1_1_effect_reverb_hi_imp.html" title="{amuse::EffectReverbHiImp\&lt; T \&gt;\n||+ EffectReverbHiImp()\l+ applyEffect()\l}" alt="" coords="5,417,224,509"/>
</map>
</div>
<div class="dynheader">
Collaboration diagram for amuse::EffectReverbStd:</div>
<div class="dyncontent">
<div class="center"><img src="classamuse_1_1_effect_reverb_std__coll__graph.png" border="0" usemap="#amuse_1_1_effect_reverb_std_coll__map" alt="Collaboration graph"/></div>
<map name="amuse_1_1_effect_reverb_std_coll__map" id="amuse_1_1_effect_reverb_std_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:a4c328bf72fe6e68f508efabb2bcbea5b"><td class="memTemplParams" colspan="2"><a class="anchor" id="a4c328bf72fe6e68f508efabb2bcbea5b"></a>
template&lt;typename T &gt; </td></tr>
<tr class="memitem:a4c328bf72fe6e68f508efabb2bcbea5b"><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"><td class="memSeparator" colspan="2">&#160;</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:a73ed0393b915cbe182fbaeba3e5172b5"><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"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a637a8deb6c4ca56d9c801490a79c51fa"><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"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aca76c6fb1bea207ed768a218f1434016"><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"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5507418919eafd8641e2f9f46cfc3553"><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"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a45d3d4d5a63ef00cb602dc24be2409b8"><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"><td class="memSeparator" colspan="2">&#160;</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:a6231d37f009c1dad8e3565956ad85c02"><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"><td class="memSeparator" colspan="2">&#160;</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:a3db6110d680e34ddb85d537d96de44cf"><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"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0b3713683469fa19b9caf9b34ca19c1c"><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"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac6696cd6a34cd6ec4071a571a755dd34"><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"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a33c4e8523dfeed17690ebc303888eeed"><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"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a206bb6f4c31b532998f7acb14987603b"><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"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a82c5d2e55f794320825076eb27e63c25"><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"><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:abd028a09442070359b8ff29c2aa54862"><td class="memTemplParams" colspan="2"><a class="anchor" id="abd028a09442070359b8ff29c2aa54862"></a>
template&lt;typename T &gt; </td></tr>
<tr class="memitem:abd028a09442070359b8ff29c2aa54862"><td class="memTemplItemLeft" align="right" valign="top">class&#160;</td><td class="memTemplItemRight" valign="bottom"><b>EffectReverbStdImp</b></td></tr>
<tr class="separator:abd028a09442070359b8ff29c2aa54862"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a95f0935fd7ce15f31ad59e3de5d1c590"><td class="memTemplParams" colspan="2"><a class="anchor" id="a95f0935fd7ce15f31ad59e3de5d1c590"></a>
template&lt;typename T &gt; </td></tr>
<tr class="memitem:a95f0935fd7ce15f31ad59e3de5d1c590"><td class="memTemplItemLeft" align="right" valign="top">class&#160;</td><td class="memTemplItemRight" valign="bottom"><b>EffectReverbHiImp</b></td></tr>
<tr class="separator:a95f0935fd7ce15f31ad59e3de5d1c590"><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>Reverb effect with configurable reflection filtering </p>

<p>Definition at line <a class="el" href="_effect_reverb_8hpp_source.html#l00031">31</a> of file <a class="el" href="_effect_reverb_8hpp_source.html">EffectReverb.hpp</a>.</p>
</div><h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="a82c5d2e55f794320825076eb27e63c25"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool amuse::EffectReverbStd::m_dirty = true</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>needs update of internal parameter data </p>

<p>Definition at line <a class="el" href="_effect_reverb_8hpp_source.html#l00039">39</a> of file <a class="el" href="_effect_reverb_8hpp_source.html">EffectReverb.hpp</a>.</p>

</div>
</div>
<a class="anchor" id="a3db6110d680e34ddb85d537d96de44cf"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">float amuse::EffectReverbStd::x140_x1c8_coloration</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>[0.0, 1.0] influences filter coefficients to define surface characteristics of a room </p>

<p>Definition at line <a class="el" href="_effect_reverb_8hpp_source.html#l00034">34</a> of file <a class="el" href="_effect_reverb_8hpp_source.html">EffectReverb.hpp</a>.</p>

</div>
</div>
<a class="anchor" id="a0b3713683469fa19b9caf9b34ca19c1c"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">float amuse::EffectReverbStd::x144_x1cc_mix</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>[0.0, 1.0] dry/wet mix factor of reverb effect </p>

<p>Definition at line <a class="el" href="_effect_reverb_8hpp_source.html#l00035">35</a> of file <a class="el" href="_effect_reverb_8hpp_source.html">EffectReverb.hpp</a>.</p>

</div>
</div>
<a class="anchor" id="ac6696cd6a34cd6ec4071a571a755dd34"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">float amuse::EffectReverbStd::x148_x1d0_time</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>[0.01, 10.0] time in seconds for reflection decay </p>

<p>Definition at line <a class="el" href="_effect_reverb_8hpp_source.html#l00036">36</a> of file <a class="el" href="_effect_reverb_8hpp_source.html">EffectReverb.hpp</a>.</p>

</div>
</div>
<a class="anchor" id="a33c4e8523dfeed17690ebc303888eeed"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">float amuse::EffectReverbStd::x14c_x1d4_damping</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>[0.0, 1.0] damping factor influencing low-pass filter of reflections </p>

<p>Definition at line <a class="el" href="_effect_reverb_8hpp_source.html#l00037">37</a> of file <a class="el" href="_effect_reverb_8hpp_source.html">EffectReverb.hpp</a>.</p>

</div>
</div>
<a class="anchor" id="a206bb6f4c31b532998f7acb14987603b"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">float amuse::EffectReverbStd::x150_x1d8_preDelay</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>[0.0, 0.1] time in seconds before initial reflection heard </p>

<p>Definition at line <a class="el" href="_effect_reverb_8hpp_source.html#l00038">38</a> of file <a class="el" href="_effect_reverb_8hpp_source.html">EffectReverb.hpp</a>.</p>

</div>
</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.html">EffectReverbStd</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>