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


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245
							<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>TorqueScript Reference: Matrix Math</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" />
<link href="t2d-stylesheet-extra.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 id="projectrow">
  <td id="projectalign">
   <div id="projectname">TorqueScript Reference
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',false,false,'search.php','Search');
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle"><div class="title">Matrix Math<div class="ingroups"><a class="el" href="group__TorqueScriptFunctions.html">Function Categories</a></div></div></div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gac5c5f4fa95a596f0fe4432e50167e7f4" id="r_gac5c5f4fa95a596f0fe4432e50167e7f4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__MatrixMathFunctions.html#gac5c5f4fa95a596f0fe4432e50167e7f4">MatrixCreate</a> (posVec, rotVec)</td></tr>
<tr class="separator:gac5c5f4fa95a596f0fe4432e50167e7f4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaff69a2f937f57ebb03643143ee40bb5b" id="r_gaff69a2f937f57ebb03643143ee40bb5b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__MatrixMathFunctions.html#gaff69a2f937f57ebb03643143ee40bb5b">MatrixCreateFromEuler</a> (rotVec)</td></tr>
<tr class="separator:gaff69a2f937f57ebb03643143ee40bb5b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae41a6d1bb084a95329df7aa38be7b9d2" id="r_gae41a6d1bb084a95329df7aa38be7b9d2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__MatrixMathFunctions.html#gae41a6d1bb084a95329df7aa38be7b9d2">MatrixMulPoint</a> (transform, point)</td></tr>
<tr class="separator:gae41a6d1bb084a95329df7aa38be7b9d2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae77d34fdc48d7700c78a87959fe15f57" id="r_gae77d34fdc48d7700c78a87959fe15f57"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__MatrixMathFunctions.html#gae77d34fdc48d7700c78a87959fe15f57">MatrixMultiply</a> (transformA, transformB)</td></tr>
<tr class="separator:gae77d34fdc48d7700c78a87959fe15f57"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gafff5d5df9764fd781d436a883ceca09e" id="r_gafff5d5df9764fd781d436a883ceca09e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__MatrixMathFunctions.html#gafff5d5df9764fd781d436a883ceca09e">MatrixMulVector</a> (transform, vector)</td></tr>
<tr class="separator:gafff5d5df9764fd781d436a883ceca09e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<h2 class="groupheader">Function Documentation</h2>
<a id="gac5c5f4fa95a596f0fe4432e50167e7f4" name="gac5c5f4fa95a596f0fe4432e50167e7f4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gac5c5f4fa95a596f0fe4432e50167e7f4">&#9670;&#160;</a></span>MatrixCreate()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> 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__MatrixMathFunctions.html#gaff69a2f937f57ebb03643143ee40bb5b">MatrixCreateFromEuler</a> </dd></dl>

</div>
</div>
<a id="gaff69a2f937f57ebb03643143ee40bb5b" name="gaff69a2f937f57ebb03643143ee40bb5b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaff69a2f937f57ebb03643143ee40bb5b">&#9670;&#160;</a></span>MatrixCreateFromEuler()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> 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__MatrixMathFunctions.html#gac5c5f4fa95a596f0fe4432e50167e7f4">MatrixCreate</a> </dd></dl>

</div>
</div>
<a id="gae41a6d1bb084a95329df7aa38be7b9d2" name="gae41a6d1bb084a95329df7aa38be7b9d2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gae41a6d1bb084a95329df7aa38be7b9d2">&#9670;&#160;</a></span>MatrixMulPoint()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> 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__MatrixMathFunctions.html#gae77d34fdc48d7700c78a87959fe15f57">MatrixMultiply</a>, <a class="el" href="group__MatrixMathFunctions.html#gafff5d5df9764fd781d436a883ceca09e">MatrixMulVector</a> </dd></dl>

</div>
</div>
<a id="gae77d34fdc48d7700c78a87959fe15f57" name="gae77d34fdc48d7700c78a87959fe15f57"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gae77d34fdc48d7700c78a87959fe15f57">&#9670;&#160;</a></span>MatrixMultiply()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> 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__MatrixMathFunctions.html#gae41a6d1bb084a95329df7aa38be7b9d2">MatrixMulPoint</a>, <a class="el" href="group__MatrixMathFunctions.html#gafff5d5df9764fd781d436a883ceca09e">MatrixMulVector</a> </dd></dl>

</div>
</div>
<a id="gafff5d5df9764fd781d436a883ceca09e" name="gafff5d5df9764fd781d436a883ceca09e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gafff5d5df9764fd781d436a883ceca09e">&#9670;&#160;</a></span>MatrixMulVector()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> 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__MatrixMathFunctions.html#gae41a6d1bb084a95329df7aa38be7b9d2">MatrixMulPoint</a>, <a class="el" href="group__MatrixMathFunctions.html#gae77d34fdc48d7700c78a87959fe15f57">MatrixMultiply</a> </dd></dl>

</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
</small></address>
</body>
</html>