Files
stk/doc/html/classstk_1_1Vector3D.html
2013-09-29 23:44:33 +02:00

87 lines
6.9 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.5.8 -->
<div class="navpath"><a class="el" href="namespacestk.html">stk</a>::<a class="el" href="classstk_1_1Vector3D.html">Vector3D</a>
</div>
<div class="contents">
<h1>stk::Vector3D Class Reference</h1><!-- doxytag: class="stk::Vector3D" --><!-- doxytag: inherits="stk::Stk" -->STK 3D vector class.
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="Vector3D_8h-source.html">Vector3D.h</a>&gt;</code>
<p>
<div class="dynheader">
Inheritance diagram for stk::Vector3D:</div>
<div class="dynsection">
<p><center><img src="classstk_1_1Vector3D.png" usemap="#stk::Vector3D_map" border="0" alt=""></center>
<map name="stk::Vector3D_map">
<area href="classstk_1_1Stk.html" alt="stk::Stk" shape="rect" coords="0,0,87,24">
</map>
</div>
<p>
<a href="classstk_1_1Vector3D-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="2e5ae76645aa8a89a8ab0640d3ce5292"></a><!-- doxytag: member="stk::Vector3D::Vector3D" ref="2e5ae76645aa8a89a8ab0640d3ce5292" args="(StkFloat x=0.0, StkFloat y=0.0, StkFloat z=0.0)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Vector3D.html#2e5ae76645aa8a89a8ab0640d3ce5292">Vector3D</a> (StkFloat x=0.0, StkFloat y=0.0, StkFloat z=0.0)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor taking optional initial X, Y, and Z values. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e4f7cddc34ed1cf80262ff2d5dad65f4"></a><!-- doxytag: member="stk::Vector3D::getX" ref="e4f7cddc34ed1cf80262ff2d5dad65f4" args="(void)" -->
StkFloat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Vector3D.html#e4f7cddc34ed1cf80262ff2d5dad65f4">getX</a> (void)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the current X value. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f83bfbe865d702845e37e14d82f642b6"></a><!-- doxytag: member="stk::Vector3D::getY" ref="f83bfbe865d702845e37e14d82f642b6" args="(void)" -->
StkFloat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Vector3D.html#f83bfbe865d702845e37e14d82f642b6">getY</a> (void)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the current Y value. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f1c7389a2b4640cbe594fa33f9e4f805"></a><!-- doxytag: member="stk::Vector3D::getZ" ref="f1c7389a2b4640cbe594fa33f9e4f805" args="(void)" -->
StkFloat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Vector3D.html#f1c7389a2b4640cbe594fa33f9e4f805">getZ</a> (void)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the current Z value. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="61b078f252c597feff6d98a5646b03fd"></a><!-- doxytag: member="stk::Vector3D::getLength" ref="61b078f252c597feff6d98a5646b03fd" args="(void)" -->
StkFloat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Vector3D.html#61b078f252c597feff6d98a5646b03fd">getLength</a> (void)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Calculate the vector length. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="65fd03de6d9d42ea53a6cb8418ee7149"></a><!-- doxytag: member="stk::Vector3D::setXYZ" ref="65fd03de6d9d42ea53a6cb8418ee7149" args="(StkFloat x, StkFloat y, StkFloat z)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Vector3D.html#65fd03de6d9d42ea53a6cb8418ee7149">setXYZ</a> (StkFloat x, StkFloat y, StkFloat z)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the X, Y, and Z values simultaniously. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9825ba3adb8fb272d2e3ca20740a48c5"></a><!-- doxytag: member="stk::Vector3D::setX" ref="9825ba3adb8fb272d2e3ca20740a48c5" args="(StkFloat x)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Vector3D.html#9825ba3adb8fb272d2e3ca20740a48c5">setX</a> (StkFloat x)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the X value. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="94de5326b083c6cf72f509aa0fc532f3"></a><!-- doxytag: member="stk::Vector3D::setY" ref="94de5326b083c6cf72f509aa0fc532f3" args="(StkFloat y)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Vector3D.html#94de5326b083c6cf72f509aa0fc532f3">setY</a> (StkFloat y)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the Y value. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="826f2aa5e7b95a0d91f9432f26bec881"></a><!-- doxytag: member="stk::Vector3D::setZ" ref="826f2aa5e7b95a0d91f9432f26bec881" args="(StkFloat z)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Vector3D.html#826f2aa5e7b95a0d91f9432f26bec881">setZ</a> (StkFloat z)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the Z value. <br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
STK 3D vector class.
<p>
This class implements a three-dimensional vector.<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="Vector3D_8h-source.html">Vector3D.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>&copy;1995-2009 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
</table>
</BODY>
</HTML>