e1lama/stk
1
0
Fork 0
mirror of https://github.com/thestk/stk synced 2026-01-15 14:01:52 +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

135
doc/html/classMandolin.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>Mandolin Class Reference</h1>STK mandolin instrument model class.
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="Mandolin_8h-source.html">Mandolin.h</a>&gt;</code>
<h1>Mandolin Class Reference</h1><code>#include &lt;<a class="el" href="Mandolin_8h-source.html">Mandolin.h</a>&gt;</code>
<p>
<p>Inheritance diagram for Mandolin:
<p><center><img src="classMandolin.png" usemap="#Mandolin_map" border="0" alt=""></center>
@@ -21,43 +18,7 @@
<area href="classInstrmnt.html" alt="Instrmnt" shape="rect" coords="0,56,66,80">
<area href="classStk.html" alt="Stk" shape="rect" coords="0,0,66,24">
</map>
<a href="classMandolin-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="Mandolin::Mandolin" ></a>
&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classMandolin.html#a0">Mandolin</a> (MY_FLOAT 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="Mandolin::~Mandolin" ></a>
virtual&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classMandolin.html#a1">~Mandolin</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</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="Mandolin::pluck" ></a>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classMandolin.html#a2">pluck</a> (MY_FLOAT amplitude)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Pluck the strings with the given amplitude (0.0 - 1.0) using the current frequency. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a3" doxytag="Mandolin::pluck" ></a>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classMandolin.html#a3">pluck</a> (MY_FLOAT amplitude, MY_FLOAT position)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Pluck the strings with the given amplitude (0.0 - 1.0) and position (0.0 - 1.0). <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a4" doxytag="Mandolin::noteOn" ></a>
virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classMandolin.html#a4">noteOn</a> (MY_FLOAT frequency, MY_FLOAT amplitude)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Start a note with the given frequency and amplitude (0.0 - 1.0). <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a5" doxytag="Mandolin::setBodySize" ></a>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classMandolin.html#a5">setBodySize</a> (MY_FLOAT size)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the body size (a value of 1.0 produces the "default" size). <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a6" doxytag="Mandolin::tick" ></a>
virtual MY_FLOAT&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classMandolin.html#a6">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="a7" doxytag="Mandolin::controlChange" ></a>
virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classMandolin.html#a7">controlChange</a> (int number, MY_FLOAT 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>
<a href="classMandolin-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
STK mandolin instrument model class.
<p>
This class inherits from <a class="el" href="classPluckTwo.html">PluckTwo</a> and uses "commuted synthesis" techniques to model a mandolin instrument.<p>
@@ -65,16 +26,102 @@ This is a digital waveguide model, making its use possibly subject to patents he
Control Change Numbers:<ul>
<li>Body Size = 2</li><li>Pluck Position = 4</li><li>String Sustain = 11</li><li>String Detuning = 1</li><li>Microphone Position = 128</li></ul>
<p>
by Perry R. Cook and Gary P. Scavone, 1995 - 2002.
by Perry R. Cook and Gary P. Scavone, 1995 - 2004.
<p>
<p>
Definition at line <a class="el" href="Mandolin_8h-source.html#l00036">36</a> of file <a class="el" href="Mandolin_8h-source.html">Mandolin.h</a>.<hr>The documentation for this class was generated from the following file:<ul>
Definition at line <a class="el" href="Mandolin_8h-source.html#l00036">36</a> of file <a class="el" href="Mandolin_8h-source.html">Mandolin.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="Mandolin::Mandolin" ></a>
&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classMandolin.html#a0">Mandolin</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="Mandolin::~Mandolin" ></a>
&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classMandolin.html#a1">~Mandolin</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</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="Mandolin::pluck" ></a>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classMandolin.html#a2">pluck</a> (StkFloat amplitude)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Pluck the strings with the given amplitude (0.0 - 1.0) using the current frequency. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a3" doxytag="Mandolin::pluck" ></a>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classMandolin.html#a3">pluck</a> (StkFloat amplitude, StkFloat position)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Pluck the strings with the given amplitude (0.0 - 1.0) and position (0.0 - 1.0). <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a4" doxytag="Mandolin::noteOn" ></a>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classMandolin.html#a4">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 (0.0 - 1.0). <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a5" doxytag="Mandolin::setBodySize" ></a>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classMandolin.html#a5">setBodySize</a> (StkFloat size)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the body size (a value of 1.0 produces the "default" size). <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a6" doxytag="Mandolin::tick" ></a>
StkFloat&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classMandolin.html#a6">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="a7" doxytag="Mandolin::tick" ></a>
StkFloat *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classMandolin.html#a7">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="classMandolin.html#a8">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="#a8"></a><em><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a9" doxytag="Mandolin::controlChange" ></a>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classMandolin.html#a9">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><h2>Member Function Documentation</h2>
<a class="anchor" name="a8" doxytag="Mandolin::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; Mandolin::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>
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>
Implements <a class="el" href="classPluckTwo.html#a11">PluckTwo</a>. </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="Mandolin_8h-source.html">Mandolin.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>