e1lama/stk
1
0
Fork 0
mirror of https://github.com/thestk/stk synced 2026-01-18 15:11:53 +00:00
Code Issues Packages Projects Releases Wiki Activity

Release 4.2.1 tarball

Browse Source
This commit is contained in:
Gary Scavone
2013-09-29 23:40:35 +02:00
committed by Stephen Sinclair
parent 11cf5faa0a
commit 21b93795e7
1041 changed files with 23984 additions and 16348 deletions
Download Patch File Download Diff File Expand all files Collapse all files

157
doc/html/classModal.html
View File

@@ -8,8 +8,8 @@
<img src="princeton.gif"> &nbsp; <img src="ccrma.gif"> &nbsp; <img src="mcgill.gif"><P>
<a class="qindex" href="index.html">Home</a> &nbsp; <a class="qindex" href="information.html">Information</a> &nbsp; <a class="qindex" href="classes.html">Classes</a> &nbsp; <a class="qindex" href="download.html">Download</a> &nbsp; <a class="qindex" href="usage.html">Usage</a> &nbsp; <a class="qindex" href="maillist.html">Mail List</a> &nbsp; <a class="qindex" href="system.html">Requirements</a> &nbsp; <a class="qindex" href="links.html">Links</a> &nbsp; <a class="qindex" href="tutorial.html">Tutorial</a></CENTER>
<HR>
<!-- Generated by Doxygen 1.3.4 -->
<h1>Modal Class Reference</h1><code>#include &lt;<a class="el" href="Modal_8h-source.html">Modal.h</a>&gt;</code>
<!-- Generated by Doxygen 1.4.4 -->
<h1>Modal Class Reference</h1><!-- doxytag: class="Modal" --><!-- doxytag: inherits="Instrmnt" --><code>#include &lt;<a class="el" href="Modal_8h-source.html">Modal.h</a>&gt;</code>
<p>
<p>Inheritance diagram for Modal:
<p><center><img src="classModal.png" usemap="#Modal_map" border="0" alt=""></center>
@@ -22,96 +22,82 @@
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 - 2004.
by Perry R. Cook and Gary P. Scavone, 1995 - 2005.
<p>
<p>
Definition at line <a class="el" href="Modal_8h-source.html#l00023">23</a> of file <a class="el" href="Modal_8h-source.html">Modal.h</a>.<table border=0 cellpadding=0 cellspacing=0>
<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>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModal.html#a0">Modal</a> (unsigned int modes=4)</td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</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">&nbsp;</td><td class="mdescRight">Class constructor, taking the desired number of modes to create. </em> <a href="#a0"></a><em><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a1" doxytag="Modal::~Modal" ></a>
virtual&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModal.html#a1">~Modal</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</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&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classModal.html#a1">~Modal</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Class destructor. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a2" doxytag="Modal::clear" ></a>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModal.html#a2">clear</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</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&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classModal.html#a2">clear</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Reset and clear all internal state. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a3" doxytag="Modal::setFrequency" ></a>
virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModal.html#a3">setFrequency</a> (StkFloat frequency)</td></tr>
<tr><td class="mdescLeft">&nbsp;</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&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classModal.html#a3">setFrequency</a> (StkFloat frequency)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set instrument parameters for a particular frequency. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a4" doxytag="Modal::setRatioAndRadius" ></a>
void&nbsp;</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">&nbsp;</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&nbsp;</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">&nbsp;</td><td class="mdescRight">Set the ratio and radius for a specified mode filter. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a5" doxytag="Modal::setMasterGain" ></a>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModal.html#a5">setMasterGain</a> (StkFloat aGain)</td></tr>
<tr><td class="mdescLeft">&nbsp;</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&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classModal.html#a5">setMasterGain</a> (StkFloat aGain)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the master gain. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a6" doxytag="Modal::setDirectGain" ></a>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModal.html#a6">setDirectGain</a> (StkFloat aGain)</td></tr>
<tr><td class="mdescLeft">&nbsp;</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&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classModal.html#a6">setDirectGain</a> (StkFloat aGain)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the direct gain. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a7" doxytag="Modal::setModeGain" ></a>
void&nbsp;</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">&nbsp;</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&nbsp;</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">&nbsp;</td><td class="mdescRight">Set the gain for a specified mode filter. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a8" doxytag="Modal::strike" ></a>
virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModal.html#a8">strike</a> (StkFloat amplitude)</td></tr>
<tr><td class="mdescLeft">&nbsp;</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&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classModal.html#a8">strike</a> (StkFloat amplitude)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Initiate a strike with the given amplitude (0.0 - 1.0). <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a9" doxytag="Modal::damp" ></a>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModal.html#a9">damp</a> (StkFloat amplitude)</td></tr>
<tr><td class="mdescLeft">&nbsp;</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&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classModal.html#a9">damp</a> (StkFloat amplitude)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Damp modes with a given decay factor (0.0 - 1.0). <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a10" doxytag="Modal::noteOn" ></a>
void&nbsp;</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">&nbsp;</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&nbsp;</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">&nbsp;</td><td class="mdescRight">Start a note with the given frequency and amplitude. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a11" doxytag="Modal::noteOff" ></a>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModal.html#a11">noteOff</a> (StkFloat amplitude)</td></tr>
<tr><td class="mdescLeft">&nbsp;</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&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classModal.html#a11">noteOff</a> (StkFloat amplitude)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Stop a note with the given amplitude (speed of decay). <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a12" doxytag="Modal::tick" ></a>
virtual StkFloat&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModal.html#a12">tick</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</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&nbsp;</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">&nbsp;</td><td class="mdescRight">Compute one output sample. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a13" doxytag="Modal::tick" ></a>
virtual StkFloat *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModal.html#a13">tick</a> (StkFloat *vector, unsigned int vectorSize)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Computer <em>vectorSize</em> outputs and return them in <em>vector</em>. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="classStkFrames.html">StkFrames</a> &amp;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModal.html#a14">tick</a> (<a class="el" href="classStkFrames.html">StkFrames</a> &amp;frames, unsigned int channel=1)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Fill a channel of the <a class="el" href="classStkFrames.html">StkFrames</a> object with computed outputs. </em> <a href="#a14"></a><em><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a15" doxytag="Modal::controlChange" ></a>
virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModal.html#a15">controlChange</a> (int number, StkFloat value)=0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Perform the control change specified by <em>number</em> and <em>value</em> (0.0 - 128.0). <br><br></td></tr>
<tr><td class="mdescLeft">&nbsp;</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 &amp; Destructor Documentation</h2>
<a class="anchor" name="a0" doxytag="Modal::Modal" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<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" nowrap valign="top">Modal::Modal </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">unsigned int&nbsp;</td>
<td class="mdname1" valign="top" nowrap> <em>modes</em> = 4 </td>
<td class="mdname1" valign="top" nowrap> <em>modes</em> = <code>4</code> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
@@ -121,50 +107,7 @@ virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href
<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><h2>Member Function Documentation</h2>
<a class="anchor" name="a14" doxytag="Modal::tick" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> virtual <a class="el" href="classStkFrames.html">StkFrames</a>&amp; Modal::tick </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top"><a class="el" href="classStkFrames.html">StkFrames</a> &amp;&nbsp;</td>
<td class="mdname" nowrap> <em>frames</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>unsigned int&nbsp;</td>
<td class="mdname" nowrap> <em>channel</em> = 1</td>
</tr>
<tr>
<td></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"><code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Fill a channel of the <a class="el" href="classStkFrames.html">StkFrames</a> object with computed outputs.
<p>
The <code>channel</code> argument should be one or greater (the first channel is specified by 1). An <a class="el" href="classStkError.html">StkError</a> will be thrown if the <code>channel</code> argument is zero or it is greater than the number of channels in the <a class="el" href="classStkFrames.html">StkFrames</a> object.
<p>
Reimplemented from <a class="el" href="classInstrmnt.html#a10">Instrmnt</a>. </td>
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>
@@ -173,7 +116,7 @@ Reimplemented from <a class="el" href="classInstrmnt.html#a10">Instrmnt</a>.
<table>
<tr><td><A HREF="http://ccrma.stanford.edu/software/stk/"><I>The Synthesis ToolKit in C++ (STK)</I></A></td></tr>
<tr><td>&copy;1995-2004 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
<tr><td>&copy;1995-2005 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
</table>
</BODY>