e1lama/stk
1
0
Fork 0
mirror of https://github.com/thestk/stk synced 2026-01-11 20:11:52 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
43dcd5775a90ccfa745a4878a0f33a7ac721c398
stk/doc/html/classBandedWG.html
Gary Scavone 43dcd5775a Release 4.0 tarball
2013-09-29 23:33:56 +02:00

87 lines
6.7 KiB
HTML
Raw Blame History

<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"> &nbsp; <img src="ccrma.gif"><P>
<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="tutorial.html">Tutorial</a></CENTER>
<HR>
<!-- Generated by Doxygen 1.2.8.1 -->
<h1>BandedWG Class Reference</h1>Banded waveguide modeling class.
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="BandedWG_8h-source.html">BandedWG.h</a>&gt;</code>
<p>
<p>Inheritance diagram for BandedWG::
<p><center><img src="classBandedWG.gif" usemap="#BandedWG_map" border="0"></center>
<map name="BandedWG_map">
<area href="classInstrmnt.html" alt="Instrmnt" shape="rect" coords="0,56,75,80">
<area href="classStk.html" alt="Stk" shape="rect" coords="0,0,75,24">
</map>
<a href="classBandedWG-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
<tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
<tr><td nowrap align=right valign=top><a name="a0" doxytag="BandedWG::BandedWG"></a>
&nbsp;</td><td valign=bottom><a class="el" href="classBandedWG.html#a0">BandedWG</a> ()</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Class constructor.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="a1" doxytag="BandedWG::~BandedWG"></a>
&nbsp;</td><td valign=bottom><a class="el" href="classBandedWG.html#a1">~BandedWG</a> ()</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Class destructor.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="a2" doxytag="BandedWG::clear"></a>
void&nbsp;</td><td valign=bottom><a class="el" href="classBandedWG.html#a2">clear</a> ()</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Reset and clear all internal state.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="a3" doxytag="BandedWG::setStrikePosition"></a>
void&nbsp;</td><td valign=bottom><a class="el" href="classBandedWG.html#a3">setStrikePosition</a> (MY_FLOAT position)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Set strike position (0.0 - 1.0).</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="a4" doxytag="BandedWG::setPreset"></a>
void&nbsp;</td><td valign=bottom><a class="el" href="classBandedWG.html#a4">setPreset</a> (int preset)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Select a preset.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="a5" doxytag="BandedWG::setFrequency"></a>
void&nbsp;</td><td valign=bottom><a class="el" href="classBandedWG.html#a5">setFrequency</a> (MY_FLOAT frequency)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Set instrument parameters for a particular frequency.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="a6" doxytag="BandedWG::startBowing"></a>
void&nbsp;</td><td valign=bottom><a class="el" href="classBandedWG.html#a6">startBowing</a> (MY_FLOAT amplitude, MY_FLOAT rate)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Apply bow velocity/pressure to instrument with given amplitude and rate of increase.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="a7" doxytag="BandedWG::stopBowing"></a>
void&nbsp;</td><td valign=bottom><a class="el" href="classBandedWG.html#a7">stopBowing</a> (MY_FLOAT rate)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Decrease bow velocity/breath pressure with given rate of decrease.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="a8" doxytag="BandedWG::pluck"></a>
void&nbsp;</td><td valign=bottom><a class="el" href="classBandedWG.html#a8">pluck</a> (MY_FLOAT amp)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Pluck the instrument with given amplitude.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="a9" doxytag="BandedWG::noteOn"></a>
void&nbsp;</td><td valign=bottom><a class="el" href="classBandedWG.html#a9">noteOn</a> (MY_FLOAT frequency, MY_FLOAT amplitude)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Start a note with the given frequency and amplitude.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="a10" doxytag="BandedWG::noteOff"></a>
void&nbsp;</td><td valign=bottom><a class="el" href="classBandedWG.html#a10">noteOff</a> (MY_FLOAT amplitude)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Stop a note with the given amplitude (speed of decay).</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="a11" doxytag="BandedWG::tick"></a>
MY_FLOAT&nbsp;</td><td valign=bottom><a class="el" href="classBandedWG.html#a11">tick</a> ()</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Compute one output sample.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="a12" doxytag="BandedWG::controlChange"></a>
void&nbsp;</td><td valign=bottom><a class="el" href="classBandedWG.html#a12">controlChange</a> (int number, MY_FLOAT value)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Perform the control change specified by <em>number</em> and <em>value</em> (0.0 - 128.0).</em></font><br><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Banded waveguide modeling class.
<p>
This class uses banded waveguide techniques to model a variety of sounds, including bowed bars, glasses, and bowls. For more information, see Essl, G. and Cook, P. "Banded Waveguides: Towards Physical Modelling of Bar Percussion Instruments", Proceedings of the 1999 International Computer Music Conference.
<p>
Control Change Numbers: <ul>
<li>Bow Pressure = 2<li>Bow Motion = 4<li>Strike Position = 8 (not implemented)<li>Vibrato Frequency = 11<li>Gain = 1<li>Bow Velocity = 128<li>Set Striking = 64<li>Instrument Presets = 16<ul>
<li>Uniform Bar = 0<li>Tuned Bar = 1<li>Glass Harmonica = 2<li>Tibetan Bowl = 3</ul>
</ul>
by Georg Essl, 1999 - 2002. Modified for <a class="el" href="classStk.html">Stk</a> 4.0 by Gary Scavone.
<p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="BandedWG_8h-source.html">BandedWG.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>&copy;1995-2002 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
</table>
</BODY>
</HTML>
Reference in New Issue View Git Blame Copy Permalink