mirror of
https://github.com/thestk/stk
synced 2026-04-19 22:16:54 +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,65 +8,59 @@
|
||||
<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_1BowTable.html">BowTable</a>
|
||||
</div>
|
||||
<div class="contents">
|
||||
<h1>stk::BowTable Class Reference</h1><!-- doxytag: class="stk::BowTable" --><!-- doxytag: inherits="stk::Function" -->STK bowed string table class.
|
||||
<a href="#_details">More...</a>
|
||||
<p>
|
||||
<code>#include <<a class="el" href="BowTable_8h-source.html">BowTable.h</a>></code>
|
||||
<p>
|
||||
<h1>stk::BowTable Class Reference</h1><!-- doxytag: class="stk::BowTable" --><!-- doxytag: inherits="stk::Function" -->
|
||||
<p>STK bowed string table class.
|
||||
<a href="#_details">More...</a></p>
|
||||
|
||||
<p><code>#include <<a class="el" href="BowTable_8h_source.html">BowTable.h</a>></code></p>
|
||||
<div class="dynheader">
|
||||
Inheritance diagram for stk::BowTable:</div>
|
||||
<div class="dynsection">
|
||||
|
||||
<p><center><img src="classstk_1_1BowTable.png" usemap="#stk::BowTable_map" border="0" alt=""></center>
|
||||
<map name="stk::BowTable_map">
|
||||
<area href="classstk_1_1Function.html" alt="stk::Function" shape="rect" coords="0,56,88,80">
|
||||
<area href="classstk_1_1Stk.html" alt="stk::Stk" shape="rect" coords="0,0,88,24">
|
||||
<div class="center">
|
||||
<img src="classstk_1_1BowTable.png" usemap="#stk::BowTable_map" alt=""/>
|
||||
<map id="stk::BowTable_map" name="stk::BowTable_map">
|
||||
<area href="classstk_1_1Function.html" alt="stk::Function" shape="rect" coords="0,56,88,80"/>
|
||||
<area href="classstk_1_1Stk.html" alt="stk::Stk" shape="rect" coords="0,0,88,24"/>
|
||||
</map>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<p>
|
||||
<a href="classstk_1_1BowTable-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="25d0985fd6821a7e1608af1e8f51952a"></a><!-- doxytag: member="stk::BowTable::BowTable" ref="25d0985fd6821a7e1608af1e8f51952a" args="(void)" -->
|
||||
</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1BowTable.html#25d0985fd6821a7e1608af1e8f51952a">BowTable</a> (void)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <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_1BowTable.html#9adcc3c36085b73d3b877828071a3b2c">setOffset</a> (StkFloat offset)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the table offset value. <a href="#9adcc3c36085b73d3b877828071a3b2c"></a><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_1BowTable.html#d8391e46941ff9f49b78bf4f77c35143">setSlope</a> (StkFloat slope)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the table slope value. <a href="#d8391e46941ff9f49b78bf4f77c35143"></a><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8dc58c69ecda1471dce6d142cb5f4b19"></a><!-- doxytag: member="stk::BowTable::tick" ref="8dc58c69ecda1471dce6d142cb5f4b19" args="(StkFloat input)" -->
|
||||
StkFloat </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1BowTable.html#8dc58c69ecda1471dce6d142cb5f4b19">tick</a> (StkFloat input)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Take one sample input and map to one sample of output. <br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1BowTable.html#8ad2766def014b62dcbbd8765e133246">tick</a> (<a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> &frames, unsigned int channel=0)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Take a channel of the <a class="el" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a> object as inputs to the table and replace with corresponding outputs. <a href="#8ad2766def014b62dcbbd8765e133246"></a><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1BowTable.html#af72f823f210b18f417337ac7181cde5">tick</a> (<a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> &iFrames, <a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> &oFrames, unsigned int iChannel=0, unsigned int oChannel=0)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Take a channel of the <code>iFrames</code> object as inputs to the table and write outputs to the <code>oFrames</code> object. <a href="#af72f823f210b18f417337ac7181cde5"></a><br></td></tr>
|
||||
<p><a href="classstk_1_1BowTable-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="a25d0985fd6821a7e1608af1e8f51952a"></a><!-- doxytag: member="stk::BowTable::BowTable" ref="a25d0985fd6821a7e1608af1e8f51952a" args="(void)" -->
|
||||
</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1BowTable.html#a25d0985fd6821a7e1608af1e8f51952a">BowTable</a> (void)</td></tr>
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <br/></td></tr>
|
||||
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1BowTable.html#a9adcc3c36085b73d3b877828071a3b2c">setOffset</a> (StkFloat offset)</td></tr>
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the table offset value. <a href="#a9adcc3c36085b73d3b877828071a3b2c"></a><br/></td></tr>
|
||||
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1BowTable.html#ad8391e46941ff9f49b78bf4f77c35143">setSlope</a> (StkFloat slope)</td></tr>
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the table slope value. <a href="#ad8391e46941ff9f49b78bf4f77c35143"></a><br/></td></tr>
|
||||
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8dc58c69ecda1471dce6d142cb5f4b19"></a><!-- doxytag: member="stk::BowTable::tick" ref="a8dc58c69ecda1471dce6d142cb5f4b19" args="(StkFloat input)" -->
|
||||
StkFloat </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1BowTable.html#a8dc58c69ecda1471dce6d142cb5f4b19">tick</a> (StkFloat input)</td></tr>
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Take one sample input and map to one sample of output. <br/></td></tr>
|
||||
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1BowTable.html#a8ad2766def014b62dcbbd8765e133246">tick</a> (<a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> &frames, unsigned int channel=0)</td></tr>
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Take a channel of the <a class="el" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a> object as inputs to the table and replace with corresponding outputs. <a href="#a8ad2766def014b62dcbbd8765e133246"></a><br/></td></tr>
|
||||
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1BowTable.html#aaf72f823f210b18f417337ac7181cde5">tick</a> (<a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> &iFrames, <a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> &oFrames, unsigned int iChannel=0, unsigned int oChannel=0)</td></tr>
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Take a channel of the <code>iFrames</code> object as inputs to the table and write outputs to the <code>oFrames</code> object. <a href="#aaf72f823f210b18f417337ac7181cde5"></a><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 - 2009. <hr><h2>Member Function Documentation</h2>
|
||||
<a class="anchor" name="9adcc3c36085b73d3b877828071a3b2c"></a><!-- doxytag: member="stk::BowTable::setOffset" ref="9adcc3c36085b73d3b877828071a3b2c" args="(StkFloat offset)" -->
|
||||
<hr/><a name="_details"></a><h2>Detailed Description</h2>
|
||||
<p>STK bowed string table class. </p>
|
||||
<p>This class implements a simple bowed string non-linear function, as described by Smith (1986).</p>
|
||||
<p>by Perry R. Cook and Gary P. Scavone, 1995 - 2010. </p>
|
||||
<hr/><h2>Member Function Documentation</h2>
|
||||
<a class="anchor" id="a9adcc3c36085b73d3b877828071a3b2c"></a><!-- doxytag: member="stk::BowTable::setOffset" ref="a9adcc3c36085b73d3b877828071a3b2c" args="(StkFloat offset)" -->
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">void stk::BowTable::setOffset </td>
|
||||
<td class="memname">void stk::BowTable::setOffset </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">StkFloat </td>
|
||||
<td class="paramname"> <em>offset</em> </td>
|
||||
<td class="paramname"> <em>offset</em></td>
|
||||
<td> ) </td>
|
||||
<td><code> [inline]</code></td>
|
||||
</tr>
|
||||
@@ -74,21 +68,20 @@ by Perry R. Cook and Gary P. Scavone, 1995 - 2009. <hr><h2>Member Function Docum
|
||||
</div>
|
||||
<div class="memdoc">
|
||||
|
||||
<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.
|
||||
<p>Set the table offset value. </p>
|
||||
<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. </p>
|
||||
|
||||
</div>
|
||||
</div><p>
|
||||
<a class="anchor" name="d8391e46941ff9f49b78bf4f77c35143"></a><!-- doxytag: member="stk::BowTable::setSlope" ref="d8391e46941ff9f49b78bf4f77c35143" args="(StkFloat slope)" -->
|
||||
</div>
|
||||
<a class="anchor" id="ad8391e46941ff9f49b78bf4f77c35143"></a><!-- doxytag: member="stk::BowTable::setSlope" ref="ad8391e46941ff9f49b78bf4f77c35143" args="(StkFloat slope)" -->
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">void stk::BowTable::setSlope </td>
|
||||
<td class="memname">void stk::BowTable::setSlope </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">StkFloat </td>
|
||||
<td class="paramname"> <em>slope</em> </td>
|
||||
<td class="paramname"> <em>slope</em></td>
|
||||
<td> ) </td>
|
||||
<td><code> [inline]</code></td>
|
||||
</tr>
|
||||
@@ -96,18 +89,17 @@ The table offset is a bias which controls the symmetry of the friction. If you w
|
||||
</div>
|
||||
<div class="memdoc">
|
||||
|
||||
<p>
|
||||
Set the table slope value.
|
||||
<p>
|
||||
The table slope controls the width of the friction pulse, which is related to bow force.
|
||||
<p>Set the table slope value. </p>
|
||||
<p>The table slope controls the width of the friction pulse, which is related to bow force. </p>
|
||||
|
||||
</div>
|
||||
</div><p>
|
||||
<a class="anchor" name="8ad2766def014b62dcbbd8765e133246"></a><!-- doxytag: member="stk::BowTable::tick" ref="8ad2766def014b62dcbbd8765e133246" args="(StkFrames &frames, unsigned int channel=0)" -->
|
||||
</div>
|
||||
<a class="anchor" id="a8ad2766def014b62dcbbd8765e133246"></a><!-- doxytag: member="stk::BowTable::tick" ref="a8ad2766def014b62dcbbd8765e133246" args="(StkFrames &frames, unsigned int channel=0)" -->
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname"><a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> & stk::BowTable::tick </td>
|
||||
<td class="memname"><a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> & stk::BowTable::tick </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype"><a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> & </td>
|
||||
<td class="paramname"> <em>frames</em>, </td>
|
||||
@@ -127,18 +119,17 @@ The table slope controls the width of the friction pulse, which is related to bo
|
||||
</div>
|
||||
<div class="memdoc">
|
||||
|
||||
<p>
|
||||
Take a channel of the <a class="el" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a> object as inputs to the table and replace with corresponding outputs.
|
||||
<p>
|
||||
The <a class="el" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a> argument reference is returned. The <code>channel</code> argument must be less than the number of channels in the <a class="el" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a> argument (the first channel is specified by 0). However, range checking is only performed if _STK_DEBUG_ is defined during compilation, in which case an out-of-range value will trigger an <a class="el" href="classstk_1_1StkError.html" title="STK error handling class.">StkError</a> exception.
|
||||
<p>Take a channel of the <a class="el" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a> object as inputs to the table and replace with corresponding outputs. </p>
|
||||
<p>The <a class="el" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a> argument reference is returned. The <code>channel</code> argument must be less than the number of channels in the <a class="el" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a> argument (the first channel is specified by 0). However, range checking is only performed if _STK_DEBUG_ is defined during compilation, in which case an out-of-range value will trigger an <a class="el" href="classstk_1_1StkError.html" title="STK error handling class.">StkError</a> exception. </p>
|
||||
|
||||
</div>
|
||||
</div><p>
|
||||
<a class="anchor" name="af72f823f210b18f417337ac7181cde5"></a><!-- doxytag: member="stk::BowTable::tick" ref="af72f823f210b18f417337ac7181cde5" args="(StkFrames &iFrames, StkFrames &oFrames, unsigned int iChannel=0, unsigned int oChannel=0)" -->
|
||||
</div>
|
||||
<a class="anchor" id="aaf72f823f210b18f417337ac7181cde5"></a><!-- doxytag: member="stk::BowTable::tick" ref="aaf72f823f210b18f417337ac7181cde5" args="(StkFrames &iFrames, StkFrames &oFrames, unsigned int iChannel=0, unsigned int oChannel=0)" -->
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname"><a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> & stk::BowTable::tick </td>
|
||||
<td class="memname"><a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> & stk::BowTable::tick </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype"><a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> & </td>
|
||||
<td class="paramname"> <em>iFrames</em>, </td>
|
||||
@@ -170,20 +161,20 @@ The <a class="el" href="classstk_1_1StkFrames.html" title="An STK class to handl
|
||||
</div>
|
||||
<div class="memdoc">
|
||||
|
||||
<p>
|
||||
Take a channel of the <code>iFrames</code> object as inputs to the table and write outputs to the <code>oFrames</code> object.
|
||||
<p>
|
||||
The <code>iFrames</code> object reference is returned. Each channel argument must be less than the number of channels in the corresponding <a class="el" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a> argument (the first channel is specified by 0). However, range checking is only performed if _STK_DEBUG_ is defined during compilation, in which case an out-of-range value will trigger an <a class="el" href="classstk_1_1StkError.html" title="STK error handling class.">StkError</a> exception.
|
||||
<p>Take a channel of the <code>iFrames</code> object as inputs to the table and write outputs to the <code>oFrames</code> object. </p>
|
||||
<p>The <code>iFrames</code> object reference is returned. Each channel argument must be less than the number of channels in the corresponding <a class="el" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a> argument (the first channel is specified by 0). However, range checking is only performed if _STK_DEBUG_ is defined during compilation, in which case an out-of-range value will trigger an <a class="el" href="classstk_1_1StkError.html" title="STK error handling class.">StkError</a> exception. </p>
|
||||
|
||||
</div>
|
||||
</div><p>
|
||||
<hr>The documentation for this class was generated from the following file:<ul>
|
||||
<li><a class="el" href="BowTable_8h-source.html">BowTable.h</a></ul>
|
||||
</div>
|
||||
<hr/>The documentation for this class was generated from the following file:<ul>
|
||||
<li><a class="el" href="BowTable_8h_source.html">BowTable.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