mirror of
https://github.com/thestk/stk
synced 2026-01-13 21:11:53 +00:00
110 lines
7.4 KiB
HTML
110 lines
7.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"> <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.4.4 -->
|
|
<h1>PluckTwo Class Reference</h1><!-- doxytag: class="PluckTwo" --><!-- doxytag: inherits="Instrmnt" --><code>#include <<a class="el" href="PluckTwo_8h-source.html">PluckTwo.h</a>></code>
|
|
<p>
|
|
<p>Inheritance diagram for PluckTwo:
|
|
<p><center><img src="classPluckTwo.png" usemap="#PluckTwo_map" border="0" alt=""></center>
|
|
<map name="PluckTwo_map">
|
|
<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">
|
|
<area href="classMandolin.html" alt="Mandolin" shape="rect" coords="0,168,66,192">
|
|
</map>
|
|
<a href="classPluckTwo-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
|
|
STK enhanced plucked string model class.
|
|
<p>
|
|
This class implements an enhanced two-string, plucked physical model, a la Jaffe-Smith, Smith, and others.<p>
|
|
PluckTwo is an abstract class, with no excitation specified. Therefore, it can't be directly instantiated.<p>
|
|
This is a digital waveguide model, making its use possibly subject to patents held by Stanford University, Yamaha, and others.<p>
|
|
by Perry R. Cook and Gary P. Scavone, 1995 - 2007.
|
|
<p>
|
|
<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"></a><!-- doxytag: member="PluckTwo::PluckTwo" ref="a0" args="(StkFloat lowestFrequency)" -->
|
|
</td><td class="memItemRight" valign="bottom"><a class="el" href="classPluckTwo.html#a0">PluckTwo</a> (StkFloat lowestFrequency)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Class constructor, taking the lowest desired playing frequency. <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a1"></a><!-- doxytag: member="PluckTwo::~PluckTwo" ref="a1" args="()" -->
|
|
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classPluckTwo.html#a1">~PluckTwo</a> ()</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="a2"></a><!-- doxytag: member="PluckTwo::clear" ref="a2" args="()" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPluckTwo.html#a2">clear</a> ()</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="a3"></a><!-- doxytag: member="PluckTwo::setFrequency" ref="a3" args="(StkFloat frequency)" -->
|
|
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPluckTwo.html#a3">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="a4"></a><!-- doxytag: member="PluckTwo::setDetune" ref="a4" args="(StkFloat detune)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPluckTwo.html#a4">setDetune</a> (StkFloat detune)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Detune the two strings by the given factor. A value of 1.0 produces unison strings. <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a5"></a><!-- doxytag: member="PluckTwo::setFreqAndDetune" ref="a5" args="(StkFloat frequency, StkFloat detune)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPluckTwo.html#a5">setFreqAndDetune</a> (StkFloat frequency, StkFloat detune)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Efficient combined setting of frequency and detuning. <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a6"></a><!-- doxytag: member="PluckTwo::setPluckPosition" ref="a6" args="(StkFloat position)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPluckTwo.html#a6">setPluckPosition</a> (StkFloat position)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the pluck or "excitation" position along the string (0.0 - 1.0). <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPluckTwo.html#a7">setBaseLoopGain</a> (StkFloat aGain)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the base loop gain. <a href="#a7"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a8"></a><!-- doxytag: member="PluckTwo::noteOff" ref="a8" args="(StkFloat amplitude)" -->
|
|
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPluckTwo.html#a8">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>
|
|
</table>
|
|
<hr><h2>Member Function Documentation</h2>
|
|
<a class="anchor" name="a7"></a><!-- doxytag: member="PluckTwo::setBaseLoopGain" ref="a7" args="(StkFloat aGain)" --><p>
|
|
<table class="mdTable" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">void PluckTwo::setBaseLoopGain </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top">StkFloat </td>
|
|
<td class="mdname1" valign="top" nowrap> <em>aGain</em> </td>
|
|
<td class="md" valign="top"> ) </td>
|
|
<td class="md" nowrap></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Set the base loop gain.
|
|
<p>
|
|
The actual loop gain is set according to the frequency. Because of high-frequency loop filter roll-off, higher frequency settings have greater loop gains. </td>
|
|
</tr>
|
|
</table>
|
|
<hr>The documentation for this class was generated from the following file:<ul>
|
|
<li><a class="el" href="PluckTwo_8h-source.html">PluckTwo.h</a></ul>
|
|
<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-2007 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
|
|
</table>
|
|
|
|
</BODY>
|
|
</HTML>
|