mirror of
https://github.com/thestk/stk
synced 2026-01-13 04:51:53 +00:00
155 lines
6.1 KiB
HTML
155 lines
6.1 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"><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="tutorial.html">Tutorial</a></CENTER>
|
|
<HR>
|
|
<!-- Generated by Doxygen 1.2.8.1 -->
|
|
<h1>BowTabl Class Reference</h1>STK bowed string table class.
|
|
<a href="#_details">More...</a>
|
|
<p>
|
|
<code>#include <<a class="el" href="BowTabl_8h-source.html">BowTabl.h</a>></code>
|
|
<p>
|
|
<p>Inheritance diagram for BowTabl::
|
|
<p><center><img src="classBowTabl.gif" usemap="#BowTabl_map" border="0"></center>
|
|
<map name="BowTabl_map">
|
|
<area href="classStk.html" alt="Stk" shape="rect" coords="0,0,60,24">
|
|
</map>
|
|
<a href="classBowTabl-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
|
|
<tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="a0" doxytag="BowTabl::BowTabl"></a>
|
|
</td><td valign=bottom><a class="el" href="classBowTabl.html#a0">BowTabl</a> ()</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Default constructor.</em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="a1" doxytag="BowTabl::~BowTabl"></a>
|
|
</td><td valign=bottom><a class="el" href="classBowTabl.html#a1">~BowTabl</a> ()</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Class destructor.</em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classBowTabl.html#a2">setOffset</a> (MY_FLOAT aValue)</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Set the table offset value.</em> <a href="#a2">More...</a><em></em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classBowTabl.html#a3">setSlope</a> (MY_FLOAT aValue)</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Set the table slope value.</em> <a href="#a3">More...</a><em></em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="a4" doxytag="BowTabl::lastOut"></a>
|
|
MY_FLOAT </td><td valign=bottom><a class="el" href="classBowTabl.html#a4">lastOut</a> (void) const</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Return the last output value.</em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top>MY_FLOAT </td><td valign=bottom><a class="el" href="classBowTabl.html#a5">tick</a> (const MY_FLOAT input)</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Return the function value for <em>input</em>.</em> <a href="#a5">More...</a><em></em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="a6" doxytag="BowTabl::tick"></a>
|
|
MY_FLOAT* </td><td valign=bottom><a class="el" href="classBowTabl.html#a6">tick</a> (MY_FLOAT *vector, unsigned int vectorSize)</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Take <em>vectorSize</em> inputs and return the corresponding function values in <em>vector</em>.</em></font><br><br></td></tr>
|
|
</table>
|
|
<hr><a name="_details"></a><h2>Detailed Description</h2>
|
|
STK bowed string table class.
|
|
<p>
|
|
This class implements a simple bowed string non-linear function, as described by Smith (1986).
|
|
<p>
|
|
by Perry R. Cook and Gary P. Scavone, 1995 - 2002.
|
|
<p>
|
|
<hr><h2>Member Function Documentation</h2>
|
|
<a name="a2" doxytag="BowTabl::setOffset"></a><p>
|
|
<table width="100%" cellpadding="2" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td nowrap valign="top"><b>
|
|
void BowTabl::setOffset (
|
|
</b></td>
|
|
<td valign="bottom"><b>
|
|
MY_FLOAT <em>aValue</em> )
|
|
</b></td>
|
|
</tr>
|
|
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Set the table offset value.
|
|
<p>
|
|
The table offset is a bias which controls the symmetry of the friction. If you want the friction to vary with direction, use a non-zero value for the offset. The default value is zero. </td>
|
|
</tr>
|
|
</table>
|
|
<a name="a3" doxytag="BowTabl::setSlope"></a><p>
|
|
<table width="100%" cellpadding="2" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td nowrap valign="top"><b>
|
|
void BowTabl::setSlope (
|
|
</b></td>
|
|
<td valign="bottom"><b>
|
|
MY_FLOAT <em>aValue</em> )
|
|
</b></td>
|
|
</tr>
|
|
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Set the table slope value.
|
|
<p>
|
|
The table slope controls the width of the friction pulse, which is related to bow force. </td>
|
|
</tr>
|
|
</table>
|
|
<a name="a5" doxytag="BowTabl::tick"></a><p>
|
|
<table width="100%" cellpadding="2" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td nowrap valign="top"><b>
|
|
MY_FLOAT BowTabl::tick (
|
|
</b></td>
|
|
<td valign="bottom"><b>
|
|
const MY_FLOAT <em>input</em> )
|
|
</b></td>
|
|
</tr>
|
|
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Return the function value for <em>input</em>.
|
|
<p>
|
|
The function input represents differential string-to-bow velocity. </td>
|
|
</tr>
|
|
</table>
|
|
<hr>The documentation for this class was generated from the following file:<ul>
|
|
<li><a class="el" href="BowTabl_8h-source.html">BowTabl.h</a></ul>
|
|
<HR>
|
|
|
|
<table>
|
|
<tr><td><A HREF="http://www-ccrma.stanford.edu/software/stk/"><I>The Synthesis ToolKit in C++ (STK)</I></A></td></tr>
|
|
<tr><td>©1995-2002 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
|
|
</table>
|
|
|
|
</BODY>
|
|
</HTML>
|