e1lama/stk
1
0
Fork 0
mirror of https://github.com/thestk/stk synced 2026-01-18 23:21:53 +00:00
Code Issues Packages Projects Releases Wiki Activity

Release 4.2.1 tarball

Browse Source
This commit is contained in:
Gary Scavone
2013-09-29 23:40:35 +02:00
committed by Stephen Sinclair
parent 11cf5faa0a
commit 21b93795e7
1041 changed files with 23984 additions and 16348 deletions
Download Patch File Download Diff File Expand all files Collapse all files

132
doc/html/classPluckTwo.html
View File

@@ -8,8 +8,8 @@
<img src="princeton.gif"> &nbsp; <img src="ccrma.gif"> &nbsp; <img src="mcgill.gif"><P>
<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>PluckTwo Class Reference</h1><code>#include &lt;<a class="el" href="PluckTwo_8h-source.html">PluckTwo.h</a>&gt;</code>
<!-- Generated by Doxygen 1.4.4 -->
<h1>PluckTwo Class Reference</h1><!-- doxytag: class="PluckTwo" --><!-- doxytag: inherits="Instrmnt" --><code>#include &lt;<a class="el" href="PluckTwo_8h-source.html">PluckTwo.h</a>&gt;</code>
<p>
<p>Inheritance diagram for PluckTwo:
<p><center><img src="classPluckTwo.png" usemap="#PluckTwo_map" border="0" alt=""></center>
@@ -24,80 +24,66 @@ STK enhanced plucked string model class.
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 - 2004.
by Perry R. Cook and Gary P. Scavone, 1995 - 2005.
<p>
<p>
Definition at line <a class="el" href="PluckTwo_8h-source.html#l00029">29</a> of file <a class="el" href="PluckTwo_8h-source.html">PluckTwo.h</a>.<table border=0 cellpadding=0 cellspacing=0>
<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="PluckTwo::PluckTwo" ></a>
&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classPluckTwo.html#a0">PluckTwo</a> (StkFloat lowestFrequency)</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)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPluckTwo.html#a0">PluckTwo</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="PluckTwo::~PluckTwo" ></a>
virtual&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classPluckTwo.html#a1">~PluckTwo</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</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&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPluckTwo.html#a1">~PluckTwo</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="PluckTwo::clear" ></a>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classPluckTwo.html#a2">clear</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</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&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPluckTwo.html#a2">clear</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</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="PluckTwo::setFrequency" ></a>
virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classPluckTwo.html#a3">setFrequency</a> (StkFloat frequency)</td></tr>
<tr><td class="mdescLeft">&nbsp;</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&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPluckTwo.html#a3">setFrequency</a> (StkFloat frequency)</td></tr>
<tr><td class="mdescLeft">&nbsp;</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="PluckTwo::setDetune" ></a>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classPluckTwo.html#a4">setDetune</a> (StkFloat detune)</td></tr>
<tr><td class="mdescLeft">&nbsp;</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&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPluckTwo.html#a4">setDetune</a> (StkFloat detune)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Detune the two strings by the given factor. A value of 1.0 produces unison strings. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a5" doxytag="PluckTwo::setFreqAndDetune" ></a>
void&nbsp;</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">&nbsp;</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&nbsp;</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">&nbsp;</td><td class="mdescRight">Efficient combined setting of frequency and detuning. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a6" doxytag="PluckTwo::setPluckPosition" ></a>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classPluckTwo.html#a6">setPluckPosition</a> (StkFloat position)</td></tr>
<tr><td class="mdescLeft">&nbsp;</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&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPluckTwo.html#a6">setPluckPosition</a> (StkFloat position)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the pluck or "excitation" position along the string (0.0 - 1.0). <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classPluckTwo.html#a7">setBaseLoopGain</a> (StkFloat aGain)</td></tr>
<tr><td class="mdescLeft">&nbsp;</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&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPluckTwo.html#a7">setBaseLoopGain</a> (StkFloat aGain)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the base loop gain. </em> <a href="#a7"></a><em><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a8" doxytag="PluckTwo::noteOff" ></a>
virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classPluckTwo.html#a8">noteOff</a> (StkFloat amplitude)</td></tr>
<tr><td class="mdescLeft">&nbsp;</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&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPluckTwo.html#a8">noteOff</a> (StkFloat amplitude)</td></tr>
<tr><td class="mdescLeft">&nbsp;</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="a9" doxytag="PluckTwo::tick" ></a>
virtual StkFloat&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classPluckTwo.html#a9">tick</a> ()=0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Virtual (abstract) tick function is implemented by subclasses. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a10" doxytag="PluckTwo::tick" ></a>
virtual StkFloat *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classPluckTwo.html#a10">tick</a> (StkFloat *vector, unsigned int vectorSize)=0</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>virtual <a class="el" href="classStkFrames.html">StkFrames</a> &amp;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classPluckTwo.html#a11">tick</a> (<a class="el" href="classStkFrames.html">StkFrames</a> &amp;frames, unsigned int channel=1)=0</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="#a11"></a><em><br><br></td></tr>
<tr><td class="mdescLeft">&nbsp;</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" doxytag="PluckTwo::setBaseLoopGain" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<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" nowrap valign="top">void PluckTwo::setBaseLoopGain </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">StkFloat&nbsp;</td>
<td class="mdname1" valign="top" nowrap> <em>aGain</em> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
@@ -107,51 +93,7 @@ virtual StkFloat *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el
<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>
<a class="anchor" name="a11" doxytag="PluckTwo::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"> virtual <a class="el" href="classStkFrames.html">StkFrames</a>&amp; PluckTwo::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> [pure 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>
Reimplemented from <a class="el" href="classInstrmnt.html#a10">Instrmnt</a>.
<p>
Implemented in <a class="el" href="classMandolin.html#a8">Mandolin</a>. </td>
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>
@@ -160,7 +102,7 @@ Implemented in <a class="el" href="classMandolin.html#a8">Mandolin</a>. </td>
<table>
<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>
<tr><td>&copy;1995-2005 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
</table>
</BODY>