mirror of
https://github.com/thestk/stk
synced 2026-04-20 14:36:55 +00:00
Release 4.4.2 tarball
This commit is contained in:
Gary Scavone
committed by
Stephen Sinclair
Stephen Sinclair
parent
c37de52787
commit
7fcf920d3e
@@ -8,71 +8,94 @@
|
||||
<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 -->
|
||||
<!-- Generated by Doxygen 1.6.2 -->
|
||||
<div class="navpath"><a class="el" href="namespacestk.html">stk</a>::<a class="el" href="classstk_1_1Shakers.html">Shakers</a>
|
||||
</div>
|
||||
<div class="contents">
|
||||
<h1>stk::Shakers Class Reference</h1><!-- doxytag: class="stk::Shakers" --><!-- doxytag: inherits="stk::Instrmnt" -->PhISEM and PhOLIES class.
|
||||
<a href="#_details">More...</a>
|
||||
<p>
|
||||
<code>#include <<a class="el" href="Shakers_8h-source.html">Shakers.h</a>></code>
|
||||
<p>
|
||||
<h1>stk::Shakers Class Reference</h1><!-- doxytag: class="stk::Shakers" --><!-- doxytag: inherits="stk::Instrmnt" -->
|
||||
<p>PhISEM and PhOLIES class.
|
||||
<a href="#_details">More...</a></p>
|
||||
|
||||
<p><code>#include <<a class="el" href="Shakers_8h_source.html">Shakers.h</a>></code></p>
|
||||
<div class="dynheader">
|
||||
Inheritance diagram for stk::Shakers:</div>
|
||||
<div class="dynsection">
|
||||
|
||||
<p><center><img src="classstk_1_1Shakers.png" usemap="#stk::Shakers_map" border="0" alt=""></center>
|
||||
<map name="stk::Shakers_map">
|
||||
<area href="classstk_1_1Instrmnt.html" alt="stk::Instrmnt" shape="rect" coords="0,56,79,80">
|
||||
<area href="classstk_1_1Stk.html" alt="stk::Stk" shape="rect" coords="0,0,79,24">
|
||||
<div class="center">
|
||||
<img src="classstk_1_1Shakers.png" usemap="#stk::Shakers_map" alt=""/>
|
||||
<map id="stk::Shakers_map" name="stk::Shakers_map">
|
||||
<area href="classstk_1_1Instrmnt.html" alt="stk::Instrmnt" shape="rect" coords="0,56,79,80"/>
|
||||
<area href="classstk_1_1Stk.html" alt="stk::Stk" shape="rect" coords="0,0,79,24"/>
|
||||
</map>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<p>
|
||||
<a href="classstk_1_1Shakers-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"><a class="anchor" name="34e4859c572a158d8fda15b7a5c6954d"></a><!-- doxytag: member="stk::Shakers::Shakers" ref="34e4859c572a158d8fda15b7a5c6954d" args="(void)" -->
|
||||
</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Shakers.html#34e4859c572a158d8fda15b7a5c6954d">Shakers</a> (void)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Class constructor. <br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a1b2ab640268da68b867de1495f19a77"></a><!-- doxytag: member="stk::Shakers::~Shakers" ref="a1b2ab640268da68b867de1495f19a77" args="(void)" -->
|
||||
</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Shakers.html#a1b2ab640268da68b867de1495f19a77">~Shakers</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">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Shakers.html#81ffb0ad1e350993af10b2795ec01861">noteOn</a> (StkFloat instrument, StkFloat amplitude)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Start a note with the given instrument and amplitude. <a href="#81ffb0ad1e350993af10b2795ec01861"></a><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b63b4b57f8306eb7cf1adbf5a5cd1d05"></a><!-- doxytag: member="stk::Shakers::noteOff" ref="b63b4b57f8306eb7cf1adbf5a5cd1d05" args="(StkFloat amplitude)" -->
|
||||
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Shakers.html#b63b4b57f8306eb7cf1adbf5a5cd1d05">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="688d9d8318e0c69779868079a7c64157"></a><!-- doxytag: member="stk::Shakers::controlChange" ref="688d9d8318e0c69779868079a7c64157" args="(int number, StkFloat value)" -->
|
||||
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Shakers.html#688d9d8318e0c69779868079a7c64157">controlChange</a> (int number, StkFloat value)</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="e06ebba276cef74cb8c83db4e33f21c2"></a><!-- doxytag: member="stk::Shakers::tick" ref="e06ebba276cef74cb8c83db4e33f21c2" args="(unsigned int channel=0)" -->
|
||||
StkFloat </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Shakers.html#e06ebba276cef74cb8c83db4e33f21c2">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>
|
||||
<p><a href="classstk_1_1Shakers-members.html">List of all members.</a></p>
|
||||
<table border="0" cellpadding="0" cellspacing="0">
|
||||
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
|
||||
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a34e4859c572a158d8fda15b7a5c6954d"></a><!-- doxytag: member="stk::Shakers::Shakers" ref="a34e4859c572a158d8fda15b7a5c6954d" args="(void)" -->
|
||||
</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Shakers.html#a34e4859c572a158d8fda15b7a5c6954d">Shakers</a> (void)</td></tr>
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Class constructor. <br/></td></tr>
|
||||
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa1b2ab640268da68b867de1495f19a77"></a><!-- doxytag: member="stk::Shakers::~Shakers" ref="aa1b2ab640268da68b867de1495f19a77" args="(void)" -->
|
||||
</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Shakers.html#aa1b2ab640268da68b867de1495f19a77">~Shakers</a> (void)</td></tr>
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Class destructor. <br/></td></tr>
|
||||
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Shakers.html#a81ffb0ad1e350993af10b2795ec01861">noteOn</a> (StkFloat instrument, StkFloat amplitude)</td></tr>
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Start a note with the given instrument and amplitude. <a href="#a81ffb0ad1e350993af10b2795ec01861"></a><br/></td></tr>
|
||||
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab63b4b57f8306eb7cf1adbf5a5cd1d05"></a><!-- doxytag: member="stk::Shakers::noteOff" ref="ab63b4b57f8306eb7cf1adbf5a5cd1d05" args="(StkFloat amplitude)" -->
|
||||
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Shakers.html#ab63b4b57f8306eb7cf1adbf5a5cd1d05">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" align="right" valign="top"><a class="anchor" id="a688d9d8318e0c69779868079a7c64157"></a><!-- doxytag: member="stk::Shakers::controlChange" ref="a688d9d8318e0c69779868079a7c64157" args="(int number, StkFloat value)" -->
|
||||
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Shakers.html#a688d9d8318e0c69779868079a7c64157">controlChange</a> (int number, StkFloat value)</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" align="right" valign="top"><a class="anchor" id="ae06ebba276cef74cb8c83db4e33f21c2"></a><!-- doxytag: member="stk::Shakers::tick" ref="ae06ebba276cef74cb8c83db4e33f21c2" args="(unsigned int channel=0)" -->
|
||||
StkFloat </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Shakers.html#ae06ebba276cef74cb8c83db4e33f21c2">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>
|
||||
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 - 2009. <hr><h2>Member Function Documentation</h2>
|
||||
<a class="anchor" name="81ffb0ad1e350993af10b2795ec01861"></a><!-- doxytag: member="stk::Shakers::noteOn" ref="81ffb0ad1e350993af10b2795ec01861" args="(StkFloat instrument, StkFloat amplitude)" -->
|
||||
<hr/><a name="_details"></a><h2>Detailed Description</h2>
|
||||
<p>PhISEM and PhOLIES class. </p>
|
||||
<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>
|
||||
<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>
|
||||
<p>Control Change Numbers:</p>
|
||||
<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 - 2010. </p>
|
||||
<hr/><h2>Member Function Documentation</h2>
|
||||
<a class="anchor" id="a81ffb0ad1e350993af10b2795ec01861"></a><!-- doxytag: member="stk::Shakers::noteOn" ref="a81ffb0ad1e350993af10b2795ec01861" args="(StkFloat instrument, StkFloat amplitude)" -->
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">void stk::Shakers::noteOn </td>
|
||||
<td class="memname">void stk::Shakers::noteOn </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">StkFloat </td>
|
||||
<td class="paramname"> <em>instrument</em>, </td>
|
||||
@@ -92,22 +115,22 @@ by Perry R. Cook, 1996 - 2009. <hr><h2>Member Function Documentation</h2>
|
||||
</div>
|
||||
<div class="memdoc">
|
||||
|
||||
<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="classstk_1_1Instrmnt.html#0736ccd253b446660938d51909a32f44">stk::Instrmnt</a>.</p>
|
||||
<p>Start a note with the given instrument and amplitude. </p>
|
||||
<p>Use the instrument numbers above, converted to frequency values as if MIDI note numbers, to select a particular instrument. </p>
|
||||
|
||||
<p>Implements <a class="el" href="classstk_1_1Instrmnt.html#a0736ccd253b446660938d51909a32f44">stk::Instrmnt</a>.</p>
|
||||
|
||||
</div>
|
||||
</div><p>
|
||||
<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>
|
||||
</div>
|
||||
<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></li>
|
||||
</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>
|
||||
<tr><td>©1995-2010 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
|
||||
</table>
|
||||
|
||||
</BODY>
|
||||
|
||||
Reference in New Issue
Block a user