mirror of
https://github.com/thestk/stk
synced 2026-01-11 20:11:52 +00:00
103 lines
7.8 KiB
HTML
103 lines
7.8 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.3.4 -->
|
|
<h1>BandedWG Class Reference</h1>Banded waveguide modeling class.
|
|
<a href="#_details">More...</a>
|
|
<p>
|
|
<code>#include <<a class="el" href="BandedWG_8h-source.html">BandedWG.h</a>></code>
|
|
<p>
|
|
<p>Inheritance diagram for BandedWG:
|
|
<p><center><img src="classBandedWG.png" usemap="#BandedWG_map" border="0" alt=""></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></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="BandedWG::BandedWG" ></a>
|
|
</td><td class="memItemRight" valign=bottom><a class="el" href="classBandedWG.html#a0">BandedWG</a> ()</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Class constructor. <br><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a1" doxytag="BandedWG::~BandedWG" ></a>
|
|
</td><td class="memItemRight" valign=bottom><a class="el" href="classBandedWG.html#a1">~BandedWG</a> ()</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Class destructor. <br><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a2" doxytag="BandedWG::clear" ></a>
|
|
void </td><td class="memItemRight" valign=bottom><a class="el" href="classBandedWG.html#a2">clear</a> ()</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reset and clear all internal state. <br><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a3" doxytag="BandedWG::setStrikePosition" ></a>
|
|
void </td><td class="memItemRight" valign=bottom><a class="el" href="classBandedWG.html#a3">setStrikePosition</a> (MY_FLOAT position)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set strike position (0.0 - 1.0). <br><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a4" doxytag="BandedWG::setPreset" ></a>
|
|
void </td><td class="memItemRight" valign=bottom><a class="el" href="classBandedWG.html#a4">setPreset</a> (int preset)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Select a preset. <br><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a5" doxytag="BandedWG::setFrequency" ></a>
|
|
void </td><td class="memItemRight" valign=bottom><a class="el" href="classBandedWG.html#a5">setFrequency</a> (MY_FLOAT frequency)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set instrument parameters for a particular frequency. <br><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a6" doxytag="BandedWG::startBowing" ></a>
|
|
void </td><td class="memItemRight" valign=bottom><a class="el" href="classBandedWG.html#a6">startBowing</a> (MY_FLOAT amplitude, MY_FLOAT rate)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Apply bow velocity/pressure to instrument with given amplitude and rate of increase. <br><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a7" doxytag="BandedWG::stopBowing" ></a>
|
|
void </td><td class="memItemRight" valign=bottom><a class="el" href="classBandedWG.html#a7">stopBowing</a> (MY_FLOAT rate)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Decrease bow velocity/breath pressure with given rate of decrease. <br><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a8" doxytag="BandedWG::pluck" ></a>
|
|
void </td><td class="memItemRight" valign=bottom><a class="el" href="classBandedWG.html#a8">pluck</a> (MY_FLOAT amp)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Pluck the instrument with given amplitude. <br><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a9" doxytag="BandedWG::noteOn" ></a>
|
|
void </td><td class="memItemRight" valign=bottom><a class="el" href="classBandedWG.html#a9">noteOn</a> (MY_FLOAT frequency, MY_FLOAT amplitude)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Start a note with the given frequency and amplitude. <br><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a10" doxytag="BandedWG::noteOff" ></a>
|
|
void </td><td class="memItemRight" valign=bottom><a class="el" href="classBandedWG.html#a10">noteOff</a> (MY_FLOAT amplitude)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Stop a note with the given amplitude (speed of decay). <br><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a11" doxytag="BandedWG::tick" ></a>
|
|
MY_FLOAT </td><td class="memItemRight" valign=bottom><a class="el" href="classBandedWG.html#a11">tick</a> ()</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Compute one output sample. <br><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a12" doxytag="BandedWG::controlChange" ></a>
|
|
void </td><td class="memItemRight" valign=bottom><a class="el" href="classBandedWG.html#a12">controlChange</a> (int number, MY_FLOAT 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><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><li>Bow Motion = 4</li><li>Strike Position = 8 (not implemented)</li><li>Vibrato Frequency = 11</li><li>Gain = 1</li><li>Bow Velocity = 128</li><li>Set Striking = 64</li><li>Instrument Presets = 16<ul>
|
|
<li>Uniform Bar = 0</li><li>Tuned Bar = 1</li><li>Glass Harmonica = 2</li><li>Tibetan Bowl = 3</li></ul>
|
|
</li></ul>
|
|
<p>
|
|
by Georg Essl, 1999 - 2002. Modified for <a class="el" href="classStk.html">Stk</a> 4.0 by Gary Scavone.
|
|
<p>
|
|
|
|
<p>
|
|
Definition at line <a class="el" href="BandedWG_8h-source.html#l00043">43</a> of file <a class="el" href="BandedWG_8h-source.html">BandedWG.h</a>.<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>©1995-2004 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
|
|
</table>
|
|
|
|
</BODY>
|
|
</HTML>
|