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

Release 4.2.0 tarball

Browse Source
This commit is contained in:
Gary Scavone
2013-09-29 23:39:37 +02:00
committed by Stephen Sinclair
parent fe20fe92a2
commit de344668dd
347 changed files with 16972 additions and 8538 deletions
Download Patch File Download Diff File Expand all files Collapse all files

93
doc/html/classEnvelope.html
View File

@@ -9,18 +9,25 @@
<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>Envelope Class Reference</h1>STK envelope base class.
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="Envelope_8h-source.html">Envelope.h</a>&gt;</code>
<h1>Envelope Class Reference</h1><code>#include &lt;<a class="el" href="Envelope_8h-source.html">Envelope.h</a>&gt;</code>
<p>
<p>Inheritance diagram for Envelope:
<p><center><img src="classEnvelope.png" usemap="#Envelope_map" border="0" alt=""></center>
<map name="Envelope_map">
<area href="classStk.html" alt="Stk" shape="rect" coords="0,0,65,24">
<area href="classADSR.html" alt="ADSR" shape="rect" coords="0,112,65,136">
<area href="classGenerator.html" alt="Generator" shape="rect" coords="39,56,108,80">
<area href="classStk.html" alt="Stk" shape="rect" coords="39,0,108,24">
<area href="classADSR.html" alt="ADSR" shape="rect" coords="0,168,69,192">
<area href="classAsymp.html" alt="Asymp" shape="rect" coords="79,168,148,192">
</map>
<a href="classEnvelope-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
<a href="classEnvelope-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
STK envelope base class.
<p>
This class implements a simple envelope generator which is capable of ramping to a target value by a specified <em>rate</em>. It also responds to simple <em>keyOn</em> and <em>keyOff</em> messages, ramping to 1.0 on keyOn and to 0.0 on keyOff.<p>
by Perry R. Cook and Gary P. Scavone, 1995 - 2004.
<p>
<p>
Definition at line <a class="el" href="Envelope_8h-source.html#l00021">21</a> of file <a class="el" href="Envelope_8h-source.html">Envelope.h</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="Envelope::Envelope" ></a>
@@ -40,19 +47,19 @@ virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set target = 0. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a4" doxytag="Envelope::setRate" ></a>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classEnvelope.html#a4">setRate</a> (MY_FLOAT aRate)</td></tr>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classEnvelope.html#a4">setRate</a> (StkFloat rate)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the <em>rate</em>. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a5" doxytag="Envelope::setTime" ></a>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classEnvelope.html#a5">setTime</a> (MY_FLOAT aTime)</td></tr>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classEnvelope.html#a5">setTime</a> (StkFloat time)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the <em>rate</em> based on a time duration. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a6" doxytag="Envelope::setTarget" ></a>
virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classEnvelope.html#a6">setTarget</a> (MY_FLOAT aTarget)</td></tr>
virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classEnvelope.html#a6">setTarget</a> (StkFloat target)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the target value. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a7" doxytag="Envelope::setValue" ></a>
virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classEnvelope.html#a7">setValue</a> (MY_FLOAT aValue)</td></tr>
virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classEnvelope.html#a7">setValue</a> (StkFloat value)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set current and target values to <em>aValue</em>. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a8" doxytag="Envelope::getState" ></a>
@@ -60,32 +67,68 @@ virtual int&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href=
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the current envelope <em>state</em> (0 = at target, 1 otherwise). <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a9" doxytag="Envelope::tick" ></a>
virtual MY_FLOAT&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classEnvelope.html#a9">tick</a> (void)</td></tr>
virtual StkFloat&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classEnvelope.html#a9">tick</a> (void)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return one envelope output value. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a10" doxytag="Envelope::tick" ></a>
virtual MY_FLOAT *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classEnvelope.html#a10">tick</a> (MY_FLOAT *vector, unsigned int vectorSize)</td></tr>
virtual StkFloat *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classEnvelope.html#a10">tick</a> (StkFloat *vector, unsigned int vectorSize)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return <em>vectorSize</em> envelope outputs in <em>vector</em>. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a11" doxytag="Envelope::lastOut" ></a>
MY_FLOAT&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classEnvelope.html#a11">lastOut</a> (void) const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Compute <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="classEnvelope.html#a11">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">Return the last computed output value. <br><br></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>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
STK envelope base class.
<p>
This class implements a simple envelope generator which is capable of ramping to a target value by a specified <em>rate</em>. It also responds to simple <em>keyOn</em> and <em>keyOff</em> messages, ramping to 1.0 on keyOn and to 0.0 on keyOff.<p>
by Perry R. Cook and Gary P. Scavone, 1995 - 2002.
<p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="a11" doxytag="Envelope::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; Envelope::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> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Definition at line <a class="el" href="Envelope_8h-source.html#l00021">21</a> of file <a class="el" href="Envelope_8h-source.html">Envelope.h</a>.<hr>The documentation for this class was generated from the following file:<ul>
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="classGenerator.html#a5">Generator</a>.
<p>
Reimplemented in <a class="el" href="classADSR.html#a17">ADSR</a>, and <a class="el" href="classAsymp.html#a9">Asymp</a>. </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="Envelope_8h-source.html">Envelope.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><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>
</table>