mirror of
https://github.com/thestk/stk
synced 2026-01-13 21:11:53 +00:00
104 lines
8.5 KiB
HTML
104 lines
8.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="faq.html">FAQ</a> <a class="qindex" href="tutorial.html">Tutorial</a></CENTER>
|
|
<HR>
|
|
<!-- Generated by Doxygen 1.6.2 -->
|
|
<div class="navpath"><a class="el" href="namespacestk.html">stk</a>::<a class="el" href="classstk_1_1PluckTwo.html">PluckTwo</a>
|
|
</div>
|
|
<div class="contents">
|
|
<h1>stk::PluckTwo Class Reference</h1><!-- doxytag: class="stk::PluckTwo" --><!-- doxytag: inherits="stk::Instrmnt" -->
|
|
<p>STK enhanced plucked string model class.
|
|
<a href="#_details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="PluckTwo_8h_source.html">PluckTwo.h</a>></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for stk::PluckTwo:</div>
|
|
<div class="dynsection">
|
|
<div class="center">
|
|
<img src="classstk_1_1PluckTwo.png" usemap="#stk::PluckTwo_map" alt=""/>
|
|
<map id="stk::PluckTwo_map" name="stk::PluckTwo_map">
|
|
<area href="classstk_1_1Instrmnt.html" alt="stk::Instrmnt" shape="rect" coords="0,56,87,80"/>
|
|
<area href="classstk_1_1Stk.html" alt="stk::Stk" shape="rect" coords="0,0,87,24"/>
|
|
<area href="classstk_1_1Mandolin.html" alt="stk::Mandolin" shape="rect" coords="0,168,87,192"/>
|
|
</map>
|
|
</div>
|
|
</div>
|
|
|
|
<p><a href="classstk_1_1PluckTwo-members.html">List of all members.</a></p>
|
|
<table border="0" cellpadding="0" cellspacing="0">
|
|
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa121655f6007003aebb5de425e98d099"></a><!-- doxytag: member="stk::PluckTwo::PluckTwo" ref="aa121655f6007003aebb5de425e98d099" args="(StkFloat lowestFrequency)" -->
|
|
</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1PluckTwo.html#aa121655f6007003aebb5de425e98d099">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" align="right" valign="top"><a class="anchor" id="ac8a0720b08d20741b0d8a312f1cf7e5c"></a><!-- doxytag: member="stk::PluckTwo::~PluckTwo" ref="ac8a0720b08d20741b0d8a312f1cf7e5c" args="(void)" -->
|
|
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1PluckTwo.html#ac8a0720b08d20741b0d8a312f1cf7e5c">~PluckTwo</a> (void)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Class destructor. <br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a71821e47009a94de9e8a1f3305263840"></a><!-- doxytag: member="stk::PluckTwo::clear" ref="a71821e47009a94de9e8a1f3305263840" args="(void)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1PluckTwo.html#a71821e47009a94de9e8a1f3305263840">clear</a> (void)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reset and clear all internal state. <br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9f0618a28243b235f6c0f424a236709c"></a><!-- doxytag: member="stk::PluckTwo::setFrequency" ref="a9f0618a28243b235f6c0f424a236709c" args="(StkFloat frequency)" -->
|
|
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1PluckTwo.html#a9f0618a28243b235f6c0f424a236709c">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" align="right" valign="top"><a class="anchor" id="a6b355a495d9122273fb8c88009bf79d6"></a><!-- doxytag: member="stk::PluckTwo::setDetune" ref="a6b355a495d9122273fb8c88009bf79d6" args="(StkFloat detune)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1PluckTwo.html#a6b355a495d9122273fb8c88009bf79d6">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" align="right" valign="top"><a class="anchor" id="a3cd8e9135b1d8a97b87f9486dd3cd671"></a><!-- doxytag: member="stk::PluckTwo::setFreqAndDetune" ref="a3cd8e9135b1d8a97b87f9486dd3cd671" args="(StkFloat frequency, StkFloat detune)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1PluckTwo.html#a3cd8e9135b1d8a97b87f9486dd3cd671">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" align="right" valign="top"><a class="anchor" id="afffb424a2957fc691363ba1227809695"></a><!-- doxytag: member="stk::PluckTwo::setPluckPosition" ref="afffb424a2957fc691363ba1227809695" args="(StkFloat position)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1PluckTwo.html#afffb424a2957fc691363ba1227809695">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" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1PluckTwo.html#a168f563174e22b221744ef66b35a5277">setBaseLoopGain</a> (StkFloat aGain)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the base loop gain. <a href="#a168f563174e22b221744ef66b35a5277"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0d5d81db10c145f3d5bafc5775d147bf"></a><!-- doxytag: member="stk::PluckTwo::noteOff" ref="a0d5d81db10c145f3d5bafc5775d147bf" args="(StkFloat amplitude)" -->
|
|
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1PluckTwo.html#a0d5d81db10c145f3d5bafc5775d147bf">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/><a name="_details"></a><h2>Detailed Description</h2>
|
|
<p>STK enhanced plucked string model class. </p>
|
|
<p>This class implements an enhanced two-string, plucked physical model, a la Jaffe-Smith, Smith, and others.</p>
|
|
<p><a class="el" href="classstk_1_1PluckTwo.html" title="STK enhanced plucked string model class.">PluckTwo</a> is an abstract class, with no excitation specified. Therefore, it can't be directly instantiated.</p>
|
|
<p>This is a digital waveguide model, making its use possibly subject to patents held by Stanford University, Yamaha, and others.</p>
|
|
<p>by Perry R. Cook and Gary P. Scavone, 1995 - 2010. </p>
|
|
<hr/><h2>Member Function Documentation</h2>
|
|
<a class="anchor" id="a168f563174e22b221744ef66b35a5277"></a><!-- doxytag: member="stk::PluckTwo::setBaseLoopGain" ref="a168f563174e22b221744ef66b35a5277" args="(StkFloat aGain)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void stk::PluckTwo::setBaseLoopGain </td>
|
|
<td>(</td>
|
|
<td class="paramtype">StkFloat </td>
|
|
<td class="paramname"> <em>aGain</em></td>
|
|
<td> ) </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Set the base loop gain. </p>
|
|
<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. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<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></li>
|
|
</ul>
|
|
</div>
|
|
<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-2010 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
|
|
</table>
|
|
|
|
</BODY>
|
|
</HTML>
|