TorqueEngine
/
Torque2D
mirror of https://github.com/TorqueGameEngines/Torque2D.git


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227
							<!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"/>
<title>MatrixMath</title>
<link href="torquedoc.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<table width="100%" class="header">
<tr>
</tr>
<tr><td class="headermenu">
	<center>
	<a class="qindex" href="index.html">Main</a> &nbsp; 
	<a class="qindex" target="_blank" href="https://github.com/GarageGames/Torque2D">GitHub</a>
	</center>
</td></tr>
</table>
<br>
<!-- END HEADER -->
<!-- Generated by Doxygen 1.8.3.1 -->
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">MatrixMath</div>  </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga79e610376d98d6c14bb0aca48d905d28"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__MatrixMath.html#ga79e610376d98d6c14bb0aca48d905d28">MatrixCreate</a> (posVec, rotVec)</td></tr>
<tr class="separator:ga79e610376d98d6c14bb0aca48d905d28"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae855c048d3197b292a2ccf7125f90e70"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__MatrixMath.html#gae855c048d3197b292a2ccf7125f90e70">MatrixCreateFromEuler</a> (rotVec)</td></tr>
<tr class="separator:gae855c048d3197b292a2ccf7125f90e70"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga863e7811050f8841e92e6f992db05614"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__MatrixMath.html#ga863e7811050f8841e92e6f992db05614">MatrixMulPoint</a> (transform, point)</td></tr>
<tr class="separator:ga863e7811050f8841e92e6f992db05614"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga93005c7f1e016d6d265a3b75694d7441"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__MatrixMath.html#ga93005c7f1e016d6d265a3b75694d7441">MatrixMultiply</a> (transformA, transformB)</td></tr>
<tr class="separator:ga93005c7f1e016d6d265a3b75694d7441"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2136a0071615f55cdf6f4a4401cb2b6c"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__MatrixMath.html#ga2136a0071615f55cdf6f4a4401cb2b6c">MatrixMulVector</a> (transform, vector)</td></tr>
<tr class="separator:ga2136a0071615f55cdf6f4a4401cb2b6c"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Matrix manipulation functions. </p>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga79e610376d98d6c14bb0aca48d905d28"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">string MatrixCreate </td>
          <td>(</td>
          <td class="paramtype">posVec&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">rotVec&#160;</td>
          <td class="paramname">&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Use the matrixCreate function to create a transform matrix from a three-element floating-point translation vector and a four-element floating-point rotation vector. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">posVec</td><td>A three-element floating-point translation vector: "PosX PosY PosZ". </td></tr>
    <tr><td class="paramname">rotVec</td><td>A four-element floating-point rotation vector: "RotX RotY RotZ". </td></tr>
    <tr><td class="paramname">These</td><td>re rotations about the specified axes. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a transform matrix of the form "PosX PosY PosZ RotX RotY RotZ theta". </dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__MatrixMath.html#gae855c048d3197b292a2ccf7125f90e70">MatrixCreateFromEuler</a> </dd></dl>

</div>
</div>
<a class="anchor" id="gae855c048d3197b292a2ccf7125f90e70"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">string MatrixCreateFromEuler </td>
          <td>(</td>
          <td class="paramtype">rotVec&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Use the MatrixCreateFromEuler function to calculate a transform matrix from a three-element floating-point rotation vector. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">rotVec</td><td>A three-element floating-point rotation vector: "RotX RotY RotZ". These are rotations about the specified axes. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a transform matrix of the form "0 0 0 X Y Z theta". </dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__MatrixMath.html#ga79e610376d98d6c14bb0aca48d905d28">MatrixCreate</a> </dd></dl>

</div>
</div>
<a class="anchor" id="ga863e7811050f8841e92e6f992db05614"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">string MatrixMulPoint </td>
          <td>(</td>
          <td class="paramtype">transform&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">point&#160;</td>
          <td class="paramname">&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Use the MatrixMulPoint function to multiply a seven element transform matrix by a three element point vector, producing a three element position vector. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">transform</td><td>A seven-element transform matrix. </td></tr>
    <tr><td class="paramname">point</td><td>A three-element point/position vector. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a three-element position vector. </dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__MatrixMath.html#ga93005c7f1e016d6d265a3b75694d7441">MatrixMultiply</a>, <a class="el" href="group__MatrixMath.html#ga2136a0071615f55cdf6f4a4401cb2b6c">MatrixMulVector</a> </dd></dl>

</div>
</div>
<a class="anchor" id="ga93005c7f1e016d6d265a3b75694d7441"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">string MatrixMultiply </td>
          <td>(</td>
          <td class="paramtype">transformA&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">transformB&#160;</td>
          <td class="paramname">&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Use the MatrixMultiply function to multiply two seven-element transform matrices to produce a new seven element matrix. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">transformA</td><td>A seven-element transform matrix of the form "PosX PosY PosZ RotX RotY RotZ theta". </td></tr>
    <tr><td class="paramname">transformB</td><td>A seven-element transform matrix of the form "PosX PosY PosZ RotX RotY RotZ theta". </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a seven-element matrix resulting from transiformA x transformB. </dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__MatrixMath.html#ga863e7811050f8841e92e6f992db05614">MatrixMulPoint</a>, <a class="el" href="group__MatrixMath.html#ga2136a0071615f55cdf6f4a4401cb2b6c">MatrixMulVector</a> </dd></dl>

</div>
</div>
<a class="anchor" id="ga2136a0071615f55cdf6f4a4401cb2b6c"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">string MatrixMulVector </td>
          <td>(</td>
          <td class="paramtype">transform&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">vector&#160;</td>
          <td class="paramname">&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Use the MatrixMulVector function to multiply a seven-element transform matrix with a three-element matrix. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">transform</td><td>A seven-element transform matrix of the form "PosX PosY PosZ RotX RotY RotZ theta". </td></tr>
    <tr><td class="paramname">vector</td><td>A three-element vector. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns three-element resulting from vector * transform. </dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__MatrixMath.html#ga863e7811050f8841e92e6f992db05614">MatrixMulPoint</a>, <a class="el" href="group__MatrixMath.html#ga93005c7f1e016d6d265a3b75694d7441">MatrixMultiply</a> </dd></dl>

</div>
</div>
</div><!-- contents -->
<!-- START FOOTER -->
<br>
<br>
<center>
	<div style="color: #777777;">
	Copyright &copy; 2013 <a style="color: #777777;" target="_blank" href="http://www.garagegames.com">GarageGames, LLC</a>. All Rights Reserved.
	</div>
</center>
</body>
</html>