<html> <head> <title>Cal3D: CalPlane 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>CalPlane Class Reference</h1><!-- doxytag: class="CalPlane" -->The plane 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="classCalPlane-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">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalPlane.html#11595299bdac4618e562d242d87f1f3c">eval</a> (<a class="el" href="classCalVector.html">CalVector</a> &p)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Transforms the vector instance by a matrix. <a href="#11595299bdac4618e562d242d87f1f3c"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a6bdc874935dc1d81464fca45a549ebf"></a><!-- doxytag: member="CalPlane::dist" ref="a6bdc874935dc1d81464fca45a549ebf" args="(CalVector &p)" --> float </td><td class="memItemRight" valign="bottom"><b>dist</b> (<a class="el" href="classCalVector.html">CalVector</a> &p)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="934b9cf54f34dbb6c9bf06789ff4f883"></a><!-- doxytag: member="CalPlane::setPosition" ref="934b9cf54f34dbb6c9bf06789ff4f883" args="(CalVector &p)" --> void </td><td class="memItemRight" valign="bottom"><b>setPosition</b> (<a class="el" href="classCalVector.html">CalVector</a> &p)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3fbfb94cbef39bde45a34df04c47f672"></a><!-- doxytag: member="CalPlane::setNormal" ref="3fbfb94cbef39bde45a34df04c47f672" args="(CalVector &p)" --> void </td><td class="memItemRight" valign="bottom"><b>setNormal</b> (<a class="el" href="classCalVector.html">CalVector</a> &p)</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="fdc7000cc1c2928401a6e0dcfa62e771"></a><!-- doxytag: member="CalPlane::a" ref="fdc7000cc1c2928401a6e0dcfa62e771" args="" --> float </td><td class="memItemRight" valign="bottom"><b>a</b></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9d49e6e8ca34113208ecc91aaa7ee2b4"></a><!-- doxytag: member="CalPlane::b" ref="9d49e6e8ca34113208ecc91aaa7ee2b4" args="" --> float </td><td class="memItemRight" valign="bottom"><b>b</b></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="910671bf937c5d62d6accc3e0e0b8faf"></a><!-- doxytag: member="CalPlane::c" ref="910671bf937c5d62d6accc3e0e0b8faf" args="" --> float </td><td class="memItemRight" valign="bottom"><b>c</b></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2653016a25fc73812fee65aee4e6e0d5"></a><!-- doxytag: member="CalPlane::d" ref="2653016a25fc73812fee65aee4e6e0d5" args="" --> float </td><td class="memItemRight" valign="bottom"><b>d</b></td></tr> </table> <hr><a name="_details"></a><h2>Detailed Description</h2> The plane class. <hr><h2>Member Function Documentation</h2> <a class="anchor" name="11595299bdac4618e562d242d87f1f3c"></a><!-- doxytag: member="CalPlane::eval" ref="11595299bdac4618e562d242d87f1f3c" args="(CalVector &p)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">float CalPlane::eval </td> <td>(</td> <td class="paramtype"><a class="el" href="classCalVector.html">CalVector</a> & </td> <td class="paramname"> <em>p</em> </td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p> Transforms the vector instance by a matrix. <p> This function transforms the vector instance by a given matrix.<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>m</em> </td><td>The matrix to be used for the transformation. Scales the vector instance.</td></tr> </table> </dl> This operator scales the vector instance by dividing 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 divide the vector components by. Tests the equality of 2 vectors This operator checks to see if 2 vectors are equal</td></tr> <tr><td valign="top"></td><td valign="top"><em>v</em> </td><td>The vector to be tested against. Calculates the sum of two vectors.</td></tr> </table> </dl> This operator calculates the sum of two vectors.<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 first vector to be added. </td></tr> <tr><td valign="top"></td><td valign="top"><em>u</em> </td><td>The second vector to be added.</td></tr> </table> </dl> <dl class="return" compact><dt><b>Returns:</b></dt><dd>The sum of the two vectors. Calculates the difference of two vectors.</dd></dl> This operator calculates the difference of two vectors.<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 first vector to be added. </td></tr> <tr><td valign="top"></td><td valign="top"><em>u</em> </td><td>The second vector to be subtracted.</td></tr> </table> </dl> <dl class="return" compact><dt><b>Returns:</b></dt><dd>The difference of the two vectors. Calculates a scaled vector.</dd></dl> This operator calculates the vector multiplied by a 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>v</em> </td><td>The vector to be scaled. </td></tr> <tr><td valign="top"></td><td valign="top"><em>d</em> </td><td>The factor to multiply the vector with.</td></tr> </table> </dl> <dl class="return" compact><dt><b>Returns:</b></dt><dd>The scaled vector. Calculates a scaled vector.</dd></dl> This operator calculates the vector multiplied by a 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 with. </td></tr> <tr><td valign="top"></td><td valign="top"><em>v</em> </td><td>The vector to be scaled.</td></tr> </table> </dl> <dl class="return" compact><dt><b>Returns:</b></dt><dd>The scaled vector. Calculates a scaled vector.</dd></dl> This operator calculates the vector divided by a 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>v</em> </td><td>The vector to be scaled. </td></tr> <tr><td valign="top"></td><td valign="top"><em>d</em> </td><td>The factor to divide the vector with.</td></tr> </table> </dl> <dl class="return" compact><dt><b>Returns:</b></dt><dd>The scaled vector. Calculates the dot product of two vectors.</dd></dl> This operator calculates the dot product of two vectors.<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 first vector. </td></tr> <tr><td valign="top"></td><td valign="top"><em>u</em> </td><td>The second vector.</td></tr> </table> </dl> <dl class="return" compact><dt><b>Returns:</b></dt><dd>The dot product of the two vectors. Calculates the vector product of two vectors.</dd></dl> This operator calculates the vector product of two vectors.<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 first vector. </td></tr> <tr><td valign="top"></td><td valign="top"><em>u</em> </td><td>The second vector.</td></tr> </table> </dl> <dl class="return" compact><dt><b>Returns:</b></dt><dd>The vector product of the two vectors. Interpolates the vector instance to another vector.</dd></dl> This function interpolates the vector instance to another vector by a given 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 blending factor in the range [0.0, 1.0]. </td></tr> <tr><td valign="top"></td><td valign="top"><em>v</em> </td><td>The vector to be interpolated to. Clears the vector instance.</td></tr> </table> </dl> This function clears the vector instance. Returns the length of the vector instance.<p> This function returns the length of the vector instance.<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd>The length of the vector instance. Normalizes the vector instance.</dd></dl> This function normalizes the vector instance and returns its former length.<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd>The length of the vector instance before normalizing. Sets new values.</dd></dl> This function sets new values in 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>x</em> </td><td>The x component. </td></tr> <tr><td valign="top"></td><td valign="top"><em>y</em> </td><td>The y component. </td></tr> <tr><td valign="top"></td><td valign="top"><em>z</em> </td><td>The z component. </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>