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

75 lines
5.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>ModalBar Class Reference</h1><!-- doxytag: class="ModalBar" --><!-- doxytag: inherits="Modal" --><code>#include &lt;<a class="el" href="ModalBar_8h-source.html">ModalBar.h</a>&gt;</code>
<p>
<p>Inheritance diagram for ModalBar:
<p><center><img src="classModalBar.png" usemap="#ModalBar_map" border="0" alt=""></center>
<map name="ModalBar_map">
<area href="classModal.html" alt="Modal" shape="rect" coords="0,112,67,136">
<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">
</map>
<a href="classModalBar-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
STK resonant bar instrument class.
<p>
This class implements a number of different struck bar instruments. It inherits from the <a class="el" href="classModal.html">Modal</a> class.<p>
Control Change Numbers:<ul>
<li>Stick Hardness = 2</li><li>Stick Position = 4</li><li>Vibrato Gain = 1</li><li>Vibrato Frequency = 11</li><li>Direct Stick Mix = 8</li><li>Volume = 128</li><li><a class="el" href="classModal.html">Modal</a> Presets = 16<ul>
<li>Marimba = 0</li><li>Vibraphone = 1</li><li>Agogo = 2</li><li>Wood1 = 3</li><li>Reso = 4</li><li>Wood2 = 5</li><li>Beats = 6</li><li>Two Fixed = 7</li><li>Clump = 8</li></ul>
</li></ul>
<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"><a class="anchor" name="a0"></a><!-- doxytag: member="ModalBar::ModalBar" ref="a0" args="()" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classModalBar.html#a0">ModalBar</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="ModalBar::~ModalBar" ref="a1" args="()" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classModalBar.html#a1">~ModalBar</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="ModalBar::setStickHardness" ref="a2" args="(StkFloat hardness)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classModalBar.html#a2">setStickHardness</a> (StkFloat hardness)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set stick hardness (0.0 - 1.0). <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a3"></a><!-- doxytag: member="ModalBar::setStrikePosition" ref="a3" args="(StkFloat position)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classModalBar.html#a3">setStrikePosition</a> (StkFloat position)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set stick position (0.0 - 1.0). <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a4"></a><!-- doxytag: member="ModalBar::setPreset" ref="a4" args="(int preset)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classModalBar.html#a4">setPreset</a> (int preset)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Select a bar preset (currently modulo 9). <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a5"></a><!-- doxytag: member="ModalBar::setModulationDepth" ref="a5" args="(StkFloat mDepth)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classModalBar.html#a5">setModulationDepth</a> (StkFloat mDepth)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the modulation (vibrato) depth. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a6"></a><!-- doxytag: member="ModalBar::controlChange" ref="a6" args="(int number, StkFloat value)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classModalBar.html#a6">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>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="ModalBar_8h-source.html">ModalBar.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>