mirror of
https://github.com/thestk/stk
synced 2026-01-14 05:21:53 +00:00
103 lines
9.6 KiB
HTML
103 lines
9.6 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"> <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 -->
|
|
<div class="navpath"><a class="el" href="namespacestk.html">stk</a>::<a class="el" href="classstk_1_1Sphere.html">Sphere</a>
|
|
</div>
|
|
<div class="contents">
|
|
<h1>stk::Sphere Class Reference</h1><!-- doxytag: class="stk::Sphere" --><!-- doxytag: inherits="stk::Stk" -->STK sphere class.
|
|
<a href="#_details">More...</a>
|
|
<p>
|
|
<code>#include <<a class="el" href="Sphere_8h-source.html">Sphere.h</a>></code>
|
|
<p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for stk::Sphere:</div>
|
|
<div class="dynsection">
|
|
|
|
<p><center><img src="classstk_1_1Sphere.png" usemap="#stk::Sphere_map" border="0" alt=""></center>
|
|
<map name="stk::Sphere_map">
|
|
<area href="classstk_1_1Stk.html" alt="stk::Stk" shape="rect" coords="0,0,74,24">
|
|
</map>
|
|
</div>
|
|
|
|
<p>
|
|
<a href="classstk_1_1Sphere-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="73d4fac54fba9aa11a56a34e4198656c"></a><!-- doxytag: member="stk::Sphere::Sphere" ref="73d4fac54fba9aa11a56a34e4198656c" args="(StkFloat radius=1.0)" -->
|
|
</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Sphere.html#73d4fac54fba9aa11a56a34e4198656c">Sphere</a> (StkFloat radius=1.0)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor taking an initial radius value. <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="cfa3d4475f9c5ab655276473b1816f39"></a><!-- doxytag: member="stk::Sphere::setPosition" ref="cfa3d4475f9c5ab655276473b1816f39" args="(StkFloat x, StkFloat y, StkFloat z)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Sphere.html#cfa3d4475f9c5ab655276473b1816f39">setPosition</a> (StkFloat x, StkFloat y, StkFloat z)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the 3D center position of the sphere. <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c76725a19fe806e9af9841d30faacb11"></a><!-- doxytag: member="stk::Sphere::setVelocity" ref="c76725a19fe806e9af9841d30faacb11" args="(StkFloat x, StkFloat y, StkFloat z)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Sphere.html#c76725a19fe806e9af9841d30faacb11">setVelocity</a> (StkFloat x, StkFloat y, StkFloat z)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the 3D velocity of the sphere. <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c3f4f85642307bebe0733662620f0ee2"></a><!-- doxytag: member="stk::Sphere::setRadius" ref="c3f4f85642307bebe0733662620f0ee2" args="(StkFloat radius)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Sphere.html#c3f4f85642307bebe0733662620f0ee2">setRadius</a> (StkFloat radius)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the radius of the sphere. <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0db842c9f06b377bcd803391b7126d2f"></a><!-- doxytag: member="stk::Sphere::setMass" ref="0db842c9f06b377bcd803391b7126d2f" args="(StkFloat mass)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Sphere.html#0db842c9f06b377bcd803391b7126d2f">setMass</a> (StkFloat mass)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the mass of the sphere. <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="91a3e710a7ff0cf160e9d46fca373bfd"></a><!-- doxytag: member="stk::Sphere::getPosition" ref="91a3e710a7ff0cf160e9d46fca373bfd" args="(void)" -->
|
|
<a class="el" href="classstk_1_1Vector3D.html">Vector3D</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Sphere.html#91a3e710a7ff0cf160e9d46fca373bfd">getPosition</a> (void)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the current position of the sphere as a 3D vector. <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4cf8f763e732bcf9ca79b8602e8ec24a"></a><!-- doxytag: member="stk::Sphere::getRelativePosition" ref="4cf8f763e732bcf9ca79b8602e8ec24a" args="(Vector3D *position)" -->
|
|
<a class="el" href="classstk_1_1Vector3D.html">Vector3D</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Sphere.html#4cf8f763e732bcf9ca79b8602e8ec24a">getRelativePosition</a> (<a class="el" href="classstk_1_1Vector3D.html">Vector3D</a> *position)</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></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="43ccf47d5d952f14f1ba0940aa87f4c5"></a><!-- doxytag: member="stk::Sphere::getVelocity" ref="43ccf47d5d952f14f1ba0940aa87f4c5" args="(Vector3D *velocity)" -->
|
|
StkFloat </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Sphere.html#43ccf47d5d952f14f1ba0940aa87f4c5">getVelocity</a> (<a class="el" href="classstk_1_1Vector3D.html">Vector3D</a> *velocity)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the velcoity of the sphere as a 3D vector. <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="00bf47b0d5cd06a858d08f37d220ef9f"></a><!-- doxytag: member="stk::Sphere::isInside" ref="00bf47b0d5cd06a858d08f37d220ef9f" args="(Vector3D *position)" -->
|
|
StkFloat </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Sphere.html#00bf47b0d5cd06a858d08f37d220ef9f">isInside</a> (<a class="el" href="classstk_1_1Vector3D.html">Vector3D</a> *position)</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></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="03550bbe32d62ead67787651619b8c8b"></a><!-- doxytag: member="stk::Sphere::getRadius" ref="03550bbe32d62ead67787651619b8c8b" args="(void)" -->
|
|
StkFloat </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Sphere.html#03550bbe32d62ead67787651619b8c8b">getRadius</a> (void)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the current sphere radius. <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a82d922e0b8513364d9d0d473e6239c6"></a><!-- doxytag: member="stk::Sphere::getMass" ref="a82d922e0b8513364d9d0d473e6239c6" args="(void)" -->
|
|
StkFloat </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Sphere.html#a82d922e0b8513364d9d0d473e6239c6">getMass</a> (void)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the current sphere mass. <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="16666f1e94c6d1e6b1fa35ee6c46331f"></a><!-- doxytag: member="stk::Sphere::addVelocity" ref="16666f1e94c6d1e6b1fa35ee6c46331f" args="(StkFloat x, StkFloat y, StkFloat z)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Sphere.html#16666f1e94c6d1e6b1fa35ee6c46331f">addVelocity</a> (StkFloat x, StkFloat y, StkFloat z)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Increase the current sphere velocity by the given 3D components. <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="dc4709622b77fc91ad6f33be98c86344"></a><!-- doxytag: member="stk::Sphere::tick" ref="dc4709622b77fc91ad6f33be98c86344" args="(StkFloat timeIncrement)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Sphere.html#dc4709622b77fc91ad6f33be98c86344">tick</a> (StkFloat timeIncrement)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Move the sphere for the given time increment. <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.<p>
|
|
by Perry R. Cook, 1995 - 2009. <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>
|
|
</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>
|
|
</table>
|
|
|
|
</BODY>
|
|
</HTML>
|