mirror of
https://github.com/thestk/stk
synced 2026-01-18 07:01:53 +00:00
Release 4.1.2 tarball
This commit is contained in:
Gary Scavone
committed by
Stephen Sinclair
Stephen Sinclair
parent
d12ef806ac
commit
5d63b50e85
@@ -5,74 +5,90 @@
|
||||
</HEAD>
|
||||
<BODY BGCOLOR="#FFFFFF">
|
||||
<CENTER>
|
||||
<img src="princeton.gif"> <img src="ccrma.gif"><P>
|
||||
<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="tutorial.html">Tutorial</a></CENTER>
|
||||
<HR>
|
||||
<!-- Generated by Doxygen 1.2.8.1 -->
|
||||
<h1>Sphere Class Reference</h1>STK sphere class.
|
||||
<!-- Generated by Doxygen 1.3.6 -->
|
||||
<h1>Sphere Class Reference</h1>STK sphere class.
|
||||
<a href="#_details">More...</a>
|
||||
<p>
|
||||
<code>#include <<a class="el" href="Sphere_8h-source.html">Sphere.h</a>></code>
|
||||
<p>
|
||||
<a href="classSphere-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="Sphere::Sphere"></a>
|
||||
</td><td valign=bottom><a class="el" href="classSphere.html#a0">Sphere</a> (double initRadius)</td></tr>
|
||||
<tr><td> </td><td><font size=-1><em>Constructor taking an initial radius value.</em></font><br><br></td></tr>
|
||||
<tr><td nowrap align=right valign=top><a name="a1" doxytag="Sphere::~Sphere"></a>
|
||||
</td><td valign=bottom><a class="el" href="classSphere.html#a1">~Sphere</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><a name="a2" doxytag="Sphere::setPosition"></a>
|
||||
void </td><td valign=bottom><a class="el" href="classSphere.html#a2">setPosition</a> (double anX, double aY, double aZ)</td></tr>
|
||||
<tr><td> </td><td><font size=-1><em>Set the 3D center position of the sphere.</em></font><br><br></td></tr>
|
||||
<tr><td nowrap align=right valign=top><a name="a3" doxytag="Sphere::setVelocity"></a>
|
||||
void </td><td valign=bottom><a class="el" href="classSphere.html#a3">setVelocity</a> (double anX, double aY, double aZ)</td></tr>
|
||||
<tr><td> </td><td><font size=-1><em>Set the 3D velocity of the sphere.</em></font><br><br></td></tr>
|
||||
<tr><td nowrap align=right valign=top><a name="a4" doxytag="Sphere::setRadius"></a>
|
||||
void </td><td valign=bottom><a class="el" href="classSphere.html#a4">setRadius</a> (double aRadius)</td></tr>
|
||||
<tr><td> </td><td><font size=-1><em>Set the radius of the sphere.</em></font><br><br></td></tr>
|
||||
<tr><td nowrap align=right valign=top><a name="a5" doxytag="Sphere::setMass"></a>
|
||||
void </td><td valign=bottom><a class="el" href="classSphere.html#a5">setMass</a> (double aMass)</td></tr>
|
||||
<tr><td> </td><td><font size=-1><em>Set the mass of the sphere.</em></font><br><br></td></tr>
|
||||
<tr><td nowrap align=right valign=top><a name="a6" doxytag="Sphere::getPosition"></a>
|
||||
<a class="el" href="classVector3D.html">Vector3D</a>* </td><td valign=bottom><a class="el" href="classSphere.html#a6">getPosition</a> ()</td></tr>
|
||||
<tr><td> </td><td><font size=-1><em>Get the current position of the sphere as a 3D vector.</em></font><br><br></td></tr>
|
||||
<tr><td nowrap align=right valign=top><a name="a7" doxytag="Sphere::getRelativePosition"></a>
|
||||
<a class="el" href="classVector3D.html">Vector3D</a>* </td><td valign=bottom><a class="el" href="classSphere.html#a7">getRelativePosition</a> (<a class="el" href="classVector3D.html">Vector3D</a> *aPosition)</td></tr>
|
||||
<tr><td> </td><td><font size=-1><em>Get the relative position of the given point to the sphere as a 3D vector.</em></font><br><br></td></tr>
|
||||
<tr><td nowrap align=right valign=top><a name="a8" doxytag="Sphere::getVelocity"></a>
|
||||
double </td><td valign=bottom><a class="el" href="classSphere.html#a8">getVelocity</a> (<a class="el" href="classVector3D.html">Vector3D</a> *aVelocity)</td></tr>
|
||||
<tr><td> </td><td><font size=-1><em>Set the velcoity of the sphere as a 3D vector.</em></font><br><br></td></tr>
|
||||
<tr><td nowrap align=right valign=top><a name="a9" doxytag="Sphere::isInside"></a>
|
||||
double </td><td valign=bottom><a class="el" href="classSphere.html#a9">isInside</a> (<a class="el" href="classVector3D.html">Vector3D</a> *aPosition)</td></tr>
|
||||
<tr><td> </td><td><font size=-1><em>Returns the distance from the sphere boundary to the given position (< 0 if inside).</em></font><br><br></td></tr>
|
||||
<tr><td nowrap align=right valign=top><a name="a10" doxytag="Sphere::getRadius"></a>
|
||||
double </td><td valign=bottom><a class="el" href="classSphere.html#a10">getRadius</a> ()</td></tr>
|
||||
<tr><td> </td><td><font size=-1><em>Get the current sphere radius.</em></font><br><br></td></tr>
|
||||
<tr><td nowrap align=right valign=top><a name="a11" doxytag="Sphere::getMass"></a>
|
||||
double </td><td valign=bottom><a class="el" href="classSphere.html#a11">getMass</a> ()</td></tr>
|
||||
<tr><td> </td><td><font size=-1><em>Get the current sphere mass.</em></font><br><br></td></tr>
|
||||
<tr><td nowrap align=right valign=top><a name="a12" doxytag="Sphere::addVelocity"></a>
|
||||
void </td><td valign=bottom><a class="el" href="classSphere.html#a12">addVelocity</a> (double anX, double aY, double aZ)</td></tr>
|
||||
<tr><td> </td><td><font size=-1><em>Increase the current sphere velocity by the given 3D components.</em></font><br><br></td></tr>
|
||||
<tr><td nowrap align=right valign=top><a name="a13" doxytag="Sphere::tick"></a>
|
||||
void </td><td valign=bottom><a class="el" href="classSphere.html#a13">tick</a> (double timeIncrement)</td></tr>
|
||||
<tr><td> </td><td><font size=-1><em>Move the sphere for the given time increment.</em></font><br><br></td></tr>
|
||||
<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" doxytag="Sphere::Sphere" ></a>
|
||||
</td><td class="memItemRight" valign=bottom><a class="el" href="classSphere.html#a0">Sphere</a> (double initRadius)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor taking an initial radius value. <br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a1" doxytag="Sphere::~Sphere" ></a>
|
||||
</td><td class="memItemRight" valign=bottom><a class="el" href="classSphere.html#a1">~Sphere</a> ()</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Class destructor. <br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a2" doxytag="Sphere::setPosition" ></a>
|
||||
void </td><td class="memItemRight" valign=bottom><a class="el" href="classSphere.html#a2">setPosition</a> (double anX, double aY, double aZ)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the 3D center position of the sphere. <br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a3" doxytag="Sphere::setVelocity" ></a>
|
||||
void </td><td class="memItemRight" valign=bottom><a class="el" href="classSphere.html#a3">setVelocity</a> (double anX, double aY, double aZ)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the 3D velocity of the sphere. <br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a4" doxytag="Sphere::setRadius" ></a>
|
||||
void </td><td class="memItemRight" valign=bottom><a class="el" href="classSphere.html#a4">setRadius</a> (double aRadius)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the radius of the sphere. <br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a5" doxytag="Sphere::setMass" ></a>
|
||||
void </td><td class="memItemRight" valign=bottom><a class="el" href="classSphere.html#a5">setMass</a> (double aMass)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the mass of the sphere. <br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a6" doxytag="Sphere::getPosition" ></a>
|
||||
<a class="el" href="classVector3D.html">Vector3D</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="classSphere.html#a6">getPosition</a> ()</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the current position of the sphere as a 3D vector. <br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a7" doxytag="Sphere::getRelativePosition" ></a>
|
||||
<a class="el" href="classVector3D.html">Vector3D</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="classSphere.html#a7">getRelativePosition</a> (<a class="el" href="classVector3D.html">Vector3D</a> *aPosition)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the relative position of the given point to the sphere as a 3D vector. <br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a8" doxytag="Sphere::getVelocity" ></a>
|
||||
double </td><td class="memItemRight" valign=bottom><a class="el" href="classSphere.html#a8">getVelocity</a> (<a class="el" href="classVector3D.html">Vector3D</a> *aVelocity)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the velcoity of the sphere as a 3D vector. <br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a9" doxytag="Sphere::isInside" ></a>
|
||||
double </td><td class="memItemRight" valign=bottom><a class="el" href="classSphere.html#a9">isInside</a> (<a class="el" href="classVector3D.html">Vector3D</a> *aPosition)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the distance from the sphere boundary to the given position (< 0 if inside). <br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a10" doxytag="Sphere::getRadius" ></a>
|
||||
double </td><td class="memItemRight" valign=bottom><a class="el" href="classSphere.html#a10">getRadius</a> ()</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the current sphere radius. <br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a11" doxytag="Sphere::getMass" ></a>
|
||||
double </td><td class="memItemRight" valign=bottom><a class="el" href="classSphere.html#a11">getMass</a> ()</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the current sphere mass. <br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a12" doxytag="Sphere::addVelocity" ></a>
|
||||
void </td><td class="memItemRight" valign=bottom><a class="el" href="classSphere.html#a12">addVelocity</a> (double anX, double aY, double aZ)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Increase the current sphere velocity by the given 3D components. <br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a13" doxytag="Sphere::tick" ></a>
|
||||
void </td><td class="memItemRight" valign=bottom><a class="el" href="classSphere.html#a13">tick</a> (double timeIncrement)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Move the sphere for the given time increment. <br><br></td></tr>
|
||||
</table>
|
||||
<hr><a name="_details"></a><h2>Detailed Description</h2>
|
||||
STK sphere class.
|
||||
<p>
|
||||
This class implements a spherical ball with radius, mass, position, and velocity parameters.
|
||||
STK sphere class.
|
||||
<p>
|
||||
This class implements a spherical ball with radius, mass, position, and velocity parameters.<p>
|
||||
by Perry R. Cook, 1995 - 2002.
|
||||
<p>
|
||||
<hr>The documentation for this class was generated from the following file:<ul>
|
||||
|
||||
<p>
|
||||
Definition at line <a class="el" href="Sphere_8h-source.html#l00017">17</a> of file <a class="el" href="Sphere_8h-source.html">Sphere.h</a>.<hr>The documentation for this class was generated from the following file:<ul>
|
||||
<li><a class="el" href="Sphere_8h-source.html">Sphere.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>
|
||||
<tr><td>©1995-2004 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
|
||||
</table>
|
||||
|
||||
</BODY>
|
||||
|
||||
Reference in New Issue
Block a user