classvector3.html

Tixys source code, include G.711, G.726, IMA-ADPCM etc.

<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Calculate the unit vector which is normal to the two vectors formed by (<em>point1</em> - this) and (<em>point2</em> - this). I.e. the unit vector which is at right angles to both of these; acording to the right-hand rule.<p>
Rounding inacuracies mean the length of this 'unit' vector will actualy lie in the range 0x0.fffe to 0x1.0000.<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>point1</em>&nbsp;</td><td>The first point. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>point2</em>&nbsp;</td><td>The second point.</td></tr>
  </table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>The normal vector.</dd></dl>

<p>
Definition at line <a class="el" href="vector3_8cpp-source.html#l00355">355</a> of file <a class="el" href="vector3_8cpp-source.html">vector3.cpp</a>.    </td>
  </tr>
</table>
<a class="anchor" name="a23" doxytag="Vector3::Angle"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">EXPORT <a class="el" href="group__fix.html#ga2">fixangle</a> Vector3::Angle           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">const <a class="el" href="classVector3.html">Vector3</a> &amp;&nbsp;</td>
          <td class="mdname" nowrap> <em>point1</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td class="md"></td>
          <td class="md" nowrap>const <a class="el" href="classVector3.html">Vector3</a> &amp;&nbsp;</td>
          <td class="mdname" nowrap> <em>point2</em></td>
        </tr>
        <tr>
          <td class="md"></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"> const</td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Calculate the angle between the two vectors formed by (<em>point1</em> - this) and (<em>point2</em> - this).<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>point1</em>&nbsp;</td><td>The first point. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>point2</em>&nbsp;</td><td>The second point.</td></tr>
  </table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>The angle. This lies in the range 0x0000 and 0x8000.</dd></dl>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="group__fix.html#ga2">fixangle</a></dd></dl>

<p>
Definition at line <a class="el" href="vector3_8cpp-source.html#l00361">361</a> of file <a class="el" href="vector3_8cpp-source.html">vector3.cpp</a>.    </td>
  </tr>
</table>
<a class="anchor" name="e0" doxytag="Vector3::Translate"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">EXPORT void Vector3::Translate           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="el" href="classVector3.html">Vector3</a> *&nbsp;</td>
          <td class="mdname" nowrap> <em>outVectors</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td class="md"></td>
          <td class="md" nowrap><a class="el" href="group__integers.html#ga6">uint</a>&nbsp;</td>
          <td class="mdname" nowrap> <em>vectorCount</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td class="md"></td>
          <td class="md" nowrap>const <a class="el" href="classVector3.html">Vector3</a> *&nbsp;</td>
          <td class="mdname" nowrap> <em>inVectors</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td class="md"></td>
          <td class="md" nowrap>const <a class="el" href="classVector3.html">Vector3</a> &amp;&nbsp;</td>
          <td class="mdname" nowrap> <em>offset</em></td>
        </tr>
        <tr>
          <td class="md"></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"><code> [static]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Translate an array of vectors. I.e. add the given offset to each vector in an array.<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>outVectors</em>&nbsp;</td><td>Pointer to array where translated vectors will be written to. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>vectorCount</em>&nbsp;</td><td>Number of vectors in array. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>inVectors</em>&nbsp;</td><td>Pointer to array vectors to be translated. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>offset</em>&nbsp;</td><td>The offset to add to each vector in the array.</td></tr>
  </table>
</dl>

<p>
Definition at line <a class="el" href="vector3_8cpp-source.html#l00367">367</a> of file <a class="el" href="vector3_8cpp-source.html">vector3.cpp</a>.    </td>
  </tr>
</table>
<a class="anchor" name="e1" doxytag="Vector3::Scale"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">EXPORT void Vector3::Scale           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="el" href="classVector3.html">Vector3</a> *&nbsp;</td>
          <td class="mdname" nowrap> <em>outVectors</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td class="md"></td>
          <td class="md" nowrap><a class="el" href="group__integers.html#ga6">uint</a>&nbsp;</td>
          <td class="mdname" nowrap> <em>vectorCount</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td class="md"></td>
          <td class="md" nowrap>const <a class="el" href="classVector3.html">Vector3</a> *&nbsp;</td>
          <td class="mdname" nowrap> <em>inVectors</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td class="md"></td>
          <td class="md" nowrap><a class="el" href="group__fix.html#ga0">fix</a>&nbsp;</td>
          <td class="mdname" nowrap> <em>scale</em></td>
        </tr>
        <tr>
          <td class="md"></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"><code> [static]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Scale an array of vectors. I.e. perform a scalar multiply on each vector in an array.<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>outVectors</em>&nbsp;</td><td>Pointer to array where scaled vectors will be written to. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>vectorCount</em>&nbsp;</td><td>Number of vectors in array. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>inVectors</em>&nbsp;</td><td>Pointer to array vectors to be scaled. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>scale</em>&nbsp;</td><td>The value to scale each component of each vector by.</td></tr>
  </table>
</dl>

<p>
Definition at line <a class="el" href="vector3_8cpp-source.html#l00384">384</a> of file <a class="el" href="vector3_8cpp-source.html">vector3.cpp</a>.    </td>
  </tr>
</table>
<a class="anchor" name="d0" doxytag="Vector3::NormaliseComponents"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">void Vector3::NormaliseComponents           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="el" href="group__integers.html#ga6">uint</a>&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>bits</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap><code> [private]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Scale the components of this array such that the component with the largest magnitude has its most-significant bit at the given position.<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>bits</em>&nbsp;</td><td>Bit position for MSB of largest component.</td></tr>
  </table>
</dl>

<p>
Definition at line <a class="el" href="vector3_8cpp-source.html#l00262">262</a> of file <a class="el" href="vector3_8cpp-source.html">vector3.cpp</a>.    </td>
  </tr>
</table>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="o0" doxytag="Vector3::X"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"><a class="el" href="group__fix.html#ga0">fix</a> <a class="el" href="classVector3.html#o0">Vector3::X</a>          </td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
The X component 
<p>
Definition at line <a class="el" href="vector3_8h-source.html#l00395">395</a> of file <a class="el" href="vector3_8h-source.html">vector3.h</a>.    </td>
  </tr>
</table>
<a class="anchor" name="o1" doxytag="Vector3::Y"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"><a class="el" href="group__fix.html#ga0">fix</a> <a class="el" href="classVector3.html#o1">Vector3::Y</a>          </td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
The Y component 
<p>
Definition at line <a class="el" href="vector3_8h-source.html#l00396">396</a> of file <a class="el" href="vector3_8h-source.html">vector3.h</a>.    </td>
  </tr>
</table>
<a class="anchor" name="o2" doxytag="Vector3::Z"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"><a class="el" href="group__fix.html#ga0">fix</a> <a class="el" href="classVector3.html#o2">Vector3::Z</a>          </td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
The Z component 
<p>
Definition at line <a class="el" href="vector3_8h-source.html#l00397">397</a> of file <a class="el" href="vector3_8h-source.html">vector3.h</a>.    </td>
  </tr>
</table>
<hr>The documentation for this class was generated from the following files:<ul>
<li>maths/<a class="el" href="vector3_8h-source.html">vector3.h</a><li>maths/<a class="el" href="vector3_8cpp-source.html">vector3.cpp</a></ul>
<HR>
<ADDRESS STYLE="align: right;"><SMALL>
Generated by&nbsp; <A HREF="http://www.doxygen.org/index.html">
<IMG SRC="doxygen.png" ALT="doxygen" ALIGN="middle" BORDER="0"></A> 1.4.1
</SMALL></ADDRESS>
</BODY></HTML>