mirror of
https://github.com/thestk/stk
synced 2026-01-13 13:01:52 +00:00
93 lines
7.7 KiB
HTML
93 lines
7.7 KiB
HTML
<HTML>
|
|
<HEAD>
|
|
<TITLE>The Synthesis ToolKit in C++ (STK)</TITLE>
|
|
<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
|
|
</HEAD>
|
|
<BODY BGCOLOR="#FFFFFF">
|
|
<CENTER>
|
|
<img src="princeton.gif"> <img src="ccrma.gif"> <img src="mcgill.gif"><P>
|
|
<a class="qindex" href="index.html">Home</a> <a class="qindex" href="information.html">Information</a> <a class="qindex" href="classes.html">Classes</a> <a class="qindex" href="download.html">Download</a> <a class="qindex" href="usage.html">Usage</a> <a class="qindex" href="maillist.html">Mail List</a> <a class="qindex" href="system.html">Requirements</a> <a class="qindex" href="links.html">Links</a> <a class="qindex" href="tutorial.html">Tutorial</a></CENTER>
|
|
<HR>
|
|
<!-- Generated by Doxygen 1.4.4 -->
|
|
<h1>Mesh2D Class Reference</h1><!-- doxytag: class="Mesh2D" --><!-- doxytag: inherits="Instrmnt" --><code>#include <<a class="el" href="Mesh2D_8h-source.html">Mesh2D.h</a>></code>
|
|
<p>
|
|
<p>Inheritance diagram for Mesh2D:
|
|
<p><center><img src="classMesh2D.png" usemap="#Mesh2D_map" border="0" alt=""></center>
|
|
<map name="Mesh2D_map">
|
|
<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><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>
|
|
<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"></a><!-- doxytag: member="Mesh2D::Mesh2D" ref="a0" args="(short nX, short nY)" -->
|
|
</td><td class="memItemRight" valign="bottom"><a class="el" href="classMesh2D.html#a0">Mesh2D</a> (short nX, short nY)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Class constructor, taking the x and y dimensions in samples. <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a1"></a><!-- doxytag: member="Mesh2D::~Mesh2D" ref="a1" args="()" -->
|
|
</td><td class="memItemRight" valign="bottom"><a class="el" href="classMesh2D.html#a1">~Mesh2D</a> ()</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Class destructor. <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a2"></a><!-- doxytag: member="Mesh2D::clear" ref="a2" args="()" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classMesh2D.html#a2">clear</a> ()</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reset and clear all internal state. <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a3"></a><!-- doxytag: member="Mesh2D::setNX" ref="a3" args="(short lenX)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classMesh2D.html#a3">setNX</a> (short lenX)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the x dimension size in samples. <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a4"></a><!-- doxytag: member="Mesh2D::setNY" ref="a4" args="(short lenY)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classMesh2D.html#a4">setNY</a> (short lenY)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the y dimension size in samples. <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a5"></a><!-- doxytag: member="Mesh2D::setInputPosition" ref="a5" args="(StkFloat xFactor, StkFloat yFactor)" -->
|
|
void </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"> </td><td class="mdescRight">Set the x, y input position on a 0.0 - 1.0 scale. <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a6"></a><!-- doxytag: member="Mesh2D::setDecay" ref="a6" args="(StkFloat decayFactor)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classMesh2D.html#a6">setDecay</a> (StkFloat decayFactor)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the loss filters gains (0.0 - 1.0). <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a7"></a><!-- doxytag: member="Mesh2D::noteOn" ref="a7" args="(StkFloat frequency, StkFloat amplitude)" -->
|
|
void </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"> </td><td class="mdescRight">Impulse the mesh with the given amplitude (frequency ignored). <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a8"></a><!-- doxytag: member="Mesh2D::noteOff" ref="a8" args="(StkFloat amplitude)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classMesh2D.html#a8">noteOff</a> (StkFloat amplitude)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Stop a note with the given amplitude (speed of decay) ... currently ignored. <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a9"></a><!-- doxytag: member="Mesh2D::energy" ref="a9" args="()" -->
|
|
StkFloat </td><td class="memItemRight" valign="bottom"><a class="el" href="classMesh2D.html#a9">energy</a> ()</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Calculate and return the signal energy stored in the mesh. <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a10"></a><!-- doxytag: member="Mesh2D::inputTick" ref="a10" args="(StkFloat input)" -->
|
|
StkFloat </td><td class="memItemRight" valign="bottom"><a class="el" href="classMesh2D.html#a10">inputTick</a> (StkFloat input)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Input a sample to the mesh and compute one output sample. <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a11"></a><!-- doxytag: member="Mesh2D::controlChange" ref="a11" args="(int number, StkFloat value)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classMesh2D.html#a11">controlChange</a> (int number, StkFloat value)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Perform the control change specified by <em>number</em> and <em>value</em> (0.0 - 128.0). <br></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://ccrma.stanford.edu/software/stk/"><I>The Synthesis ToolKit in C++ (STK)</I></A></td></tr>
|
|
<tr><td>©1995-2005 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
|
|
</table>
|
|
|
|
</BODY>
|
|
</HTML>
|