mirror of
https://github.com/thestk/stk
synced 2026-01-13 21:11:53 +00:00
124 lines
9.0 KiB
HTML
124 lines
9.0 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>Modal Class Reference</h1><!-- doxytag: class="Modal" --><!-- doxytag: inherits="Instrmnt" --><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.png" usemap="#Modal_map" border="0" alt=""></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><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 - 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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classModal.html#a0">Modal</a> (unsigned int modes=4)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Class constructor, taking the desired number of modes to create. <a href="#a0"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a1"></a><!-- doxytag: member="Modal::~Modal" ref="a1" args="()" -->
|
|
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classModal.html#a1">~Modal</a> ()</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="a2"></a><!-- doxytag: member="Modal::clear" ref="a2" args="()" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classModal.html#a2">clear</a> ()</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reset and clear all internal state. <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a3"></a><!-- doxytag: member="Modal::setFrequency" ref="a3" args="(StkFloat frequency)" -->
|
|
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classModal.html#a3">setFrequency</a> (StkFloat frequency)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set instrument parameters for a particular frequency. <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a4"></a><!-- doxytag: member="Modal::setRatioAndRadius" ref="a4" args="(unsigned int modeIndex, StkFloat ratio, StkFloat radius)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classModal.html#a4">setRatioAndRadius</a> (unsigned int modeIndex, StkFloat ratio, StkFloat radius)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the ratio and radius for a specified mode filter. <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a5"></a><!-- doxytag: member="Modal::setMasterGain" ref="a5" args="(StkFloat aGain)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classModal.html#a5">setMasterGain</a> (StkFloat aGain)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the master gain. <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a6"></a><!-- doxytag: member="Modal::setDirectGain" ref="a6" args="(StkFloat aGain)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classModal.html#a6">setDirectGain</a> (StkFloat aGain)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the direct gain. <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a7"></a><!-- doxytag: member="Modal::setModeGain" ref="a7" args="(unsigned int modeIndex, StkFloat gain)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classModal.html#a7">setModeGain</a> (unsigned int modeIndex, StkFloat gain)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the gain for a specified mode filter. <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a8"></a><!-- doxytag: member="Modal::strike" ref="a8" args="(StkFloat amplitude)" -->
|
|
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classModal.html#a8">strike</a> (StkFloat amplitude)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initiate a strike with the given amplitude (0.0 - 1.0). <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a9"></a><!-- doxytag: member="Modal::damp" ref="a9" args="(StkFloat amplitude)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classModal.html#a9">damp</a> (StkFloat amplitude)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Damp modes with a given decay factor (0.0 - 1.0). <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a10"></a><!-- doxytag: member="Modal::noteOn" ref="a10" args="(StkFloat frequency, StkFloat amplitude)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classModal.html#a10">noteOn</a> (StkFloat frequency, StkFloat amplitude)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Start a note with the given frequency and amplitude. <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a11"></a><!-- doxytag: member="Modal::noteOff" ref="a11" args="(StkFloat amplitude)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classModal.html#a11">noteOff</a> (StkFloat amplitude)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Stop a note with the given amplitude (speed of decay). <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a12"></a><!-- doxytag: member="Modal::controlChange" ref="a12" args="(int number, StkFloat value)=0" -->
|
|
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classModal.html#a12">controlChange</a> (int number, StkFloat value)=0</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Perform the control change specified by <em>number</em> and <em>value</em> (0.0 - 128.0). <br></td></tr>
|
|
</table>
|
|
<hr><h2>Constructor & Destructor Documentation</h2>
|
|
<a class="anchor" name="a0"></a><!-- doxytag: member="Modal::Modal" ref="a0" args="(unsigned int modes=4)" --><p>
|
|
<table class="mdTable" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">Modal::Modal </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top">unsigned int </td>
|
|
<td class="mdname1" valign="top" nowrap> <em>modes</em> = <code>4</code> </td>
|
|
<td class="md" valign="top"> ) </td>
|
|
<td class="md" nowrap></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Class constructor, taking the desired number of modes to create.
|
|
<p>
|
|
An <a class="el" href="classStkError.html">StkError</a> will be thrown if the rawwave path is incorrectly set. </td>
|
|
</tr>
|
|
</table>
|
|
<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://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>
|