mirror of
https://github.com/thestk/stk
synced 2026-01-13 21:11:53 +00:00
87 lines
7.1 KiB
HTML
87 lines
7.1 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="faq.html">FAQ</a> <a class="qindex" href="tutorial.html">Tutorial</a></CENTER>
|
|
<HR>
|
|
<!-- Generated by Doxygen 1.4.4 -->
|
|
<h1>Envelope Class Reference</h1><!-- doxytag: class="Envelope" --><!-- doxytag: inherits="Generator" --><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.png" usemap="#Envelope_map" border="0" alt=""></center>
|
|
<map name="Envelope_map">
|
|
<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><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 - 2007.
|
|
<p>
|
|
<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"></a><!-- doxytag: member="Envelope::Envelope" ref="a0" args="(void)" -->
|
|
</td><td class="memItemRight" valign="bottom"><a class="el" href="classEnvelope.html#a0">Envelope</a> (void)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </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="Envelope::Envelope" ref="a1" args="(const Envelope &e)" -->
|
|
</td><td class="memItemRight" valign="bottom"><a class="el" href="classEnvelope.html#a1">Envelope</a> (const <a class="el" href="classEnvelope.html">Envelope</a> &e)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Copy constructor. <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a2"></a><!-- doxytag: member="Envelope::~Envelope" ref="a2" args="(void)" -->
|
|
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classEnvelope.html#a2">~Envelope</a> (void)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Class destructor. <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a3"></a><!-- doxytag: member="Envelope::operator=" ref="a3" args="(const Envelope &e)" -->
|
|
<a class="el" href="classEnvelope.html">Envelope</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classEnvelope.html#a3">operator=</a> (const <a class="el" href="classEnvelope.html">Envelope</a> &e)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Assignment operator. <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a4"></a><!-- doxytag: member="Envelope::keyOn" ref="a4" args="(void)" -->
|
|
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classEnvelope.html#a4">keyOn</a> (void)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set target = 1. <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a5"></a><!-- doxytag: member="Envelope::keyOff" ref="a5" args="(void)" -->
|
|
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classEnvelope.html#a5">keyOff</a> (void)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set target = 0. <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a6"></a><!-- doxytag: member="Envelope::setRate" ref="a6" args="(StkFloat rate)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classEnvelope.html#a6">setRate</a> (StkFloat rate)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the <em>rate</em>. <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a7"></a><!-- doxytag: member="Envelope::setTime" ref="a7" args="(StkFloat time)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classEnvelope.html#a7">setTime</a> (StkFloat time)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the <em>rate</em> based on a time duration. <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a8"></a><!-- doxytag: member="Envelope::setTarget" ref="a8" args="(StkFloat target)" -->
|
|
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classEnvelope.html#a8">setTarget</a> (StkFloat target)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the target value. <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a9"></a><!-- doxytag: member="Envelope::setValue" ref="a9" args="(StkFloat value)" -->
|
|
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classEnvelope.html#a9">setValue</a> (StkFloat value)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set current and target values to <em>aValue</em>. <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a10"></a><!-- doxytag: member="Envelope::getState" ref="a10" args="(void) const " -->
|
|
virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classEnvelope.html#a10">getState</a> (void) const </td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the current envelope <em>state</em> (0 = at target, 1 otherwise). <br></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://ccrma.stanford.edu/software/stk/"><I>The Synthesis ToolKit in C++ (STK)</I></A></td></tr>
|
|
<tr><td>©1995-2007 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
|
|
</table>
|
|
|
|
</BODY>
|
|
</HTML>
|