mirror of
https://github.com/thestk/stk
synced 2026-01-13 13:01:52 +00:00
131 lines
11 KiB
HTML
131 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.5.8 -->
|
|
<div class="navpath"><a class="el" href="namespacestk.html">stk</a>::<a class="el" href="classstk_1_1Modal.html">Modal</a>
|
|
</div>
|
|
<div class="contents">
|
|
<h1>stk::Modal Class Reference</h1><!-- doxytag: class="stk::Modal" --><!-- doxytag: inherits="stk::Instrmnt" -->STK resonance model abstract base class.
|
|
<a href="#_details">More...</a>
|
|
<p>
|
|
<code>#include <<a class="el" href="Modal_8h-source.html">Modal.h</a>></code>
|
|
<p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for stk::Modal:</div>
|
|
<div class="dynsection">
|
|
|
|
<p><center><img src="classstk_1_1Modal.png" usemap="#stk::Modal_map" border="0" alt=""></center>
|
|
<map name="stk::Modal_map">
|
|
<area href="classstk_1_1Instrmnt.html" alt="stk::Instrmnt" shape="rect" coords="0,56,88,80">
|
|
<area href="classstk_1_1Stk.html" alt="stk::Stk" shape="rect" coords="0,0,88,24">
|
|
<area href="classstk_1_1ModalBar.html" alt="stk::ModalBar" shape="rect" coords="0,168,88,192">
|
|
</map>
|
|
</div>
|
|
|
|
<p>
|
|
<a href="classstk_1_1Modal-members.html">List of all members.</a><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="classstk_1_1Modal.html#f6bfea135e80abb5537e62cf099c989a">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="#f6bfea135e80abb5537e62cf099c989a"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7f45379ae10495b7a864cade0063705a"></a><!-- doxytag: member="stk::Modal::~Modal" ref="7f45379ae10495b7a864cade0063705a" args="(void)" -->
|
|
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Modal.html#7f45379ae10495b7a864cade0063705a">~Modal</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="f064dc6ee4290fd51b4a6dc8a1f0909d"></a><!-- doxytag: member="stk::Modal::clear" ref="f064dc6ee4290fd51b4a6dc8a1f0909d" args="(void)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Modal.html#f064dc6ee4290fd51b4a6dc8a1f0909d">clear</a> (void)</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="503092926e66667227bb46312a82a264"></a><!-- doxytag: member="stk::Modal::setFrequency" ref="503092926e66667227bb46312a82a264" args="(StkFloat frequency)" -->
|
|
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Modal.html#503092926e66667227bb46312a82a264">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="7e4f9a875e60485d07d50386ff63117f"></a><!-- doxytag: member="stk::Modal::setRatioAndRadius" ref="7e4f9a875e60485d07d50386ff63117f" args="(unsigned int modeIndex, StkFloat ratio, StkFloat radius)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Modal.html#7e4f9a875e60485d07d50386ff63117f">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="6e8d79358a5024b2e9a6c6f7c69a43c1"></a><!-- doxytag: member="stk::Modal::setMasterGain" ref="6e8d79358a5024b2e9a6c6f7c69a43c1" args="(StkFloat aGain)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Modal.html#6e8d79358a5024b2e9a6c6f7c69a43c1">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="70006135da2ecdc46eff4156504d94e1"></a><!-- doxytag: member="stk::Modal::setDirectGain" ref="70006135da2ecdc46eff4156504d94e1" args="(StkFloat aGain)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Modal.html#70006135da2ecdc46eff4156504d94e1">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="08bdfedf10d00dcf19e82809926eab2f"></a><!-- doxytag: member="stk::Modal::setModeGain" ref="08bdfedf10d00dcf19e82809926eab2f" args="(unsigned int modeIndex, StkFloat gain)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Modal.html#08bdfedf10d00dcf19e82809926eab2f">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="b3bac00a47fa6fef70cf3ea442e9b121"></a><!-- doxytag: member="stk::Modal::strike" ref="b3bac00a47fa6fef70cf3ea442e9b121" args="(StkFloat amplitude)" -->
|
|
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Modal.html#b3bac00a47fa6fef70cf3ea442e9b121">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="1884c49b76ec8b902f22d50e26a7e365"></a><!-- doxytag: member="stk::Modal::damp" ref="1884c49b76ec8b902f22d50e26a7e365" args="(StkFloat amplitude)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Modal.html#1884c49b76ec8b902f22d50e26a7e365">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="44ce41e8e24e591f382914d00a259c7f"></a><!-- doxytag: member="stk::Modal::noteOn" ref="44ce41e8e24e591f382914d00a259c7f" args="(StkFloat frequency, StkFloat amplitude)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Modal.html#44ce41e8e24e591f382914d00a259c7f">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="3483dafe33fa37e98781279810ea808f"></a><!-- doxytag: member="stk::Modal::noteOff" ref="3483dafe33fa37e98781279810ea808f" args="(StkFloat amplitude)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Modal.html#3483dafe33fa37e98781279810ea808f">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="9fab49ec164852c381758f5d333f8891"></a><!-- doxytag: member="stk::Modal::controlChange" ref="9fab49ec164852c381758f5d333f8891" args="(int number, StkFloat value)=0" -->
|
|
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Modal.html#9fab49ec164852c381758f5d333f8891">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>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c1fd3f5dcb9b5cbb8bed0bff330c3890"></a><!-- doxytag: member="stk::Modal::tick" ref="c1fd3f5dcb9b5cbb8bed0bff330c3890" args="(unsigned int channel=0)" -->
|
|
StkFloat </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Modal.html#c1fd3f5dcb9b5cbb8bed0bff330c3890">tick</a> (unsigned int channel=0)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Compute and return one output sample. <br></td></tr>
|
|
</table>
|
|
<hr><a name="_details"></a><h2>Detailed Description</h2>
|
|
STK resonance model abstract base class.
|
|
<p>
|
|
This class contains an excitation wavetable, an envelope, an oscillator, and N resonances (non-sweeping <a class="el" href="classstk_1_1BiQuad.html" title="STK biquad (two-pole, two-zero) filter class.">BiQuad</a> filters), where N is set during instantiation.<p>
|
|
by Perry R. Cook and Gary P. Scavone, 1995 - 2009. <hr><h2>Constructor & Destructor Documentation</h2>
|
|
<a class="anchor" name="f6bfea135e80abb5537e62cf099c989a"></a><!-- doxytag: member="stk::Modal::Modal" ref="f6bfea135e80abb5537e62cf099c989a" args="(unsigned int modes=4)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">stk::Modal::Modal </td>
|
|
<td>(</td>
|
|
<td class="paramtype">unsigned int </td>
|
|
<td class="paramname"> <em>modes</em> = <code>4</code> </td>
|
|
<td> ) </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Class constructor, taking the desired number of modes to create.
|
|
<p>
|
|
An <a class="el" href="classstk_1_1StkError.html" title="STK error handling class.">StkError</a> will be thrown if the rawwave path is incorrectly set.
|
|
</div>
|
|
</div><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>
|
|
</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-2009 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
|
|
</table>
|
|
|
|
</BODY>
|
|
</HTML>
|