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

105
doc/html/classInstrmnt.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>Instrmnt Class Reference</h1><code>#include &lt;<a class="el" href="Instrmnt_8h-source.html">Instrmnt.h</a>&gt;</code>
<!-- Generated by Doxygen 1.4.4 -->
<h1>Instrmnt Class Reference</h1><!-- doxytag: class="Instrmnt" --><!-- doxytag: inherits="Stk" --><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.png" usemap="#Instrmnt_map" border="0" alt=""></center>
@@ -42,90 +42,83 @@
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 - 2004.
by Perry R. Cook and Gary P. Scavone, 1995 - 2005.
<p>
<p>
Definition at line <a class="el" href="Instrmnt_8h-source.html#l00017">17</a> of file <a class="el" href="Instrmnt_8h-source.html">Instrmnt.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="Instrmnt::Instrmnt" ></a>
&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classInstrmnt.html#a0">Instrmnt</a> ()</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="Instrmnt::Instrmnt" ref="a0" args="()" -->
&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">Default constructor. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a1"></a><!-- doxytag: member="Instrmnt::~Instrmnt" ref="a1" args="()" -->
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> (StkFloat frequency, StkFloat amplitude)=0</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="Instrmnt::noteOn" ref="a2" args="(StkFloat frequency, StkFloat amplitude)=0" -->
virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classInstrmnt.html#a2">noteOn</a> (StkFloat frequency, StkFloat 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> (StkFloat amplitude)=0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Start a note with the given frequency and amplitude. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a3"></a><!-- doxytag: member="Instrmnt::noteOff" ref="a3" args="(StkFloat amplitude)=0" -->
virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classInstrmnt.html#a3">noteOff</a> (StkFloat 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> (StkFloat frequency)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Stop a note with the given amplitude (speed of decay). <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a4"></a><!-- doxytag: member="Instrmnt::setFrequency" ref="a4" args="(StkFloat frequency)" -->
virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classInstrmnt.html#a4">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="a5" doxytag="Instrmnt::lastOut" ></a>
StkFloat&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">Set instrument parameters for a particular frequency. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a5"></a><!-- doxytag: member="Instrmnt::lastOut" ref="a5" args="() const " -->
StkFloat&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>
StkFloat&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 output value. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a6"></a><!-- doxytag: member="Instrmnt::lastOutLeft" ref="a6" args="() const " -->
StkFloat&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>
StkFloat&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 left output value. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a7"></a><!-- doxytag: member="Instrmnt::lastOutRight" ref="a7" args="() const " -->
StkFloat&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 StkFloat&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">Return the last right output value. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a8"></a><!-- doxytag: member="Instrmnt::tick" ref="a8" args="(void)" -->
StkFloat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classInstrmnt.html#a8">tick</a> (void)</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 StkFloat *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classInstrmnt.html#a9">tick</a> (StkFloat *vector, unsigned int vectorSize)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Compute one sample and output. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classStkFrames.html">StkFrames</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classInstrmnt.html#a9">tick</a> (<a class="el" href="classStkFrames.html">StkFrames</a> &amp;frames, unsigned int channel=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="classInstrmnt.html#a10">tick</a> (<a class="el" href="classStkFrames.html">StkFrames</a> &amp;frames, unsigned int channel=1)</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. <a href="#a9"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a10"></a><!-- doxytag: member="Instrmnt::controlChange" ref="a10" args="(int number, StkFloat value)" -->
virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classInstrmnt.html#a10">controlChange</a> (int number, StkFloat value)</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="#a10"></a><em><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a11" doxytag="Instrmnt::controlChange" ></a>
virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classInstrmnt.html#a11">controlChange</a> (int number, StkFloat 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>
<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></td></tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="a10" doxytag="Instrmnt::tick" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<a class="anchor" name="a9"></a><!-- doxytag: member="Instrmnt::tick" ref="a9" args="(StkFrames &amp;frames, unsigned int channel=0)" --><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"> virtual <a class="el" href="classStkFrames.html">StkFrames</a>&amp; Instrmnt::tick </td>
<td class="md" nowrap valign="top"><a class="el" href="classStkFrames.html">StkFrames</a>&amp; Instrmnt::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 align="right"></td>
<td class="md"></td>
<td class="md" nowrap>unsigned int&nbsp;</td>
<td class="mdname" nowrap> <em>channel</em> = 1</td>
<td class="mdname" nowrap> <em>channel</em> = <code>0</code></td>
</tr>
<tr>
<td></td>
<td class="md"></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"><code> [virtual]</code></td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
@@ -135,9 +128,7 @@ virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href
<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 in <a class="el" href="classBandedWG.html#a13">BandedWG</a>, <a class="el" href="classBeeThree.html#a5">BeeThree</a>, <a class="el" href="classBlowBotl.html#a10">BlowBotl</a>, <a class="el" href="classBlowHole.html#a12">BlowHole</a>, <a class="el" href="classBowed.html#a11">Bowed</a>, <a class="el" href="classBrass.html#a11">Brass</a>, <a class="el" href="classClarinet.html#a10">Clarinet</a>, <a class="el" href="classDrummer.html#a6">Drummer</a>, <a class="el" href="classFlute.html#a13">Flute</a>, <a class="el" href="classFM.html#a16">FM</a>, <a class="el" href="classFMVoices.html#a6">FMVoices</a>, <a class="el" href="classHevyMetl.html#a5">HevyMetl</a>, <a class="el" href="classMandolin.html#a8">Mandolin</a>, <a class="el" href="classMesh2D.html#a13">Mesh2D</a>, <a class="el" href="classModal.html#a14">Modal</a>, <a class="el" href="classMoog.html#a8">Moog</a>, <a class="el" href="classPercFlut.html#a6">PercFlut</a>, <a class="el" href="classPlucked.html#a9">Plucked</a>, <a class="el" href="classPluckTwo.html#a11">PluckTwo</a>, <a class="el" href="classResonate.html#a12">Resonate</a>, <a class="el" href="classRhodey.html#a6">Rhodey</a>, <a class="el" href="classSampler.html#a9">Sampler</a>, <a class="el" href="classSaxofony.html#a11">Saxofony</a>, <a class="el" href="classShakers.html#a6">Shakers</a>, <a class="el" href="classSimple.html#a10">Simple</a>, <a class="el" href="classSitar.html#a9">Sitar</a>, <a class="el" href="classStifKarp.html#a12">StifKarp</a>, <a class="el" href="classTubeBell.html#a5">TubeBell</a>, <a class="el" href="classVoicForm.html#a15">VoicForm</a>, <a class="el" href="classWhistle.html#a10">Whistle</a>, and <a class="el" href="classWurley.html#a6">Wurley</a>. </td>
The <code>channel</code> argument should be zero or greater (the first channel is specified by 0). An <a class="el" href="classStkError.html">StkError</a> will be thrown if the <code>channel</code> argument is equal to or greater than the number of channels in the <a class="el" href="classStkFrames.html">StkFrames</a> object. </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
@@ -146,7 +137,7 @@ Reimplemented in <a class="el" href="classBandedWG.html#a13">BandedWG</a>, <a cl
<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>