mirror of
https://github.com/thestk/stk
synced 2026-01-13 13:01:52 +00:00
80 lines
5.8 KiB
HTML
80 lines
5.8 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"><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.2.8.1 -->
|
|
<h1>Envelope Class Reference</h1>STK envelope base class.
|
|
<a href="#_details">More...</a>
|
|
<p>
|
|
<code>#include <<a class="el" href="Envelope_8h-source.html">Envelope.h</a>></code>
|
|
<p>
|
|
<p>Inheritance diagram for Envelope::
|
|
<p><center><img src="classEnvelope.gif" usemap="#Envelope_map" border="0"></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">
|
|
</map>
|
|
<a href="classEnvelope-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="Envelope::Envelope"></a>
|
|
</td><td valign=bottom><a class="el" href="classEnvelope.html#a0">Envelope</a> (void)</td></tr>
|
|
<tr><td> </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="Envelope::~Envelope"></a>
|
|
virtual </td><td valign=bottom><a class="el" href="classEnvelope.html#a1">~Envelope</a> (void)</td></tr>
|
|
<tr><td> </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="Envelope::keyOn"></a>
|
|
virtual void </td><td valign=bottom><a class="el" href="classEnvelope.html#a2">keyOn</a> (void)</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Set target = 1.</em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="a3" doxytag="Envelope::keyOff"></a>
|
|
virtual void </td><td valign=bottom><a class="el" href="classEnvelope.html#a3">keyOff</a> (void)</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Set target = 0.</em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="a4" doxytag="Envelope::setRate"></a>
|
|
void </td><td valign=bottom><a class="el" href="classEnvelope.html#a4">setRate</a> (MY_FLOAT aRate)</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Set the <em>rate</em>.</em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="a5" doxytag="Envelope::setTime"></a>
|
|
void </td><td valign=bottom><a class="el" href="classEnvelope.html#a5">setTime</a> (MY_FLOAT aTime)</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Set the <em>rate</em> based on a time duration.</em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="a6" doxytag="Envelope::setTarget"></a>
|
|
virtual void </td><td valign=bottom><a class="el" href="classEnvelope.html#a6">setTarget</a> (MY_FLOAT aTarget)</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Set the target value.</em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="a7" doxytag="Envelope::setValue"></a>
|
|
virtual void </td><td valign=bottom><a class="el" href="classEnvelope.html#a7">setValue</a> (MY_FLOAT aValue)</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Set current and target values to <em>aValue</em>.</em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="a8" doxytag="Envelope::getState"></a>
|
|
virtual int </td><td valign=bottom><a class="el" href="classEnvelope.html#a8">getState</a> (void) const</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Return the current envelope <em>state</em> (0 = at target, 1 otherwise).</em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="a9" doxytag="Envelope::tick"></a>
|
|
virtual MY_FLOAT </td><td valign=bottom><a class="el" href="classEnvelope.html#a9">tick</a> (void)</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Return one envelope output value.</em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="a10" doxytag="Envelope::tick"></a>
|
|
virtual MY_FLOAT* </td><td valign=bottom><a class="el" href="classEnvelope.html#a10">tick</a> (MY_FLOAT *vector, unsigned int vectorSize)</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Return <em>vectorSize</em> envelope outputs in <em>vector</em>.</em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="a11" doxytag="Envelope::lastOut"></a>
|
|
MY_FLOAT </td><td valign=bottom><a class="el" href="classEnvelope.html#a11">lastOut</a> (void) const</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Return the last computed output value.</em></font><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>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>©1995-2002 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
|
|
</table>
|
|
|
|
</BODY>
|
|
</HTML>
|