e1lama/stk
1
0
Fork 0
mirror of https://github.com/thestk/stk synced 2026-01-19 07:31:52 +00:00
Code Issues Packages Projects Releases Wiki Activity

Release 4.1.2 tarball

Browse Source
This commit is contained in:
Gary Scavone
2013-09-29 23:37:27 +02:00
committed by Stephen Sinclair
parent d12ef806ac
commit 5d63b50e85
436 changed files with 17966 additions and 14506 deletions
Download Patch File Download Diff File Expand all files Collapse all files

83
doc/html/classSitar.html
View File

@@ -5,64 +5,73 @@
</HEAD>
<BODY BGCOLOR="#FFFFFF">
<CENTER>
<img src="princeton.gif"> &nbsp; <img src="ccrma.gif"><P>
<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.2.8.1 -->
<h1>Sitar Class Reference</h1>STK sitar string model class.
<!-- Generated by Doxygen 1.3.6 -->
<h1>Sitar Class Reference</h1>STK sitar string model class.
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="Sitar_8h-source.html">Sitar.h</a>&gt;</code>
<p>
<p>Inheritance diagram for Sitar::
<p><center><img src="classSitar.gif" usemap="#Sitar_map" border="0"></center>
<p>Inheritance diagram for Sitar:
<p><center><img src="classSitar.png" usemap="#Sitar_map" border="0" alt=""></center>
<map name="Sitar_map">
<area href="classInstrmnt.html" alt="Instrmnt" shape="rect" coords="0,56,55,80">
<area href="classStk.html" alt="Stk" shape="rect" coords="0,0,55,24">
</map>
<a href="classSitar-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="Sitar::Sitar"></a>
&nbsp;</td><td valign=bottom><a class="el" href="classSitar.html#a0">Sitar</a> (MY_FLOAT lowestFrequency)</td></tr>
<tr><td>&nbsp;</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="Sitar::~Sitar"></a>
&nbsp;</td><td valign=bottom><a class="el" href="classSitar.html#a1">~Sitar</a> ()</td></tr>
<tr><td>&nbsp;</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="Sitar::clear"></a>
void&nbsp;</td><td valign=bottom><a class="el" href="classSitar.html#a2">clear</a> ()</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Reset and clear all internal state.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="a3" doxytag="Sitar::setFrequency"></a>
void&nbsp;</td><td valign=bottom><a class="el" href="classSitar.html#a3">setFrequency</a> (MY_FLOAT frequency)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Set instrument parameters for a particular frequency.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="a4" doxytag="Sitar::pluck"></a>
void&nbsp;</td><td valign=bottom><a class="el" href="classSitar.html#a4">pluck</a> (MY_FLOAT amplitude)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Pluck the string with the given amplitude using the current frequency.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="a5" doxytag="Sitar::noteOn"></a>
void&nbsp;</td><td valign=bottom><a class="el" href="classSitar.html#a5">noteOn</a> (MY_FLOAT frequency, MY_FLOAT amplitude)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Start a note with the given frequency and amplitude.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="a6" doxytag="Sitar::noteOff"></a>
void&nbsp;</td><td valign=bottom><a class="el" href="classSitar.html#a6">noteOff</a> (MY_FLOAT amplitude)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Stop a note with the given amplitude (speed of decay).</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="a7" doxytag="Sitar::tick"></a>
MY_FLOAT&nbsp;</td><td valign=bottom><a class="el" href="classSitar.html#a7">tick</a> ()</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Compute one output sample.</em></font><br><br></td></tr>
<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="Sitar::Sitar" ></a>
&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classSitar.html#a0">Sitar</a> (MY_FLOAT 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="Sitar::~Sitar" ></a>
&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classSitar.html#a1">~Sitar</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="Sitar::clear" ></a>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classSitar.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="Sitar::setFrequency" ></a>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classSitar.html#a3">setFrequency</a> (MY_FLOAT 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="Sitar::pluck" ></a>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classSitar.html#a4">pluck</a> (MY_FLOAT amplitude)</td></tr>
<tr><td class="mdescLeft">&nbsp;</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="Sitar::noteOn" ></a>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classSitar.html#a5">noteOn</a> (MY_FLOAT frequency, MY_FLOAT amplitude)</td></tr>
<tr><td class="mdescLeft">&nbsp;</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="Sitar::noteOff" ></a>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classSitar.html#a6">noteOff</a> (MY_FLOAT 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="a7" doxytag="Sitar::tick" ></a>
MY_FLOAT&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classSitar.html#a7">tick</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Compute one output sample. <br><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
STK sitar string model class.
<p>
This class implements a sitar 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.
STK sitar string model class.
<p>
This class implements a sitar 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>
<hr>The documentation for this class was generated from the following file:<ul>
<p>
Definition at line <a class="el" href="Sitar_8h-source.html#l00029">29</a> of file <a class="el" href="Sitar_8h-source.html">Sitar.h</a>.<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="Sitar_8h-source.html">Sitar.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>&copy;1995-2002 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
<tr><td>&copy;1995-2004 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
</table>
</BODY>