e1lama/stk
1
0
Fork 0
mirror of https://github.com/thestk/stk synced 2026-01-18 07:01:53 +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

95
doc/html/classInstrmnt.html
View File

@@ -5,17 +5,17 @@
</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>Instrmnt Class Reference</h1>STK instrument abstract base class.
<!-- Generated by Doxygen 1.3.6 -->
<h1>Instrmnt Class Reference</h1>STK instrument abstract base class.
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="Instrmnt_8h-source.html">Instrmnt.h</a>&gt;</code>
<p>
<p>Inheritance diagram for Instrmnt::
<p><center><img src="classInstrmnt.gif" usemap="#Instrmnt_map" border="0"></center>
<p>Inheritance diagram for Instrmnt:
<p><center><img src="classInstrmnt.png" usemap="#Instrmnt_map" border="0" alt=""></center>
<map name="Instrmnt_map">
<area href="classStk.html" alt="Stk" shape="rect" coords="0,0,75,24">
<area href="classBandedWG.html" alt="BandedWG" shape="rect" coords="85,112,160,136">
@@ -42,49 +42,68 @@
<area href="classWhistle.html" alt="Whistle" shape="rect" coords="85,1288,160,1312">
</map>
<a href="classInstrmnt-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="Instrmnt::Instrmnt"></a>
&nbsp;</td><td valign=bottom><a class="el" href="classInstrmnt.html#a0">Instrmnt</a> ()</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Default constructor.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="a1" doxytag="Instrmnt::~Instrmnt"></a>
virtual&nbsp;</td><td valign=bottom><a class="el" href="classInstrmnt.html#a1">~Instrmnt</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="Instrmnt::noteOn"></a>
virtual void&nbsp;</td><td valign=bottom><a class="el" href="classInstrmnt.html#a2">noteOn</a> (MY_FLOAT frequency, MY_FLOAT amplitude)=0</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="a3" doxytag="Instrmnt::noteOff"></a>
virtual void&nbsp;</td><td valign=bottom><a class="el" href="classInstrmnt.html#a3">noteOff</a> (MY_FLOAT amplitude)=0</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="a4" doxytag="Instrmnt::setFrequency"></a>
virtual void&nbsp;</td><td valign=bottom><a class="el" href="classInstrmnt.html#a4">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="a5" doxytag="Instrmnt::lastOut"></a>
MY_FLOAT&nbsp;</td><td valign=bottom><a class="el" href="classInstrmnt.html#a5">lastOut</a> () const</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Return the last output value.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="a6" doxytag="Instrmnt::tick"></a>
virtual MY_FLOAT&nbsp;</td><td valign=bottom><a class="el" href="classInstrmnt.html#a6">tick</a> ()=0</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Compute one output sample.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="a7" doxytag="Instrmnt::tick"></a>
virtual MY_FLOAT*&nbsp;</td><td valign=bottom><a class="el" href="classInstrmnt.html#a7">tick</a> (MY_FLOAT *vector, unsigned int vectorSize)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Computer <em>vectorSize</em> outputs and return them in <em>vector</em>.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="a8" doxytag="Instrmnt::controlChange"></a>
virtual void&nbsp;</td><td valign=bottom><a class="el" href="classInstrmnt.html#a8">controlChange</a> (int number, MY_FLOAT value)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Perform the control change specified by <em>number</em> and <em>value</em> (0.0 - 128.0).</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="Instrmnt::Instrmnt" ></a>
&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classInstrmnt.html#a0">Instrmnt</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a1" doxytag="Instrmnt::~Instrmnt" ></a>
virtual&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classInstrmnt.html#a1">~Instrmnt</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="Instrmnt::noteOn" ></a>
virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classInstrmnt.html#a2">noteOn</a> (MY_FLOAT frequency, MY_FLOAT amplitude)=0</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="a3" doxytag="Instrmnt::noteOff" ></a>
virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classInstrmnt.html#a3">noteOff</a> (MY_FLOAT amplitude)=0</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="a4" doxytag="Instrmnt::setFrequency" ></a>
virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classInstrmnt.html#a4">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="a5" doxytag="Instrmnt::lastOut" ></a>
MY_FLOAT&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classInstrmnt.html#a5">lastOut</a> () const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the last output value. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a6" doxytag="Instrmnt::lastOutLeft" ></a>
MY_FLOAT&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classInstrmnt.html#a6">lastOutLeft</a> () const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the last left output value. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a7" doxytag="Instrmnt::lastOutRight" ></a>
MY_FLOAT&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classInstrmnt.html#a7">lastOutRight</a> () const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the last right output value. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a8" doxytag="Instrmnt::tick" ></a>
virtual MY_FLOAT&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classInstrmnt.html#a8">tick</a> ()=0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Compute one output sample. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a9" doxytag="Instrmnt::tick" ></a>
virtual MY_FLOAT *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classInstrmnt.html#a9">tick</a> (MY_FLOAT *vector, unsigned int vectorSize)</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><a class="anchor" name="a10" doxytag="Instrmnt::controlChange" ></a>
virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classInstrmnt.html#a10">controlChange</a> (int number, MY_FLOAT value)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Perform the control change specified by <em>number</em> and <em>value</em> (0.0 - 128.0). <br><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
STK instrument abstract base class.
<p>
This class provides a common interface for all STK instruments.
STK instrument abstract base class.
<p>
This class provides a common interface for all STK instruments.<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="Instrmnt_8h-source.html#l00018">18</a> of file <a class="el" href="Instrmnt_8h-source.html">Instrmnt.h</a>.<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="Instrmnt_8h-source.html">Instrmnt.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>