mirror of
https://github.com/thestk/stk
synced 2026-01-13 21:11:53 +00:00
80 lines
6.0 KiB
HTML
80 lines
6.0 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.4.4 -->
|
|
<h1>Vector3D Class Reference</h1><!-- doxytag: class="Vector3D" --><!-- doxytag: inherits="Stk" --><code>#include <<a class="el" href="Vector3D_8h-source.html">Vector3D.h</a>></code>
|
|
<p>
|
|
<p>Inheritance diagram for Vector3D:
|
|
<p><center><img src="classVector3D.png" usemap="#Vector3D_map" border="0" alt=""></center>
|
|
<map name="Vector3D_map">
|
|
<area href="classStk.html" alt="Stk" shape="rect" coords="0,0,66,24">
|
|
</map>
|
|
<a href="classVector3D-members.html">List of all members.</a><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 - 2004.
|
|
<p>
|
|
<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="a0"></a><!-- doxytag: member="Vector3D::Vector3D" ref="a0" args="(StkFloat initX=0.0, StkFloat initY=0.0, StkFloat initZ=0.0)" -->
|
|
</td><td class="memItemRight" valign="bottom"><a class="el" href="classVector3D.html#a0">Vector3D</a> (StkFloat initX=0.0, StkFloat initY=0.0, StkFloat initZ=0.0)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </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="a1"></a><!-- doxytag: member="Vector3D::~Vector3D" ref="a1" args="()" -->
|
|
</td><td class="memItemRight" valign="bottom"><a class="el" href="classVector3D.html#a1">~Vector3D</a> ()</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Class destructor. <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a2"></a><!-- doxytag: member="Vector3D::getX" ref="a2" args="()" -->
|
|
StkFloat </td><td class="memItemRight" valign="bottom"><a class="el" href="classVector3D.html#a2">getX</a> ()</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </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="a3"></a><!-- doxytag: member="Vector3D::getY" ref="a3" args="()" -->
|
|
StkFloat </td><td class="memItemRight" valign="bottom"><a class="el" href="classVector3D.html#a3">getY</a> ()</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </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="a4"></a><!-- doxytag: member="Vector3D::getZ" ref="a4" args="()" -->
|
|
StkFloat </td><td class="memItemRight" valign="bottom"><a class="el" href="classVector3D.html#a4">getZ</a> ()</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </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="a5"></a><!-- doxytag: member="Vector3D::getLength" ref="a5" args="()" -->
|
|
StkFloat </td><td class="memItemRight" valign="bottom"><a class="el" href="classVector3D.html#a5">getLength</a> ()</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Calculate the vector length. <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a6"></a><!-- doxytag: member="Vector3D::setXYZ" ref="a6" args="(StkFloat x, StkFloat y, StkFloat z)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classVector3D.html#a6">setXYZ</a> (StkFloat x, StkFloat y, StkFloat z)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </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="a7"></a><!-- doxytag: member="Vector3D::setX" ref="a7" args="(StkFloat x)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classVector3D.html#a7">setX</a> (StkFloat x)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the X value. <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a8"></a><!-- doxytag: member="Vector3D::setY" ref="a8" args="(StkFloat y)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classVector3D.html#a8">setY</a> (StkFloat y)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the Y value. <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a9"></a><!-- doxytag: member="Vector3D::setZ" ref="a9" args="(StkFloat z)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classVector3D.html#a9">setZ</a> (StkFloat z)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the Z value. <br></td></tr>
|
|
</table>
|
|
<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>
|
|
<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-2007 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
|
|
</table>
|
|
|
|
</BODY>
|
|
</HTML>
|