mirror of
https://github.com/thestk/stk
synced 2026-01-14 05:21:53 +00:00
109 lines
10 KiB
HTML
109 lines
10 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_1BandedWG.html">BandedWG</a>
|
|
</div>
|
|
<div class="contents">
|
|
<h1>stk::BandedWG Class Reference</h1><!-- doxytag: class="stk::BandedWG" --><!-- doxytag: inherits="stk::Instrmnt" -->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>
|
|
<div class="dynheader">
|
|
Inheritance diagram for stk::BandedWG:</div>
|
|
<div class="dynsection">
|
|
|
|
<p><center><img src="classstk_1_1BandedWG.png" usemap="#stk::BandedWG_map" border="0" alt=""></center>
|
|
<map name="stk::BandedWG_map">
|
|
<area href="classstk_1_1Instrmnt.html" alt="stk::Instrmnt" shape="rect" coords="0,56,96,80">
|
|
<area href="classstk_1_1Stk.html" alt="stk::Stk" shape="rect" coords="0,0,96,24">
|
|
</map>
|
|
</div>
|
|
|
|
<p>
|
|
<a href="classstk_1_1BandedWG-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="d449f248adaa49344c2bd25be4a7872d"></a><!-- doxytag: member="stk::BandedWG::BandedWG" ref="d449f248adaa49344c2bd25be4a7872d" args="(void)" -->
|
|
</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1BandedWG.html#d449f248adaa49344c2bd25be4a7872d">BandedWG</a> (void)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Class constructor. <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c4044055c28bad672c9537b985d18289"></a><!-- doxytag: member="stk::BandedWG::~BandedWG" ref="c4044055c28bad672c9537b985d18289" args="(void)" -->
|
|
</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1BandedWG.html#c4044055c28bad672c9537b985d18289">~BandedWG</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="182dbf5d75aebf5714bd6df15b0df90c"></a><!-- doxytag: member="stk::BandedWG::clear" ref="182dbf5d75aebf5714bd6df15b0df90c" args="(void)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1BandedWG.html#182dbf5d75aebf5714bd6df15b0df90c">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="4394ee4cd1c84a8b3f92713e60715c4d"></a><!-- doxytag: member="stk::BandedWG::setStrikePosition" ref="4394ee4cd1c84a8b3f92713e60715c4d" args="(StkFloat position)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1BandedWG.html#4394ee4cd1c84a8b3f92713e60715c4d">setStrikePosition</a> (StkFloat position)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set strike position (0.0 - 1.0). <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b1e3a367eef86e6cb372b4ee232e1804"></a><!-- doxytag: member="stk::BandedWG::setPreset" ref="b1e3a367eef86e6cb372b4ee232e1804" args="(int preset)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1BandedWG.html#b1e3a367eef86e6cb372b4ee232e1804">setPreset</a> (int preset)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Select a preset. <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="cf104d4ed663b5f0cd034c8025f4d420"></a><!-- doxytag: member="stk::BandedWG::setFrequency" ref="cf104d4ed663b5f0cd034c8025f4d420" args="(StkFloat frequency)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1BandedWG.html#cf104d4ed663b5f0cd034c8025f4d420">setFrequency</a> (StkFloat frequency)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set instrument parameters for a particular frequency. <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="37b20c2554e7100241a99758f5a4433e"></a><!-- doxytag: member="stk::BandedWG::startBowing" ref="37b20c2554e7100241a99758f5a4433e" args="(StkFloat amplitude, StkFloat rate)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1BandedWG.html#37b20c2554e7100241a99758f5a4433e">startBowing</a> (StkFloat amplitude, StkFloat 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></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a14786c32af030311e2118db3b68a892"></a><!-- doxytag: member="stk::BandedWG::stopBowing" ref="a14786c32af030311e2118db3b68a892" args="(StkFloat rate)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1BandedWG.html#a14786c32af030311e2118db3b68a892">stopBowing</a> (StkFloat rate)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Decrease bow velocity/breath pressure with given rate of decrease. <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="271573afaa2dc655446482bad6745cc1"></a><!-- doxytag: member="stk::BandedWG::pluck" ref="271573afaa2dc655446482bad6745cc1" args="(StkFloat amp)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1BandedWG.html#271573afaa2dc655446482bad6745cc1">pluck</a> (StkFloat amp)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Pluck the instrument with given amplitude. <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8f334ae49b7baf561d74a0b6ec3c4f9a"></a><!-- doxytag: member="stk::BandedWG::noteOn" ref="8f334ae49b7baf561d74a0b6ec3c4f9a" args="(StkFloat frequency, StkFloat amplitude)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1BandedWG.html#8f334ae49b7baf561d74a0b6ec3c4f9a">noteOn</a> (StkFloat frequency, StkFloat amplitude)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Start a note with the given frequency and amplitude. <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c9c3c3ec0e821b1a080774bb55d3b881"></a><!-- doxytag: member="stk::BandedWG::noteOff" ref="c9c3c3ec0e821b1a080774bb55d3b881" args="(StkFloat amplitude)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1BandedWG.html#c9c3c3ec0e821b1a080774bb55d3b881">noteOff</a> (StkFloat amplitude)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Stop a note with the given amplitude (speed of decay). <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="16baac1cc6612332d6d0aa40a661c137"></a><!-- doxytag: member="stk::BandedWG::controlChange" ref="16baac1cc6612332d6d0aa40a661c137" args="(int number, StkFloat value)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1BandedWG.html#16baac1cc6612332d6d0aa40a661c137">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="44f37146d33354afb085806bd8340497"></a><!-- doxytag: member="stk::BandedWG::tick" ref="44f37146d33354afb085806bd8340497" args="(unsigned int channel=0)" -->
|
|
StkFloat </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1BandedWG.html#44f37146d33354afb085806bd8340497">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>
|
|
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 - 2004. Modified for STK 4.0 by Gary Scavone. <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>
|
|
</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>
|