File: classstk_1_1Vector3D.html

package info (click to toggle)
stk 4.4.4-5
links: PTS, VCS
area: main
in suites: jessie-kfreebsd
size: 24,856 kB
sloc: cpp: 33,976; tcl: 2,375; sh: 2,319; ansic: 163; perl: 114; makefile: 37
file content (78 lines) | stat: -rw-r--r-- 7,026 bytes
parent folder | download | duplicates (2)
<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.6.2 -->
  <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" -->
<p>STK 3D vector class.  
<a href="#_details">More...</a></p>

<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">
 <div class="center">
  <img src="classstk_1_1Vector3D.png" usemap="#stk::Vector3D_map" alt=""/>
  <map id="stk::Vector3D_map" name="stk::Vector3D_map">
<area href="classstk_1_1Stk.html" alt="stk::Stk" shape="rect" coords="0,0,87,24"/>
</map>
 </div>
</div>

<p><a href="classstk_1_1Vector3D-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="a2e5ae76645aa8a89a8ab0640d3ce5292"></a><!-- doxytag: member="stk::Vector3D::Vector3D" ref="a2e5ae76645aa8a89a8ab0640d3ce5292" 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#a2e5ae76645aa8a89a8ab0640d3ce5292">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" align="right" valign="top"><a class="anchor" id="ae4f7cddc34ed1cf80262ff2d5dad65f4"></a><!-- doxytag: member="stk::Vector3D::getX" ref="ae4f7cddc34ed1cf80262ff2d5dad65f4" args="(void)" -->
StkFloat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Vector3D.html#ae4f7cddc34ed1cf80262ff2d5dad65f4">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" align="right" valign="top"><a class="anchor" id="af83bfbe865d702845e37e14d82f642b6"></a><!-- doxytag: member="stk::Vector3D::getY" ref="af83bfbe865d702845e37e14d82f642b6" args="(void)" -->
StkFloat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Vector3D.html#af83bfbe865d702845e37e14d82f642b6">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" align="right" valign="top"><a class="anchor" id="af1c7389a2b4640cbe594fa33f9e4f805"></a><!-- doxytag: member="stk::Vector3D::getZ" ref="af1c7389a2b4640cbe594fa33f9e4f805" args="(void)" -->
StkFloat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Vector3D.html#af1c7389a2b4640cbe594fa33f9e4f805">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" align="right" valign="top"><a class="anchor" id="a61b078f252c597feff6d98a5646b03fd"></a><!-- doxytag: member="stk::Vector3D::getLength" ref="a61b078f252c597feff6d98a5646b03fd" args="(void)" -->
StkFloat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Vector3D.html#a61b078f252c597feff6d98a5646b03fd">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" align="right" valign="top"><a class="anchor" id="a65fd03de6d9d42ea53a6cb8418ee7149"></a><!-- doxytag: member="stk::Vector3D::setXYZ" ref="a65fd03de6d9d42ea53a6cb8418ee7149" args="(StkFloat x, StkFloat y, StkFloat z)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Vector3D.html#a65fd03de6d9d42ea53a6cb8418ee7149">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" align="right" valign="top"><a class="anchor" id="a9825ba3adb8fb272d2e3ca20740a48c5"></a><!-- doxytag: member="stk::Vector3D::setX" ref="a9825ba3adb8fb272d2e3ca20740a48c5" args="(StkFloat x)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Vector3D.html#a9825ba3adb8fb272d2e3ca20740a48c5">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" align="right" valign="top"><a class="anchor" id="a94de5326b083c6cf72f509aa0fc532f3"></a><!-- doxytag: member="stk::Vector3D::setY" ref="a94de5326b083c6cf72f509aa0fc532f3" args="(StkFloat y)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Vector3D.html#a94de5326b083c6cf72f509aa0fc532f3">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" align="right" valign="top"><a class="anchor" id="a826f2aa5e7b95a0d91f9432f26bec881"></a><!-- doxytag: member="stk::Vector3D::setZ" ref="a826f2aa5e7b95a0d91f9432f26bec881" args="(StkFloat z)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Vector3D.html#a826f2aa5e7b95a0d91f9432f26bec881">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>
<p>STK 3D vector class. </p>
<p>This class implements a three-dimensional vector.</p>
<p>by Perry R. Cook, 1995-2012. </p>
<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></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>&copy;1995-2012 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
</table>

</BODY>
</HTML>