<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>The Gnome Chemistry Utils: gcu::Vector3f Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">The Gnome Chemistry Utils
 <span id="projectnumber">0.14.2</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.1.2 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespacegcu.html">gcu</a></li><li class="navelem"><a class="el" href="classgcu_1_1Vector3f.html">Vector3f</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="classgcu_1_1Vector3f-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">gcu::Vector3f Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include <<a class="el" href="vector_8h_source.html">gcu/vector.h</a>></code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a01be9f06b15c9d647f34c2fdd5e699d2"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcu_1_1Vector3f.html#a01be9f06b15c9d647f34c2fdd5e699d2">Vector3f</a> ()</td></tr>
<tr class="memitem:a8239716aa05404b625e41d205ec94275"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcu_1_1Vector3f.html#a8239716aa05404b625e41d205ec94275">Vector3f</a> (float x, float y, float z)</td></tr>
<tr class="memitem:a8be7aa1f589fb2fc2ddfa77320144d33"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcu_1_1Vector3f.html#a8be7aa1f589fb2fc2ddfa77320144d33">~Vector3f</a> ()</td></tr>
<tr class="memitem:a7a2fd0b91013ea160441cc413b7f3df4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgcu_1_1Vector3f.html">Vector3f</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcu_1_1Vector3f.html#a7a2fd0b91013ea160441cc413b7f3df4">operator=</a> (<a class="el" href="classgcu_1_1Vector3f.html">Vector3f</a> const &other)</td></tr>
<tr class="memitem:a4bf89dc634e003ee85a4989e5603d5e6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgcu_1_1Vector3f.html">Vector3f</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcu_1_1Vector3f.html#a4bf89dc634e003ee85a4989e5603d5e6">operator-</a> (<a class="el" href="classgcu_1_1Vector3f.html">Vector3f</a> const &other) const </td></tr>
<tr class="memitem:a518eece4143262874fda90ccf7ce2929"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgcu_1_1Vector3f.html">Vector3f</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcu_1_1Vector3f.html#a518eece4143262874fda90ccf7ce2929">operator+</a> (<a class="el" href="classgcu_1_1Vector3f.html">Vector3f</a> const &other) const </td></tr>
<tr class="memitem:aaa58dfea3dc63133b1bcf64eb0cef0c7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgcu_1_1Vector3f.html">Vector3f</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcu_1_1Vector3f.html#aaa58dfea3dc63133b1bcf64eb0cef0c7">operator*</a> (float f) const </td></tr>
<tr class="memitem:a93a311a7b2555ccfb3323d2dd950ea81"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcu_1_1Vector3f.html#a93a311a7b2555ccfb3323d2dd950ea81">Setx</a> (float val)</td></tr>
<tr class="memitem:aa3a9f0615d56706e2cc9799971230c02"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcu_1_1Vector3f.html#aa3a9f0615d56706e2cc9799971230c02">Getx</a> (void) const </td></tr>
<tr class="memitem:a5dd326783b8c2a8cdaed893950f3e7d6"><td class="memItemLeft" align="right" valign="top">float & </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcu_1_1Vector3f.html#a5dd326783b8c2a8cdaed893950f3e7d6">GetRefx</a> (void)</td></tr>
<tr class="memitem:ad9f8666db765420b752a7b2cfc3a4832"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcu_1_1Vector3f.html#ad9f8666db765420b752a7b2cfc3a4832">Sety</a> (float val)</td></tr>
<tr class="memitem:a5151cab0cc0782b03516b579f4853deb"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcu_1_1Vector3f.html#a5151cab0cc0782b03516b579f4853deb">Gety</a> (void) const </td></tr>
<tr class="memitem:acc262dcb14a691377bf11d97c9852c84"><td class="memItemLeft" align="right" valign="top">float & </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcu_1_1Vector3f.html#acc262dcb14a691377bf11d97c9852c84">GetRefy</a> (void)</td></tr>
<tr class="memitem:a7f87c3bbe35dc47acde461cba7bef2e8"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcu_1_1Vector3f.html#a7f87c3bbe35dc47acde461cba7bef2e8">Setz</a> (float val)</td></tr>
<tr class="memitem:a455a7d65d04593d0378b0ed229d1fef0"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcu_1_1Vector3f.html#a455a7d65d04593d0378b0ed229d1fef0">Getz</a> (void) const </td></tr>
<tr class="memitem:a0fef2f7b095a5393022eb8574312b66b"><td class="memItemLeft" align="right" valign="top">float & </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcu_1_1Vector3f.html#a0fef2f7b095a5393022eb8574312b66b">GetRefz</a> (void)</td></tr>
</table>
<a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Utility 3d vectors class used by the <a class="el" href="classgcu_1_1Sphere.html">gcu::Sphere</a> class. </p>
<p>Definition at line <a class="el" href="vector_8h_source.html#l00177">177</a> of file <a class="el" href="vector_8h_source.html">vector.h</a>.</p>
</div><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a01be9f06b15c9d647f34c2fdd5e699d2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gcu::Vector3f::Vector3f </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructs a vector with all three coordinates equal to 0. </p>
</div>
</div>
<a class="anchor" id="a8239716aa05404b625e41d205ec94275"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gcu::Vector3f::Vector3f </td>
<td>(</td>
<td class="paramtype">float </td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"><em>y</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"><em>z</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">x</td><td>the x coordinate. </td></tr>
<tr><td class="paramname">y</td><td>the y coordinate. </td></tr>
<tr><td class="paramname">z</td><td>the z coordinate.</td></tr>
</table>
</dd>
</dl>
<p>Constructs a vector given its three coordinates. </p>
</div>
</div>
<a class="anchor" id="a8be7aa1f589fb2fc2ddfa77320144d33"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gcu::Vector3f::~Vector3f </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>The destructor. </p>
</div>
</div>
<h2>Member Function Documentation</h2>
<a class="anchor" id="a5dd326783b8c2a8cdaed893950f3e7d6"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">gcu::Vector3f::GetRefx </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>the first coordinate of the vector as a reference. </dd></dl>
<p>Definition at line <a class="el" href="vector_8h_source.html#l00238">238</a> of file <a class="el" href="vector_8h_source.html">vector.h</a>.</p>
</div>
</div>
<a class="anchor" id="acc262dcb14a691377bf11d97c9852c84"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">gcu::Vector3f::GetRefy </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>the second coordinate of the vector as a reference. </dd></dl>
<p>Definition at line <a class="el" href="vector_8h_source.html#l00250">250</a> of file <a class="el" href="vector_8h_source.html">vector.h</a>.</p>
</div>
</div>
<a class="anchor" id="a0fef2f7b095a5393022eb8574312b66b"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">gcu::Vector3f::GetRefz </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>the third coordinate of the vector as a reference. </dd></dl>
<p>Definition at line <a class="el" href="vector_8h_source.html#l00262">262</a> of file <a class="el" href="vector_8h_source.html">vector.h</a>.</p>
</div>
</div>
<a class="anchor" id="aa3a9f0615d56706e2cc9799971230c02"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">gcu::Vector3f::Getx </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>the first coordinate of the vector. </dd></dl>
<p>Definition at line <a class="el" href="vector_8h_source.html#l00238">238</a> of file <a class="el" href="vector_8h_source.html">vector.h</a>.</p>
</div>
</div>
<a class="anchor" id="a5151cab0cc0782b03516b579f4853deb"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">gcu::Vector3f::Gety </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>the second coordinate of the vector. </dd></dl>
<p>Definition at line <a class="el" href="vector_8h_source.html#l00250">250</a> of file <a class="el" href="vector_8h_source.html">vector.h</a>.</p>
</div>
</div>
<a class="anchor" id="a455a7d65d04593d0378b0ed229d1fef0"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">gcu::Vector3f::Getz </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>the third coordinate of the vector. </dd></dl>
<p>Definition at line <a class="el" href="vector_8h_source.html#l00262">262</a> of file <a class="el" href="vector_8h_source.html">vector.h</a>.</p>
</div>
</div>
<a class="anchor" id="aaa58dfea3dc63133b1bcf64eb0cef0c7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classgcu_1_1Vector3f.html">Vector3f</a> gcu::Vector3f::operator* </td>
<td>(</td>
<td class="paramtype">float </td>
<td class="paramname"><em>f</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">f</td><td>a real parameter.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the vector multiplied by <em>f</em>. </dd></dl>
</div>
</div>
<a class="anchor" id="a518eece4143262874fda90ccf7ce2929"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classgcu_1_1Vector3f.html">Vector3f</a> gcu::Vector3f::operator+ </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classgcu_1_1Vector3f.html">Vector3f</a> const & </td>
<td class="paramname"><em>other</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">other</td><td>a <a class="el" href="classgcu_1_1Vector3f.html">Vector3f</a> to add.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the some of the two vectors. </dd></dl>
</div>
</div>
<a class="anchor" id="a4bf89dc634e003ee85a4989e5603d5e6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classgcu_1_1Vector3f.html">Vector3f</a> gcu::Vector3f::operator- </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classgcu_1_1Vector3f.html">Vector3f</a> const & </td>
<td class="paramname"><em>other</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">other</td><td>a <a class="el" href="classgcu_1_1Vector3f.html">Vector3f</a> to substract.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd></dd></dl>
</div>
</div>
<a class="anchor" id="a7a2fd0b91013ea160441cc413b7f3df4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classgcu_1_1Vector3f.html">Vector3f</a>& gcu::Vector3f::operator= </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classgcu_1_1Vector3f.html">Vector3f</a> const & </td>
<td class="paramname"><em>other</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">other</td><td>a <a class="el" href="classgcu_1_1Vector3f.html">Vector3f</a> to copy.</td></tr>
</table>
</dd>
</dl>
<p>The assignment operator. </p>
<dl class="section return"><dt>Returns</dt><dd>a new vector identical to <em>other</em> and <em>this</em>. </dd></dl>
</div>
</div>
<a class="anchor" id="a93a311a7b2555ccfb3323d2dd950ea81"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">gcu::Vector3f::Setx </td>
<td>(</td>
<td class="paramtype">float </td>
<td class="paramname"><em>x</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">x</td><td>the new value for the first coordinate.</td></tr>
</table>
</dd>
</dl>
<p>Sets the first coordinate of the vector. </p>
<p>Definition at line <a class="el" href="vector_8h_source.html#l00238">238</a> of file <a class="el" href="vector_8h_source.html">vector.h</a>.</p>
</div>
</div>
<a class="anchor" id="ad9f8666db765420b752a7b2cfc3a4832"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">gcu::Vector3f::Sety </td>
<td>(</td>
<td class="paramtype">float </td>
<td class="paramname"><em>y</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">y</td><td>the new value for the second coordinate.</td></tr>
</table>
</dd>
</dl>
<p>Sets the second coordinate of the vector. </p>
<p>Definition at line <a class="el" href="vector_8h_source.html#l00250">250</a> of file <a class="el" href="vector_8h_source.html">vector.h</a>.</p>
</div>
</div>
<a class="anchor" id="a7f87c3bbe35dc47acde461cba7bef2e8"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">gcu::Vector3f::Setz </td>
<td>(</td>
<td class="paramtype">float </td>
<td class="paramname"><em>z</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">z</td><td>the new value for the third coordinate.</td></tr>
</table>
</dd>
</dl>
<p>Sets the third coordinate of the vector. </p>
<p>Definition at line <a class="el" href="vector_8h_source.html#l00262">262</a> of file <a class="el" href="vector_8h_source.html">vector.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="vector_8h_source.html">vector.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Mar 14 2013 17:34:32 for The Gnome Chemistry Utils by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.1.2
</small></address>
</body>
</html>
