Files
stk/doc/html/classShakers.html
2013-09-29 23:41:50 +02:00

108 lines
6.7 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"> &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="faq.html">FAQ</a> &nbsp; <a class="qindex" href="tutorial.html">Tutorial</a></CENTER>
<HR>
<!-- Generated by Doxygen 1.4.4 -->
<h1>Shakers Class Reference</h1><!-- doxytag: class="Shakers" --><!-- doxytag: inherits="Instrmnt" --><code>#include &lt;<a class="el" href="Shakers_8h-source.html">Shakers.h</a>&gt;</code>
<p>
<p>Inheritance diagram for Shakers:
<p><center><img src="classShakers.png" usemap="#Shakers_map" border="0" alt=""></center>
<map name="Shakers_map">
<area href="classInstrmnt.html" alt="Instrmnt" shape="rect" coords="0,56,58,80">
<area href="classStk.html" alt="Stk" shape="rect" coords="0,0,58,24">
</map>
<a href="classShakers-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
PhISEM and PhOLIES class.
<p>
PhISEM (Physically Informed Stochastic Event Modeling) is an algorithmic approach for simulating collisions of multiple independent sound producing objects. This class is a meta-model that can simulate a Maraca, Sekere, Cabasa, Bamboo Wind Chimes, Water Drops, Tambourine, Sleighbells, and a Guiro.<p>
PhOLIES (Physically-Oriented Library of Imitated Environmental Sounds) is a similar approach for the synthesis of environmental sounds. This class implements simulations of breaking sticks, crunchy snow (or not), a wrench, sandpaper, and more.<p>
Control Change Numbers:<ul>
<li>Shake Energy = 2</li><li>System Decay = 4</li><li>Number Of Objects = 11</li><li>Resonance Frequency = 1</li><li>Shake Energy = 128</li><li>Instrument Selection = 1071<ul>
<li>Maraca = 0</li><li>Cabasa = 1</li><li>Sekere = 2</li><li>Guiro = 3</li><li>Water Drops = 4</li><li>Bamboo Chimes = 5</li><li>Tambourine = 6</li><li>Sleigh Bells = 7</li><li>Sticks = 8</li><li>Crunch = 9</li><li>Wrench = 10</li><li>Sand Paper = 11</li><li>Coke Can = 12</li><li>Next Mug = 13</li><li>Penny + Mug = 14</li><li>Nickle + Mug = 15</li><li>Dime + Mug = 16</li><li>Quarter + Mug = 17</li><li>Franc + Mug = 18</li><li>Peso + Mug = 19</li><li>Big Rocks = 20</li><li>Little Rocks = 21</li><li>Tuned Bamboo Chimes = 22</li></ul>
</li></ul>
<p>
by Perry R. Cook, 1996 - 2004.
<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"><a class="anchor" name="a0"></a><!-- doxytag: member="Shakers::Shakers" ref="a0" args="()" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classShakers.html#a0">Shakers</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Class constructor. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a1"></a><!-- doxytag: member="Shakers::~Shakers" ref="a1" args="()" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classShakers.html#a1">~Shakers</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">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classShakers.html#a2">noteOn</a> (StkFloat instrument, StkFloat amplitude)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Start a note with the given instrument and amplitude. <a href="#a2"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a3"></a><!-- doxytag: member="Shakers::noteOff" ref="a3" args="(StkFloat amplitude)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classShakers.html#a3">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></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a4"></a><!-- doxytag: member="Shakers::controlChange" ref="a4" args="(int number, StkFloat value)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classShakers.html#a4">controlChange</a> (int number, StkFloat value)</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>Member Function Documentation</h2>
<a class="anchor" name="a2"></a><!-- doxytag: member="Shakers::noteOn" ref="a2" args="(StkFloat instrument, StkFloat amplitude)" --><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">void Shakers::noteOn </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">StkFloat&nbsp;</td>
<td class="mdname" nowrap> <em>instrument</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>StkFloat&nbsp;</td>
<td class="mdname" nowrap> <em>amplitude</em></td>
</tr>
<tr>
<td class="md"></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>
Start a note with the given instrument and amplitude.
<p>
Use the instrument numbers above, converted to frequency values as if MIDI note numbers, to select a particular instrument.
<p>
Implements <a class="el" href="classInstrmnt.html#a2">Instrmnt</a>. </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="Shakers_8h-source.html">Shakers.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>&copy;1995-2007 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
</table>
</BODY>
</HTML>