e1lama/stk
1
0
Fork 0
mirror of https://github.com/thestk/stk synced 2026-01-14 21:41:53 +00:00
Code Issues Packages Projects Releases Wiki Activity

Release 4.2.0 tarball

Browse Source
This commit is contained in:
Gary Scavone
2013-09-29 23:39:37 +02:00
committed by Stephen Sinclair
parent fe20fe92a2
commit de344668dd
347 changed files with 16972 additions and 8538 deletions
Download Patch File Download Diff File Expand all files Collapse all files

99
doc/html/classMesh2D.html
View File

@@ -9,10 +9,7 @@
<a class="qindex" href="index.html">Home</a> &nbsp; <a class="qindex" href="information.html">Information</a> &nbsp; <a class="qindex" href="classes.html">Classes</a> &nbsp; <a class="qindex" href="download.html">Download</a> &nbsp; <a class="qindex" href="usage.html">Usage</a> &nbsp; <a class="qindex" href="maillist.html">Mail List</a> &nbsp; <a class="qindex" href="system.html">Requirements</a> &nbsp; <a class="qindex" href="links.html">Links</a> &nbsp; <a class="qindex" href="tutorial.html">Tutorial</a></CENTER>
<HR>
<!-- Generated by Doxygen 1.3.4 -->
<h1>Mesh2D Class Reference</h1>Two-dimensional rectilinear waveguide mesh class.
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="Mesh2D_8h-source.html">Mesh2D.h</a>&gt;</code>
<h1>Mesh2D Class Reference</h1><code>#include &lt;<a class="el" href="Mesh2D_8h-source.html">Mesh2D.h</a>&gt;</code>
<p>
<p>Inheritance diagram for Mesh2D:
<p><center><img src="classMesh2D.png" usemap="#Mesh2D_map" border="0" alt=""></center>
@@ -20,7 +17,19 @@
<area href="classInstrmnt.html" alt="Instrmnt" shape="rect" coords="0,56,59,80">
<area href="classStk.html" alt="Stk" shape="rect" coords="0,0,59,24">
</map>
<a href="classMesh2D-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
<a href="classMesh2D-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
Two-dimensional rectilinear waveguide mesh class.
<p>
This class implements a rectilinear, two-dimensional digital waveguide mesh structure. For details, see Van Duyne and Smith, "Physical Modeling with the 2-D Digital Waveguide Mesh", Proceedings of the 1993 International Computer Music Conference.<p>
This is a digital waveguide model, making its use possibly subject to patents held by Stanford University, Yamaha, and others.<p>
Control Change Numbers:<ul>
<li>X Dimension = 2</li><li>Y Dimension = 4</li><li>Mesh Decay = 11</li><li>X-Y Input Position = 1</li></ul>
<p>
by Julius Smith, 2000 - 2002. Revised by Gary Scavone for STK, 2002.
<p>
<p>
Definition at line <a class="el" href="Mesh2D_8h-source.html#l00036">36</a> of file <a class="el" href="Mesh2D_8h-source.html">Mesh2D.h</a>.<table border=0 cellpadding=0 cellspacing=0>
<tr><td></td></tr>
<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a0" doxytag="Mesh2D::Mesh2D" ></a>
@@ -44,56 +53,94 @@ void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classM
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the y dimension size in samples. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a5" doxytag="Mesh2D::setInputPosition" ></a>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classMesh2D.html#a5">setInputPosition</a> (MY_FLOAT xFactor, MY_FLOAT yFactor)</td></tr>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classMesh2D.html#a5">setInputPosition</a> (StkFloat xFactor, StkFloat yFactor)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the x, y input position on a 0.0 - 1.0 scale. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a6" doxytag="Mesh2D::setDecay" ></a>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classMesh2D.html#a6">setDecay</a> (MY_FLOAT decayFactor)</td></tr>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classMesh2D.html#a6">setDecay</a> (StkFloat decayFactor)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the loss filters gains (0.0 - 1.0). <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a7" doxytag="Mesh2D::noteOn" ></a>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classMesh2D.html#a7">noteOn</a> (MY_FLOAT frequency, MY_FLOAT amplitude)</td></tr>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classMesh2D.html#a7">noteOn</a> (StkFloat frequency, StkFloat amplitude)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Impulse the mesh with the given amplitude (frequency ignored). <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a8" doxytag="Mesh2D::noteOff" ></a>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classMesh2D.html#a8">noteOff</a> (MY_FLOAT amplitude)</td></tr>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classMesh2D.html#a8">noteOff</a> (StkFloat amplitude)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Stop a note with the given amplitude (speed of decay) ... currently ignored. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a9" doxytag="Mesh2D::energy" ></a>
MY_FLOAT&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classMesh2D.html#a9">energy</a> ()</td></tr>
StkFloat&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classMesh2D.html#a9">energy</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Calculate and return the signal energy stored in the mesh. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a10" doxytag="Mesh2D::tick" ></a>
MY_FLOAT&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classMesh2D.html#a10">tick</a> ()</td></tr>
StkFloat&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classMesh2D.html#a10">tick</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Compute one output sample, without adding energy to the mesh. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a11" doxytag="Mesh2D::tick" ></a>
MY_FLOAT&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classMesh2D.html#a11">tick</a> (MY_FLOAT input)</td></tr>
StkFloat&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classMesh2D.html#a11">tick</a> (StkFloat input)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Input a sample to the mesh and compute one output sample. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a12" doxytag="Mesh2D::controlChange" ></a>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classMesh2D.html#a12">controlChange</a> (int number, MY_FLOAT value)</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a12" doxytag="Mesh2D::tick" ></a>
StkFloat *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classMesh2D.html#a12">tick</a> (StkFloat *vector, unsigned int vectorSize)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Computer <em>vectorSize</em> outputs and return them in <em>vector</em>. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classStkFrames.html">StkFrames</a> &amp;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classMesh2D.html#a13">tick</a> (<a class="el" href="classStkFrames.html">StkFrames</a> &amp;frames, unsigned int channel=1)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Fill a channel of the <a class="el" href="classStkFrames.html">StkFrames</a> object with computed outputs. </em> <a href="#a13"></a><em><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a14" doxytag="Mesh2D::controlChange" ></a>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classMesh2D.html#a14">controlChange</a> (int number, StkFloat value)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Perform the control change specified by <em>number</em> and <em>value</em> (0.0 - 128.0). <br><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Two-dimensional rectilinear waveguide mesh class.
<p>
This class implements a rectilinear, two-dimensional digital waveguide mesh structure. For details, see Van Duyne and Smith, "Physical Modeling with the 2-D Digital Waveguide Mesh", Proceedings of the 1993 International Computer Music Conference.<p>
This is a digital waveguide model, making its use possibly subject to patents held by Stanford University, Yamaha, and others.<p>
Control Change Numbers:<ul>
<li>X Dimension = 2</li><li>Y Dimension = 4</li><li>Mesh Decay = 11</li><li>X-Y Input Position = 1</li></ul>
<p>
by Julius Smith, 2000 - 2002. Revised by Gary Scavone for STK, 2002.
<p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="a13" doxytag="Mesh2D::tick" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="classStkFrames.html">StkFrames</a>&amp; Mesh2D::tick </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top"><a class="el" href="classStkFrames.html">StkFrames</a> &amp;&nbsp;</td>
<td class="mdname" nowrap> <em>frames</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>unsigned int&nbsp;</td>
<td class="mdname" nowrap> <em>channel</em> = 1</td>
</tr>
<tr>
<td></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"><code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Definition at line <a class="el" href="Mesh2D_8h-source.html#l00036">36</a> of file <a class="el" href="Mesh2D_8h-source.html">Mesh2D.h</a>.<hr>The documentation for this class was generated from the following file:<ul>
Fill a channel of the <a class="el" href="classStkFrames.html">StkFrames</a> object with computed outputs.
<p>
The <code>channel</code> argument should be one or greater (the first channel is specified by 1). An <a class="el" href="classStkError.html">StkError</a> will be thrown if the <code>channel</code> argument is zero or it is greater than the number of channels in the <a class="el" href="classStkFrames.html">StkFrames</a> object.
<p>
Reimplemented from <a class="el" href="classInstrmnt.html#a10">Instrmnt</a>. </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="Mesh2D_8h-source.html">Mesh2D.h</a></ul>
<HR>
<table>
<tr><td><A HREF="http://www-ccrma.stanford.edu/software/stk/"><I>The Synthesis ToolKit in C++ (STK)</I></A></td></tr>
<tr><td><A HREF="http://ccrma.stanford.edu/software/stk/"><I>The Synthesis ToolKit in C++ (STK)</I></A></td></tr>
<tr><td>&copy;1995-2004 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
</table>