mirror of
https://github.com/thestk/stk
synced 2026-01-14 13:31:53 +00:00
108 lines
9.9 KiB
HTML
108 lines
9.9 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="faq.html">FAQ</a> <a class="qindex" href="tutorial.html">Tutorial</a></CENTER>
|
|
<HR>
|
|
<!-- Generated by Doxygen 1.5.8 -->
|
|
<div class="navpath"><a class="el" href="namespacestk.html">stk</a>::<a class="el" href="classstk_1_1Mesh2D.html">Mesh2D</a>
|
|
</div>
|
|
<div class="contents">
|
|
<h1>stk::Mesh2D Class Reference</h1><!-- doxytag: class="stk::Mesh2D" --><!-- doxytag: inherits="stk::Instrmnt" -->Two-dimensional rectilinear waveguide mesh class.
|
|
<a href="#_details">More...</a>
|
|
<p>
|
|
<code>#include <<a class="el" href="Mesh2D_8h-source.html">Mesh2D.h</a>></code>
|
|
<p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for stk::Mesh2D:</div>
|
|
<div class="dynsection">
|
|
|
|
<p><center><img src="classstk_1_1Mesh2D.png" usemap="#stk::Mesh2D_map" border="0" alt=""></center>
|
|
<map name="stk::Mesh2D_map">
|
|
<area href="classstk_1_1Instrmnt.html" alt="stk::Instrmnt" shape="rect" coords="0,56,80,80">
|
|
<area href="classstk_1_1Stk.html" alt="stk::Stk" shape="rect" coords="0,0,80,24">
|
|
</map>
|
|
</div>
|
|
|
|
<p>
|
|
<a href="classstk_1_1Mesh2D-members.html">List of all members.</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="156fdff6515dbcd4b493ce0ef051a174"></a><!-- doxytag: member="stk::Mesh2D::Mesh2D" ref="156fdff6515dbcd4b493ce0ef051a174" args="(short nX, short nY)" -->
|
|
</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Mesh2D.html#156fdff6515dbcd4b493ce0ef051a174">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="c4abd6b5190587d69c7c2b13870fb646"></a><!-- doxytag: member="stk::Mesh2D::~Mesh2D" ref="c4abd6b5190587d69c7c2b13870fb646" args="(void)" -->
|
|
</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Mesh2D.html#c4abd6b5190587d69c7c2b13870fb646">~Mesh2D</a> (void)</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="49f56b4865dc041ae874fbc1b80e967b"></a><!-- doxytag: member="stk::Mesh2D::clear" ref="49f56b4865dc041ae874fbc1b80e967b" args="(void)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Mesh2D.html#49f56b4865dc041ae874fbc1b80e967b">clear</a> (void)</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="ccbad29fd6364f7c2d439bcf837590ec"></a><!-- doxytag: member="stk::Mesh2D::setNX" ref="ccbad29fd6364f7c2d439bcf837590ec" args="(short lenX)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Mesh2D.html#ccbad29fd6364f7c2d439bcf837590ec">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="4c4c54ad29fcee5654bd2ebaed29d916"></a><!-- doxytag: member="stk::Mesh2D::setNY" ref="4c4c54ad29fcee5654bd2ebaed29d916" args="(short lenY)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Mesh2D.html#4c4c54ad29fcee5654bd2ebaed29d916">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="9cdfa80ecccf3f12dc184003458ba3a3"></a><!-- doxytag: member="stk::Mesh2D::setInputPosition" ref="9cdfa80ecccf3f12dc184003458ba3a3" args="(StkFloat xFactor, StkFloat yFactor)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Mesh2D.html#9cdfa80ecccf3f12dc184003458ba3a3">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="b7b3d950e40308e7060e5ff9a62a8b8d"></a><!-- doxytag: member="stk::Mesh2D::setDecay" ref="b7b3d950e40308e7060e5ff9a62a8b8d" args="(StkFloat decayFactor)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Mesh2D.html#b7b3d950e40308e7060e5ff9a62a8b8d">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="7915dae1032ace5960c85790a7b93e0f"></a><!-- doxytag: member="stk::Mesh2D::noteOn" ref="7915dae1032ace5960c85790a7b93e0f" args="(StkFloat frequency, StkFloat amplitude)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Mesh2D.html#7915dae1032ace5960c85790a7b93e0f">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="0580962b3cc0dbac092581d0fc15127b"></a><!-- doxytag: member="stk::Mesh2D::noteOff" ref="0580962b3cc0dbac092581d0fc15127b" args="(StkFloat amplitude)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Mesh2D.html#0580962b3cc0dbac092581d0fc15127b">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="52d9552b67edea0fc6ff3e949d6331a0"></a><!-- doxytag: member="stk::Mesh2D::energy" ref="52d9552b67edea0fc6ff3e949d6331a0" args="(void)" -->
|
|
StkFloat </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Mesh2D.html#52d9552b67edea0fc6ff3e949d6331a0">energy</a> (void)</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="688bed8725ef2d8bf4c6465251bd8b86"></a><!-- doxytag: member="stk::Mesh2D::inputTick" ref="688bed8725ef2d8bf4c6465251bd8b86" args="(StkFloat input)" -->
|
|
StkFloat </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Mesh2D.html#688bed8725ef2d8bf4c6465251bd8b86">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="cc618a91b288305785644d852cfdaf83"></a><!-- doxytag: member="stk::Mesh2D::controlChange" ref="cc618a91b288305785644d852cfdaf83" args="(int number, StkFloat value)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Mesh2D.html#cc618a91b288305785644d852cfdaf83">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>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e8a7e86e4774d8738098c79ab0d5e00a"></a><!-- doxytag: member="stk::Mesh2D::tick" ref="e8a7e86e4774d8738098c79ab0d5e00a" args="(unsigned int channel=0)" -->
|
|
StkFloat </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Mesh2D.html#e8a7e86e4774d8738098c79ab0d5e00a">tick</a> (unsigned int channel=0)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Compute and return one output sample. <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. <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>
|
|
</div>
|
|
<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-2009 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
|
|
</table>
|
|
|
|
</BODY>
|
|
</HTML>
|