mirror of
https://github.com/thestk/stk
synced 2026-01-13 13:01:52 +00:00
124 lines
11 KiB
HTML
124 lines
11 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.6.2 -->
|
|
<div class="navpath"><a class="el" href="namespacestk.html">stk</a>::<a class="el" href="classstk_1_1Envelope.html">Envelope</a>
|
|
</div>
|
|
<div class="contents">
|
|
<h1>stk::Envelope Class Reference</h1><!-- doxytag: class="stk::Envelope" --><!-- doxytag: inherits="stk::Generator" -->
|
|
<p>STK linear line envelope class.
|
|
<a href="#_details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="Envelope_8h_source.html">Envelope.h</a>></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for stk::Envelope:</div>
|
|
<div class="dynsection">
|
|
<div class="center">
|
|
<img src="classstk_1_1Envelope.png" usemap="#stk::Envelope_map" alt=""/>
|
|
<map id="stk::Envelope_map" name="stk::Envelope_map">
|
|
<area href="classstk_1_1Generator.html" alt="stk::Generator" shape="rect" coords="0,56,90,80"/>
|
|
<area href="classstk_1_1Stk.html" alt="stk::Stk" shape="rect" coords="0,0,90,24"/>
|
|
</map>
|
|
</div>
|
|
</div>
|
|
|
|
<p><a href="classstk_1_1Envelope-members.html">List of all members.</a></p>
|
|
<table border="0" cellpadding="0" cellspacing="0">
|
|
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a86ea29237a8d94c109388654703a0039"></a><!-- doxytag: member="stk::Envelope::Envelope" ref="a86ea29237a8d94c109388654703a0039" args="(void)" -->
|
|
</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Envelope.html#a86ea29237a8d94c109388654703a0039">Envelope</a> (void)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a64365d24b6cdd3ea3bdcaa1abcbcb60a"></a><!-- doxytag: member="stk::Envelope::~Envelope" ref="a64365d24b6cdd3ea3bdcaa1abcbcb60a" args="(void)" -->
|
|
</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Envelope.html#a64365d24b6cdd3ea3bdcaa1abcbcb60a">~Envelope</a> (void)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Class destructor. <br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a42a1acf6a4606163056ad7d4122d2281"></a><!-- doxytag: member="stk::Envelope::operator=" ref="a42a1acf6a4606163056ad7d4122d2281" args="(const Envelope &e)" -->
|
|
<a class="el" href="classstk_1_1Envelope.html">Envelope</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Envelope.html#a42a1acf6a4606163056ad7d4122d2281">operator=</a> (const <a class="el" href="classstk_1_1Envelope.html">Envelope</a> &e)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Assignment operator. <br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a18cf8f21ef70227bd5cd17f53752bd0f"></a><!-- doxytag: member="stk::Envelope::keyOn" ref="a18cf8f21ef70227bd5cd17f53752bd0f" args="(void)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Envelope.html#a18cf8f21ef70227bd5cd17f53752bd0f">keyOn</a> (void)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set target = 1. <br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9dbefb15f8d64aac3969f77d38791774"></a><!-- doxytag: member="stk::Envelope::keyOff" ref="a9dbefb15f8d64aac3969f77d38791774" args="(void)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Envelope.html#a9dbefb15f8d64aac3969f77d38791774">keyOff</a> (void)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set target = 0. <br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ade99b5c7cb974f71f1d2919868d774a0"></a><!-- doxytag: member="stk::Envelope::setRate" ref="ade99b5c7cb974f71f1d2919868d774a0" args="(StkFloat rate)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Envelope.html#ade99b5c7cb974f71f1d2919868d774a0">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" align="right" valign="top"><a class="anchor" id="adeeb1676f9111980a0c1a48a6780c8f7"></a><!-- doxytag: member="stk::Envelope::setTime" ref="adeeb1676f9111980a0c1a48a6780c8f7" args="(StkFloat time)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Envelope.html#adeeb1676f9111980a0c1a48a6780c8f7">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" align="right" valign="top"><a class="anchor" id="a5269bc5dc1d56161ab82b677b5462a3e"></a><!-- doxytag: member="stk::Envelope::setTarget" ref="a5269bc5dc1d56161ab82b677b5462a3e" args="(StkFloat target)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Envelope.html#a5269bc5dc1d56161ab82b677b5462a3e">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" align="right" valign="top"><a class="anchor" id="ab8164a90c57616dc8bd55a6e5ba02fb6"></a><!-- doxytag: member="stk::Envelope::setValue" ref="ab8164a90c57616dc8bd55a6e5ba02fb6" args="(StkFloat value)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Envelope.html#ab8164a90c57616dc8bd55a6e5ba02fb6">setValue</a> (StkFloat value)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set current and target values to <em>value</em>. <br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="addb2084add959a65733805bc2c1c39a9"></a><!-- doxytag: member="stk::Envelope::getState" ref="addb2084add959a65733805bc2c1c39a9" args="(void) const " -->
|
|
int </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Envelope.html#addb2084add959a65733805bc2c1c39a9">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>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a31044eab6eaf668ba7e74ea17bed109d"></a><!-- doxytag: member="stk::Envelope::lastOut" ref="a31044eab6eaf668ba7e74ea17bed109d" args="(void) const " -->
|
|
StkFloat </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Envelope.html#a31044eab6eaf668ba7e74ea17bed109d">lastOut</a> (void) const </td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the last computed output value. <br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8de91b9caf10a03f52bd2247648c4601"></a><!-- doxytag: member="stk::Envelope::tick" ref="a8de91b9caf10a03f52bd2247648c4601" args="(void)" -->
|
|
StkFloat </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Envelope.html#a8de91b9caf10a03f52bd2247648c4601">tick</a> (void)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Compute and return one output sample. <br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Envelope.html#a9341c9dea4fd54c360a4a23254319cf7">tick</a> (<a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> &frames, unsigned int channel=0)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Fill a channel of the <a class="el" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a> object with computed outputs. <a href="#a9341c9dea4fd54c360a4a23254319cf7"></a><br/></td></tr>
|
|
</table>
|
|
<hr/><a name="_details"></a><h2>Detailed Description</h2>
|
|
<p>STK linear line envelope class. </p>
|
|
<p>This class implements a simple linear line envelope generator which is capable of ramping to an arbitrary 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>
|
|
<p>by Perry R. Cook and Gary P. Scavone, 1995 - 2010. </p>
|
|
<hr/><h2>Member Function Documentation</h2>
|
|
<a class="anchor" id="a9341c9dea4fd54c360a4a23254319cf7"></a><!-- doxytag: member="stk::Envelope::tick" ref="a9341c9dea4fd54c360a4a23254319cf7" args="(StkFrames &frames, unsigned int channel=0)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> & stk::Envelope::tick </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> & </td>
|
|
<td class="paramname"> <em>frames</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">unsigned int </td>
|
|
<td class="paramname"> <em>channel</em> = <code>0</code></td><td> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td><td><code> [inline, virtual]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Fill a channel of the <a class="el" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a> object with computed outputs. </p>
|
|
<p>The <code>channel</code> argument must be less than the number of channels in the <a class="el" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a> argument (the first channel is specified by 0). However, range checking is only performed if _STK_DEBUG_ is defined during compilation, in which case an out-of-range value will trigger an <a class="el" href="classstk_1_1StkError.html" title="STK error handling class.">StkError</a> exception. </p>
|
|
|
|
<p>Implements <a class="el" href="classstk_1_1Generator.html#a86bb0421223cf27e25704d5f27b97425">stk::Generator</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<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></li>
|
|
</ul>
|
|
</div>
|
|
<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-2010 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
|
|
</table>
|
|
|
|
</BODY>
|
|
</HTML>
|