mirror of
https://github.com/thestk/stk
synced 2026-01-13 04:51:53 +00:00
73 lines
5.4 KiB
HTML
73 lines
5.4 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"><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="tutorial.html">Tutorial</a></CENTER>
|
|
<HR>
|
|
<!-- Generated by Doxygen 1.2.8.1 -->
|
|
<h1>Mandolin Class Reference</h1>STK mandolin instrument model class.
|
|
<a href="#_details">More...</a>
|
|
<p>
|
|
<code>#include <<a class="el" href="Mandolin_8h-source.html">Mandolin.h</a>></code>
|
|
<p>
|
|
<p>Inheritance diagram for Mandolin::
|
|
<p><center><img src="classMandolin.gif" usemap="#Mandolin_map" border="0"></center>
|
|
<map name="Mandolin_map">
|
|
<area href="classPluckTwo.html" alt="PluckTwo" shape="rect" coords="0,112,66,136">
|
|
<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 colspan=2><br><h2>Public Methods</h2></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="a0" doxytag="Mandolin::Mandolin"></a>
|
|
</td><td valign=bottom><a class="el" href="classMandolin.html#a0">Mandolin</a> (MY_FLOAT lowestFrequency)</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Class constructor, taking the lowest desired playing frequency.</em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="a1" doxytag="Mandolin::~Mandolin"></a>
|
|
virtual </td><td valign=bottom><a class="el" href="classMandolin.html#a1">~Mandolin</a> ()</td></tr>
|
|
<tr><td> </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="Mandolin::pluck"></a>
|
|
void </td><td valign=bottom><a class="el" href="classMandolin.html#a2">pluck</a> (MY_FLOAT amplitude)</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Pluck the strings with the given amplitude (0.0 - 1.0) using the current frequency.</em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="a3" doxytag="Mandolin::pluck"></a>
|
|
void </td><td valign=bottom><a class="el" href="classMandolin.html#a3">pluck</a> (MY_FLOAT amplitude, MY_FLOAT position)</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Pluck the strings with the given amplitude (0.0 - 1.0) and position (0.0 - 1.0).</em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="a4" doxytag="Mandolin::noteOn"></a>
|
|
virtual void </td><td valign=bottom><a class="el" href="classMandolin.html#a4">noteOn</a> (MY_FLOAT frequency, MY_FLOAT amplitude)</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Start a note with the given frequency and amplitude (0.0 - 1.0).</em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="a5" doxytag="Mandolin::setBodySize"></a>
|
|
void </td><td valign=bottom><a class="el" href="classMandolin.html#a5">setBodySize</a> (MY_FLOAT size)</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Set the body size (a value of 1.0 produces the "default" size).</em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="a6" doxytag="Mandolin::tick"></a>
|
|
virtual MY_FLOAT </td><td valign=bottom><a class="el" href="classMandolin.html#a6">tick</a> ()</td></tr>
|
|
<tr><td> </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="a7" doxytag="Mandolin::controlChange"></a>
|
|
virtual void </td><td valign=bottom><a class="el" href="classMandolin.html#a7">controlChange</a> (int number, MY_FLOAT value)</td></tr>
|
|
<tr><td> </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>
|
|
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>
|
|
This is a digital waveguide model, making its use possibly subject to patents held by Stanford University, Yamaha, and others. Commuted Synthesis, in particular, is covered by patents, granted, pending, and/or applied-for. All are assigned to the Board of Trustees, Stanford University. For information, contact the Office of Technology Licensing, Stanford University.
|
|
<p>
|
|
Control Change Numbers: <ul>
|
|
<li>Body Size = 2<li>Pluck Position = 4<li>String Sustain = 11<li>String Detuning = 1<li>Microphone Position = 128</ul>
|
|
by Perry R. Cook and Gary P. Scavone, 1995 - 2002.
|
|
<p>
|
|
<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>©1995-2002 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
|
|
</table>
|
|
|
|
</BODY>
|
|
</HTML>
|