mirror of
https://github.com/thestk/stk
synced 2026-01-12 12:31:53 +00:00
87 lines
6.6 KiB
HTML
87 lines
6.6 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>Modal Class Reference</h1>STK resonance model instrument.
|
|
<a href="#_details">More...</a>
|
|
<p>
|
|
<code>#include <<a class="el" href="Modal_8h-source.html">Modal.h</a>></code>
|
|
<p>
|
|
<p>Inheritance diagram for Modal::
|
|
<p><center><img src="classModal.gif" usemap="#Modal_map" border="0"></center>
|
|
<map name="Modal_map">
|
|
<area href="classInstrmnt.html" alt="Instrmnt" shape="rect" coords="0,56,67,80">
|
|
<area href="classStk.html" alt="Stk" shape="rect" coords="0,0,67,24">
|
|
<area href="classModalBar.html" alt="ModalBar" shape="rect" coords="0,168,67,192">
|
|
</map>
|
|
<a href="classModal-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="Modal::Modal"></a>
|
|
</td><td valign=bottom><a class="el" href="classModal.html#a0">Modal</a> (int modes=4)</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Class constructor, taking the desired number of modes to create.</em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="a1" doxytag="Modal::~Modal"></a>
|
|
virtual </td><td valign=bottom><a class="el" href="classModal.html#a1">~Modal</a> ()</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="Modal::clear"></a>
|
|
void </td><td valign=bottom><a class="el" href="classModal.html#a2">clear</a> ()</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Reset and clear all internal state.</em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="a3" doxytag="Modal::setFrequency"></a>
|
|
virtual void </td><td valign=bottom><a class="el" href="classModal.html#a3">setFrequency</a> (MY_FLOAT frequency)</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Set instrument parameters for a particular frequency.</em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="a4" doxytag="Modal::setRatioAndRadius"></a>
|
|
void </td><td valign=bottom><a class="el" href="classModal.html#a4">setRatioAndRadius</a> (int modeIndex, MY_FLOAT ratio, MY_FLOAT radius)</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Set the ratio and radius for a specified mode filter.</em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="a5" doxytag="Modal::setMasterGain"></a>
|
|
void </td><td valign=bottom><a class="el" href="classModal.html#a5">setMasterGain</a> (MY_FLOAT aGain)</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Set the master gain.</em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="a6" doxytag="Modal::setDirectGain"></a>
|
|
void </td><td valign=bottom><a class="el" href="classModal.html#a6">setDirectGain</a> (MY_FLOAT aGain)</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Set the direct gain.</em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="a7" doxytag="Modal::setModeGain"></a>
|
|
void </td><td valign=bottom><a class="el" href="classModal.html#a7">setModeGain</a> (int modeIndex, MY_FLOAT gain)</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Set the gain for a specified mode filter.</em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="a8" doxytag="Modal::strike"></a>
|
|
virtual void </td><td valign=bottom><a class="el" href="classModal.html#a8">strike</a> (MY_FLOAT amplitude)</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Initiate a strike with the given amplitude (0.0 - 1.0).</em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="a9" doxytag="Modal::damp"></a>
|
|
void </td><td valign=bottom><a class="el" href="classModal.html#a9">damp</a> (MY_FLOAT amplitude)</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Damp modes with a given decay factor (0.0 - 1.0).</em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="a10" doxytag="Modal::noteOn"></a>
|
|
void </td><td valign=bottom><a class="el" href="classModal.html#a10">noteOn</a> (MY_FLOAT frequency, MY_FLOAT amplitude)</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Start a note with the given frequency and amplitude.</em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="a11" doxytag="Modal::noteOff"></a>
|
|
void </td><td valign=bottom><a class="el" href="classModal.html#a11">noteOff</a> (MY_FLOAT amplitude)</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Stop a note with the given amplitude (speed of decay).</em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="a12" doxytag="Modal::tick"></a>
|
|
virtual MY_FLOAT </td><td valign=bottom><a class="el" href="classModal.html#a12">tick</a> ()</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Compute one output sample.</em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="a13" doxytag="Modal::controlChange"></a>
|
|
virtual void </td><td valign=bottom><a class="el" href="classModal.html#a13">controlChange</a> (int number, MY_FLOAT value)=0</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Perform the control change specified by <em>number</em> and <em>value</em> (0.0 - 128.0).</em></font><br><br></td></tr>
|
|
</table>
|
|
<hr><a name="_details"></a><h2>Detailed Description</h2>
|
|
STK resonance model instrument.
|
|
<p>
|
|
This class contains an excitation wavetable, an envelope, an oscillator, and N resonances (non-sweeping <a class="el" href="classBiQuad.html">BiQuad</a> filters), where N is set during instantiation.
|
|
<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="Modal_8h-source.html">Modal.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>
|