mirror of
https://github.com/thestk/stk
synced 2026-01-14 13:31:53 +00:00
79 lines
5.5 KiB
HTML
79 lines
5.5 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>Plucked Class Reference</h1>STK plucked string model class.
|
|
<a href="#_details">More...</a>
|
|
<p>
|
|
<code>#include <<a class="el" href="Plucked_8h-source.html">Plucked.h</a>></code>
|
|
<p>
|
|
<p>Inheritance diagram for Plucked:
|
|
<p><center><img src="classPlucked.png" usemap="#Plucked_map" border="0" alt=""></center>
|
|
<map name="Plucked_map">
|
|
<area href="classInstrmnt.html" alt="Instrmnt" shape="rect" coords="0,56,57,80">
|
|
<area href="classStk.html" alt="Stk" shape="rect" coords="0,0,57,24">
|
|
</map>
|
|
<a href="classPlucked-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="Plucked::Plucked" ></a>
|
|
</td><td class="memItemRight" valign=bottom><a class="el" href="classPlucked.html#a0">Plucked</a> (MY_FLOAT lowestFrequency)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </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="Plucked::~Plucked" ></a>
|
|
</td><td class="memItemRight" valign=bottom><a class="el" href="classPlucked.html#a1">~Plucked</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="Plucked::clear" ></a>
|
|
void </td><td class="memItemRight" valign=bottom><a class="el" href="classPlucked.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="Plucked::setFrequency" ></a>
|
|
virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="classPlucked.html#a3">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="a4" doxytag="Plucked::pluck" ></a>
|
|
void </td><td class="memItemRight" valign=bottom><a class="el" href="classPlucked.html#a4">pluck</a> (MY_FLOAT amplitude)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Pluck the string with the given amplitude using the current frequency. <br><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a5" doxytag="Plucked::noteOn" ></a>
|
|
virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="classPlucked.html#a5">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="a6" doxytag="Plucked::noteOff" ></a>
|
|
virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="classPlucked.html#a6">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="a7" doxytag="Plucked::tick" ></a>
|
|
virtual MY_FLOAT </td><td class="memItemRight" valign=bottom><a class="el" href="classPlucked.html#a7">tick</a> ()</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Compute one output sample. <br><br></td></tr>
|
|
</table>
|
|
<hr><a name="_details"></a><h2>Detailed Description</h2>
|
|
STK plucked string model class.
|
|
<p>
|
|
This class implements a simple plucked string physical model based on the Karplus-Strong algorithm.<p>
|
|
This is a digital waveguide model, making its use possibly subject to patents held by Stanford University, Yamaha, and others. There exist at least two patents, assigned to Stanford, bearing the names of Karplus and/or Strong.<p>
|
|
by Perry R. Cook and Gary P. Scavone, 1995 - 2002.
|
|
<p>
|
|
|
|
<p>
|
|
Definition at line <a class="el" href="Plucked_8h-source.html#l00029">29</a> of file <a class="el" href="Plucked_8h-source.html">Plucked.h</a>.<hr>The documentation for this class was generated from the following file:<ul>
|
|
<li><a class="el" href="Plucked_8h-source.html">Plucked.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>
|