<html>
<head>
<title>Cal3D: CalVector Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head>
<body bgcolor="#ffffff">
<table width="100%" border="0" cellspacing="0" cellpadding="5" align="center">
<tr>
<td class="md" align="center">
<small>
<b>- Cal3D 0.11 API Reference -</b>
</small>
</td>
</tr>
</table>
<br>
<!-- Generated by Doxygen 1.5.9 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</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 class="tabs">
<ul>
<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>
<div class="contents">
<h1>CalVector Class Reference</h1><!-- doxytag: class="CalVector" -->The vector class.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="vector_8h_source.html">vector.h</a>></code>
<p>
<p>
<a href="classCalVector-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="d15b9c87129f1082b1be25b486e6fba6"></a><!-- doxytag: member="CalVector::CalVector" ref="d15b9c87129f1082b1be25b486e6fba6" args="(const CalVector &v)" -->
</td><td class="memItemRight" valign="bottom"><b>CalVector</b> (const <a class="el" href="classCalVector.html">CalVector</a> &v)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ab882a9f52cc8dc49e97b59cf38ad189"></a><!-- doxytag: member="CalVector::CalVector" ref="ab882a9f52cc8dc49e97b59cf38ad189" args="(float vx, float vy, float vz)" -->
</td><td class="memItemRight" valign="bottom"><b>CalVector</b> (float vx, float vy, float vz)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="55ccd4dc4114fd2731cbdceb90e8da5c"></a><!-- doxytag: member="CalVector::operator[]" ref="55ccd4dc4114fd2731cbdceb90e8da5c" args="(unsigned int i)" -->
float & </td><td class="memItemRight" valign="bottom"><b>operator[]</b> (unsigned int i)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="96af0fb2d3ecb853bc73fb9cfa7d325d"></a><!-- doxytag: member="CalVector::operator[]" ref="96af0fb2d3ecb853bc73fb9cfa7d325d" args="(unsigned int i) const " -->
const float & </td><td class="memItemRight" valign="bottom"><b>operator[]</b> (unsigned int i) const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e7be7033a81084cd445a7dde6cfac4c0"></a><!-- doxytag: member="CalVector::operator=" ref="e7be7033a81084cd445a7dde6cfac4c0" args="(const CalVector &v)" -->
void </td><td class="memItemRight" valign="bottom"><b>operator=</b> (const <a class="el" href="classCalVector.html">CalVector</a> &v)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="bc7bbd7e7df16b5a50c90f84c62c1be5"></a><!-- doxytag: member="CalVector::operator+=" ref="bc7bbd7e7df16b5a50c90f84c62c1be5" args="(const CalVector &v)" -->
void </td><td class="memItemRight" valign="bottom"><b>operator+=</b> (const <a class="el" href="classCalVector.html">CalVector</a> &v)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2e956f0fe90142ec8a79a92eeef35c3e"></a><!-- doxytag: member="CalVector::operator-=" ref="2e956f0fe90142ec8a79a92eeef35c3e" args="(const CalVector &v)" -->
void </td><td class="memItemRight" valign="bottom"><b>operator-=</b> (const <a class="el" href="classCalVector.html">CalVector</a> &v)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="bc11d932b4b2d0d1cc87c1d4f16c212b"></a><!-- doxytag: member="CalVector::operator*=" ref="bc11d932b4b2d0d1cc87c1d4f16c212b" args="(const float d)" -->
void </td><td class="memItemRight" valign="bottom"><b>operator*=</b> (const float d)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalVector.html#3cda3ee19a74a1cc93f348920340bc87">operator*=</a> (const <a class="el" href="classCalQuaternion.html">CalQuaternion</a> &q)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructs the vector instance. <a href="#3cda3ee19a74a1cc93f348920340bc87"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b2c8ae5eabee18ddfc9fa3b0b910162e"></a><!-- doxytag: member="CalVector::operator*=" ref="b2c8ae5eabee18ddfc9fa3b0b910162e" args="(const CalMatrix &m)" -->
void </td><td class="memItemRight" valign="bottom"><b>operator*=</b> (const <a class="el" href="classCalMatrix.html">CalMatrix</a> &m)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a6b03fedf3a5cdf0f00c66354be05c4f"></a><!-- doxytag: member="CalVector::operator/=" ref="a6b03fedf3a5cdf0f00c66354be05c4f" args="(const float d)" -->
void </td><td class="memItemRight" valign="bottom"><b>operator/=</b> (const float d)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="040bae41ac7e7ba771c63e735a96af5e"></a><!-- doxytag: member="CalVector::operator==" ref="040bae41ac7e7ba771c63e735a96af5e" args="(const CalVector &v) const " -->
bool </td><td class="memItemRight" valign="bottom"><b>operator==</b> (const <a class="el" href="classCalVector.html">CalVector</a> &v) const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ddbda955ba5ce8ad0949480cc6f16331"></a><!-- doxytag: member="CalVector::operator!=" ref="ddbda955ba5ce8ad0949480cc6f16331" args="(const CalVector &v) const " -->
bool </td><td class="memItemRight" valign="bottom"><b>operator!=</b> (const <a class="el" href="classCalVector.html">CalVector</a> &v) const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="250eb66042a694e996180c3971d5dd7d"></a><!-- doxytag: member="CalVector::blend" ref="250eb66042a694e996180c3971d5dd7d" args="(float d, const CalVector &v)" -->
void </td><td class="memItemRight" valign="bottom"><b>blend</b> (float d, const <a class="el" href="classCalVector.html">CalVector</a> &v)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7aee9f83640453cbe0632b430fb72c4e"></a><!-- doxytag: member="CalVector::clear" ref="7aee9f83640453cbe0632b430fb72c4e" args="()" -->
void </td><td class="memItemRight" valign="bottom"><b>clear</b> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8d9cd17d82e9c983afd9dc7b360950f9"></a><!-- doxytag: member="CalVector::length" ref="8d9cd17d82e9c983afd9dc7b360950f9" args="() const " -->
float </td><td class="memItemRight" valign="bottom"><b>length</b> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4d130d8b46c639cfd4a436e40e933f67"></a><!-- doxytag: member="CalVector::normalize" ref="4d130d8b46c639cfd4a436e40e933f67" args="()" -->
float </td><td class="memItemRight" valign="bottom"><b>normalize</b> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4c2933c4670c0bb92799afdebc863254"></a><!-- doxytag: member="CalVector::set" ref="4c2933c4670c0bb92799afdebc863254" args="(float vx, float vy, float vz)" -->
void </td><td class="memItemRight" valign="bottom"><b>set</b> (float vx, float vy, float vz)</td></tr>
<tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1f7f3fa17f42c29a4c43f3b75b9cf1b6"></a><!-- doxytag: member="CalVector::x" ref="1f7f3fa17f42c29a4c43f3b75b9cf1b6" args="" -->
float </td><td class="memItemRight" valign="bottom"><b>x</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9f9249ee3ae7d91be3b9e2f7658c309e"></a><!-- doxytag: member="CalVector::y" ref="9f9249ee3ae7d91be3b9e2f7658c309e" args="" -->
float </td><td class="memItemRight" valign="bottom"><b>y</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="cee94b707c902ef9e510e380f632dc79"></a><!-- doxytag: member="CalVector::z" ref="cee94b707c902ef9e510e380f632dc79" args="" -->
float </td><td class="memItemRight" valign="bottom"><b>z</b></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
The vector class. <hr><h2>Member Function Documentation</h2>
<a class="anchor" name="3cda3ee19a74a1cc93f348920340bc87"></a><!-- doxytag: member="CalVector::operator*=" ref="3cda3ee19a74a1cc93f348920340bc87" args="(const CalQuaternion &q)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CalVector::operator*= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCalQuaternion.html">CalQuaternion</a> & </td>
<td class="paramname"> <em>q</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Constructs the vector instance.
<p>
This function is the default constructor of the vector instance. Constructs the vector instance.<p>
This function is a constructor of the vector instance.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>v</em> </td><td>The vector to construct this vector instance from. Constructs the vector instance.</td></tr>
</table>
</dl>
This function is a constructor of the vector instance.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>vx</em> </td><td>The x component. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>vy</em> </td><td>The y component. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>vz</em> </td><td>The z component. Destructs the vector instance.</td></tr>
</table>
</dl>
This function is the destructor of the vector instance. Provides access to the components of the vector instance.<p>
This function provides read and write access to the three components of the vector instance.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>i</em> </td><td>The index to the specific component.</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>A reference to the specific component. Provides access to the components of the vector instance.</dd></dl>
This function provides read access to the three components of the vector instance.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>i</em> </td><td>The index to the specific component.</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>A constant reference to the specific component. Equates the vector instance with another vector.</dd></dl>
This operator equates the vector instance with another vector.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>v</em> </td><td>The vector to equate the vector instance with. Adds another vector to the vector instance.</td></tr>
</table>
</dl>
This operator adds another vector to the vector instance.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>v</em> </td><td>The vector to be added. Subtracts another vector from the vector instance.</td></tr>
</table>
</dl>
This operator subtracts another vector from the vector instance.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>v</em> </td><td>The vector to be subtracted. Scales the vector instance.</td></tr>
</table>
</dl>
This operator scales the vector instance by multiplying its components by a specific factor.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>d</em> </td><td>The factor to multiply the vector components by. Transforms the vector instance by a quaternion.</td></tr>
</table>
</dl>
This function transforms the vector instance by a given quaternion.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>q</em> </td><td>The quaternion to be used for the transformation. </td></tr>
</table>
</dl>
</div>
</div><p>
<hr>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="vector_8h_source.html">vector.h</a><li>vector.cpp</ul>
</div>
<hr>
<center>
<small>
Generated at Fri Jul 24 21:14:57 2009 by
<a href="http://gna.org/projects/cal3d/">The Cal3D Team</a>
with
<a href="http://www.doxygen.org/index.html">
Doxygen 1.5.9
</a>
</small>
</center>
</body>
</html>
