e1lama/stk
1
0
Fork 0
mirror of https://github.com/thestk/stk synced 2026-01-16 14:21:53 +00:00
Code Issues Packages Projects Releases Wiki Activity

Release 4.2.0 tarball

Browse Source
This commit is contained in:
Gary Scavone
2013-09-29 23:39:37 +02:00
committed by Stephen Sinclair
parent fe20fe92a2
commit de344668dd
347 changed files with 16972 additions and 8538 deletions
Download Patch File Download Diff File Expand all files Collapse all files

101
doc/html/classBowed.html
View File

@@ -9,10 +9,7 @@
<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="links.html">Links</a> &nbsp; <a class="qindex" href="tutorial.html">Tutorial</a></CENTER>
<HR>
<!-- Generated by Doxygen 1.3.4 -->
<h1>Bowed Class Reference</h1>STK bowed string instrument class.
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="Bowed_8h-source.html">Bowed.h</a>&gt;</code>
<h1>Bowed Class Reference</h1><code>#include &lt;<a class="el" href="Bowed_8h-source.html">Bowed.h</a>&gt;</code>
<p>
<p>Inheritance diagram for Bowed:
<p><center><img src="classBowed.png" usemap="#Bowed_map" border="0" alt=""></center>
@@ -20,11 +17,23 @@
<area href="classInstrmnt.html" alt="Instrmnt" shape="rect" coords="0,56,55,80">
<area href="classStk.html" alt="Stk" shape="rect" coords="0,0,55,24">
</map>
<a href="classBowed-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
<a href="classBowed-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
STK bowed string instrument class.
<p>
This class implements a bowed string model, a la Smith (1986), after McIntyre, Schumacher, Woodhouse (1983).<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>Bow Pressure = 2</li><li>Bow Position = 4</li><li>Vibrato Frequency = 11</li><li>Vibrato Gain = 1</li><li>Volume = 128</li></ul>
<p>
by Perry R. Cook and Gary P. Scavone, 1995 - 2004.
<p>
<p>
Definition at line <a class="el" href="Bowed_8h-source.html#l00035">35</a> of file <a class="el" href="Bowed_8h-source.html">Bowed.h</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="Bowed::Bowed" ></a>
&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classBowed.html#a0">Bowed</a> (MY_FLOAT lowestFrequency)</td></tr>
&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classBowed.html#a0">Bowed</a> (StkFloat lowestFrequency)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Class constructor, taking the lowest desired playing frequency. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a1" doxytag="Bowed::~Bowed" ></a>
@@ -36,56 +45,94 @@ void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classB
<tr><td class="mdescLeft">&nbsp;</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="Bowed::setFrequency" ></a>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classBowed.html#a3">setFrequency</a> (MY_FLOAT frequency)</td></tr>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classBowed.html#a3">setFrequency</a> (StkFloat frequency)</td></tr>
<tr><td class="mdescLeft">&nbsp;</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="a4" doxytag="Bowed::setVibrato" ></a>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classBowed.html#a4">setVibrato</a> (MY_FLOAT gain)</td></tr>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classBowed.html#a4">setVibrato</a> (StkFloat gain)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set vibrato gain. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a5" doxytag="Bowed::startBowing" ></a>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classBowed.html#a5">startBowing</a> (MY_FLOAT amplitude, MY_FLOAT rate)</td></tr>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classBowed.html#a5">startBowing</a> (StkFloat amplitude, StkFloat rate)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Apply breath 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="a6" doxytag="Bowed::stopBowing" ></a>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classBowed.html#a6">stopBowing</a> (MY_FLOAT rate)</td></tr>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classBowed.html#a6">stopBowing</a> (StkFloat rate)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Decrease breath pressure with given rate of decrease. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a7" doxytag="Bowed::noteOn" ></a>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classBowed.html#a7">noteOn</a> (MY_FLOAT frequency, MY_FLOAT amplitude)</td></tr>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classBowed.html#a7">noteOn</a> (StkFloat frequency, StkFloat amplitude)</td></tr>
<tr><td class="mdescLeft">&nbsp;</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="a8" doxytag="Bowed::noteOff" ></a>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classBowed.html#a8">noteOff</a> (MY_FLOAT amplitude)</td></tr>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classBowed.html#a8">noteOff</a> (StkFloat amplitude)</td></tr>
<tr><td class="mdescLeft">&nbsp;</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="a9" doxytag="Bowed::tick" ></a>
MY_FLOAT&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classBowed.html#a9">tick</a> ()</td></tr>
StkFloat&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classBowed.html#a9">tick</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</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="a10" doxytag="Bowed::controlChange" ></a>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classBowed.html#a10">controlChange</a> (int number, MY_FLOAT value)</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a10" doxytag="Bowed::tick" ></a>
StkFloat *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classBowed.html#a10">tick</a> (StkFloat *vector, unsigned int vectorSize)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Computer <em>vectorSize</em> outputs and return them in <em>vector</em>. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classStkFrames.html">StkFrames</a> &amp;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classBowed.html#a11">tick</a> (<a class="el" href="classStkFrames.html">StkFrames</a> &amp;frames, unsigned int channel=1)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Fill a channel of the <a class="el" href="classStkFrames.html">StkFrames</a> object with computed outputs. </em> <a href="#a11"></a><em><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a12" doxytag="Bowed::controlChange" ></a>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classBowed.html#a12">controlChange</a> (int number, StkFloat value)</td></tr>
<tr><td class="mdescLeft">&nbsp;</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>
STK bowed string instrument class.
<p>
This class implements a bowed string model, a la Smith (1986), after McIntyre, Schumacher, Woodhouse (1983).<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>Bow Pressure = 2</li><li>Bow Position = 4</li><li>Vibrato Frequency = 11</li><li>Vibrato Gain = 1</li><li>Volume = 128</li></ul>
<p>
by Perry R. Cook and Gary P. Scavone, 1995 - 2002.
<p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="a11" doxytag="Bowed::tick" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="classStkFrames.html">StkFrames</a>&amp; Bowed::tick </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top"><a class="el" href="classStkFrames.html">StkFrames</a> &amp;&nbsp;</td>
<td class="mdname" nowrap> <em>frames</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>unsigned int&nbsp;</td>
<td class="mdname" nowrap> <em>channel</em> = 1</td>
</tr>
<tr>
<td></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"><code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Definition at line <a class="el" href="Bowed_8h-source.html#l00035">35</a> of file <a class="el" href="Bowed_8h-source.html">Bowed.h</a>.<hr>The documentation for this class was generated from the following file:<ul>
Fill a channel of the <a class="el" href="classStkFrames.html">StkFrames</a> object with computed outputs.
<p>
The <code>channel</code> argument should be one or greater (the first channel is specified by 1). An <a class="el" href="classStkError.html">StkError</a> will be thrown if the <code>channel</code> argument is zero or it is greater than the number of channels in the <a class="el" href="classStkFrames.html">StkFrames</a> object.
<p>
Reimplemented from <a class="el" href="classInstrmnt.html#a10">Instrmnt</a>. </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="Bowed_8h-source.html">Bowed.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><A HREF="http://ccrma.stanford.edu/software/stk/"><I>The Synthesis ToolKit in C++ (STK)</I></A></td></tr>
<tr><td>&copy;1995-2004 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
</table>