mirror of
https://github.com/thestk/stk
synced 2026-01-12 04:21:52 +00:00
111 lines
8.2 KiB
HTML
111 lines
8.2 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="tutorial.html">Tutorial</a></CENTER>
|
|
<HR>
|
|
<!-- Generated by Doxygen 1.3.4 -->
|
|
<h1>Instrmnt Class Reference</h1>STK instrument abstract base class.
|
|
<a href="#_details">More...</a>
|
|
<p>
|
|
<code>#include <<a class="el" href="Instrmnt_8h-source.html">Instrmnt.h</a>></code>
|
|
<p>
|
|
<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">
|
|
<area href="classBlowBotl.html" alt="BlowBotl" shape="rect" coords="85,168,160,192">
|
|
<area href="classBlowHole.html" alt="BlowHole" shape="rect" coords="85,224,160,248">
|
|
<area href="classBowed.html" alt="Bowed" shape="rect" coords="85,280,160,304">
|
|
<area href="classBrass.html" alt="Brass" shape="rect" coords="85,336,160,360">
|
|
<area href="classClarinet.html" alt="Clarinet" shape="rect" coords="85,392,160,416">
|
|
<area href="classDrummer.html" alt="Drummer" shape="rect" coords="85,448,160,472">
|
|
<area href="classFlute.html" alt="Flute" shape="rect" coords="85,504,160,528">
|
|
<area href="classFM.html" alt="FM" shape="rect" coords="85,560,160,584">
|
|
<area href="classMesh2D.html" alt="Mesh2D" shape="rect" coords="85,616,160,640">
|
|
<area href="classModal.html" alt="Modal" shape="rect" coords="85,672,160,696">
|
|
<area href="classPlucked.html" alt="Plucked" shape="rect" coords="85,728,160,752">
|
|
<area href="classPluckTwo.html" alt="PluckTwo" shape="rect" coords="85,784,160,808">
|
|
<area href="classResonate.html" alt="Resonate" shape="rect" coords="85,840,160,864">
|
|
<area href="classSampler.html" alt="Sampler" shape="rect" coords="85,896,160,920">
|
|
<area href="classSaxofony.html" alt="Saxofony" shape="rect" coords="85,952,160,976">
|
|
<area href="classShakers.html" alt="Shakers" shape="rect" coords="85,1008,160,1032">
|
|
<area href="classSimple.html" alt="Simple" shape="rect" coords="85,1064,160,1088">
|
|
<area href="classSitar.html" alt="Sitar" shape="rect" coords="85,1120,160,1144">
|
|
<area href="classStifKarp.html" alt="StifKarp" shape="rect" coords="85,1176,160,1200">
|
|
<area href="classVoicForm.html" alt="VoicForm" shape="rect" coords="85,1232,160,1256">
|
|
<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></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>
|
|
</td><td class="memItemRight" valign=bottom><a class="el" href="classInstrmnt.html#a0">Instrmnt</a> ()</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </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 </td><td class="memItemRight" valign=bottom><a class="el" href="classInstrmnt.html#a1">~Instrmnt</a> ()</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </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 </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"> </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 </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"> </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 </td><td class="memItemRight" valign=bottom><a class="el" href="classInstrmnt.html#a4">setFrequency</a> (MY_FLOAT frequency)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </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 </td><td class="memItemRight" valign=bottom><a class="el" href="classInstrmnt.html#a5">lastOut</a> () const </td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </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 </td><td class="memItemRight" valign=bottom><a class="el" href="classInstrmnt.html#a6">lastOutLeft</a> () const </td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </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 </td><td class="memItemRight" valign=bottom><a class="el" href="classInstrmnt.html#a7">lastOutRight</a> () const </td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </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 </td><td class="memItemRight" valign=bottom><a class="el" href="classInstrmnt.html#a8">tick</a> ()=0</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </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 * </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"> </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 </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"> </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.<p>
|
|
by Perry R. Cook and Gary P. Scavone, 1995 - 2002.
|
|
<p>
|
|
|
|
<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>©1995-2004 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
|
|
</table>
|
|
|
|
</BODY>
|
|
</HTML>
|