group__MatrixMathFunctions.html 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <meta name="generator" content="Doxygen 1.8.3.1"/>
  7. <title>TorqueScript Reference: Matrix Math</title>
  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  9. <script type="text/javascript" src="jquery.js"></script>
  10. <script type="text/javascript" src="dynsections.js"></script>
  11. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  12. <link href="t2d-stylesheet-extra.css" rel="stylesheet" type="text/css"/>
  13. </head>
  14. <body>
  15. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  16. <div id="titlearea">
  17. <table cellspacing="0" cellpadding="0">
  18. <tbody>
  19. <tr style="height: 56px;">
  20. <td style="padding-left: 0.5em;">
  21. <div id="projectname">TorqueScript Reference
  22. </div>
  23. </td>
  24. </tr>
  25. </tbody>
  26. </table>
  27. </div>
  28. <!-- end header part -->
  29. <!-- Generated by Doxygen 1.8.3.1 -->
  30. <div id="navrow1" class="tabs">
  31. <ul class="tablist">
  32. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  33. <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
  34. <li><a href="modules.html"><span>Modules</span></a></li>
  35. <li><a href="annotated.html"><span>Classes</span></a></li>
  36. </ul>
  37. </div>
  38. </div><!-- top -->
  39. <div class="header">
  40. <div class="summary">
  41. <a href="#func-members">Functions</a> </div>
  42. <div class="headertitle">
  43. <div class="title">Matrix Math<div class="ingroups"><a class="el" href="group__TorqueScriptFunctions.html">Function Categories</a></div></div> </div>
  44. </div><!--header-->
  45. <div class="contents">
  46. <table class="memberdecls">
  47. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  48. Functions</h2></td></tr>
  49. <tr class="memitem: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>
  50. <tr class="separator:gac5c5f4fa95a596f0fe4432e50167e7f4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  51. <tr class="memitem: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>
  52. <tr class="separator:gaff69a2f937f57ebb03643143ee40bb5b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  53. <tr class="memitem: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>
  54. <tr class="separator:gae41a6d1bb084a95329df7aa38be7b9d2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  55. <tr class="memitem: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>
  56. <tr class="separator:gae77d34fdc48d7700c78a87959fe15f57"><td class="memSeparator" colspan="2">&#160;</td></tr>
  57. <tr class="memitem: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>
  58. <tr class="separator:gafff5d5df9764fd781d436a883ceca09e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  59. </table>
  60. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  61. <h2 class="groupheader">Function Documentation</h2>
  62. <a class="anchor" id="gac5c5f4fa95a596f0fe4432e50167e7f4"></a>
  63. <div class="memitem">
  64. <div class="memproto">
  65. <table class="memname">
  66. <tr>
  67. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> MatrixCreate </td>
  68. <td>(</td>
  69. <td class="paramtype">posVec&#160;</td>
  70. <td class="paramname">, </td>
  71. </tr>
  72. <tr>
  73. <td class="paramkey"></td>
  74. <td></td>
  75. <td class="paramtype">rotVec&#160;</td>
  76. <td class="paramname">&#160;</td>
  77. </tr>
  78. <tr>
  79. <td></td>
  80. <td>)</td>
  81. <td></td><td></td>
  82. </tr>
  83. </table>
  84. </div><div class="memdoc">
  85. <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>
  86. <dl class="params"><dt>Parameters</dt><dd>
  87. <table class="params">
  88. <tr><td class="paramname">posVec</td><td>A three-element floating-point translation vector: PosY PosZ. </td></tr>
  89. <tr><td class="paramname">rotVec</td><td>A four-element floating-point rotation vector: RotY RotZ. </td></tr>
  90. <tr><td class="paramname">These</td><td>re rotations about the specified axes. </td></tr>
  91. </table>
  92. </dd>
  93. </dl>
  94. <dl class="section return"><dt>Returns</dt><dd>Returns a transform matrix of the form PosY PosZ RotX RotY RotZ theta. </dd></dl>
  95. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__MatrixMathFunctions.html#gaff69a2f937f57ebb03643143ee40bb5b">MatrixCreateFromEuler</a> </dd></dl>
  96. </div>
  97. </div>
  98. <a class="anchor" id="gaff69a2f937f57ebb03643143ee40bb5b"></a>
  99. <div class="memitem">
  100. <div class="memproto">
  101. <table class="memname">
  102. <tr>
  103. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> MatrixCreateFromEuler </td>
  104. <td>(</td>
  105. <td class="paramtype">rotVec&#160;</td>
  106. <td class="paramname"></td><td>)</td>
  107. <td></td>
  108. </tr>
  109. </table>
  110. </div><div class="memdoc">
  111. <p>Use the MatrixCreateFromEuler function to calculate a transform matrix from a three-element floating-point rotation vector. </p>
  112. <dl class="params"><dt>Parameters</dt><dd>
  113. <table class="params">
  114. <tr><td class="paramname">rotVec</td><td>A three-element floating-point rotation vector: RotY RotZ. These are rotations about the specified axes. </td></tr>
  115. </table>
  116. </dd>
  117. </dl>
  118. <dl class="section return"><dt>Returns</dt><dd>Returns a transform matrix of the form \0 0 0 X Y Z theta. </dd></dl>
  119. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__MatrixMathFunctions.html#gac5c5f4fa95a596f0fe4432e50167e7f4">MatrixCreate</a> </dd></dl>
  120. </div>
  121. </div>
  122. <a class="anchor" id="gae41a6d1bb084a95329df7aa38be7b9d2"></a>
  123. <div class="memitem">
  124. <div class="memproto">
  125. <table class="memname">
  126. <tr>
  127. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> MatrixMulPoint </td>
  128. <td>(</td>
  129. <td class="paramtype">transform&#160;</td>
  130. <td class="paramname">, </td>
  131. </tr>
  132. <tr>
  133. <td class="paramkey"></td>
  134. <td></td>
  135. <td class="paramtype">point&#160;</td>
  136. <td class="paramname">&#160;</td>
  137. </tr>
  138. <tr>
  139. <td></td>
  140. <td>)</td>
  141. <td></td><td></td>
  142. </tr>
  143. </table>
  144. </div><div class="memdoc">
  145. <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>
  146. <dl class="params"><dt>Parameters</dt><dd>
  147. <table class="params">
  148. <tr><td class="paramname">transform</td><td>A seven-element transform matrix. </td></tr>
  149. <tr><td class="paramname">point</td><td>A three-element point/position vector. </td></tr>
  150. </table>
  151. </dd>
  152. </dl>
  153. <dl class="section return"><dt>Returns</dt><dd>Returns a three-element position vector. </dd></dl>
  154. <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>
  155. </div>
  156. </div>
  157. <a class="anchor" id="gae77d34fdc48d7700c78a87959fe15f57"></a>
  158. <div class="memitem">
  159. <div class="memproto">
  160. <table class="memname">
  161. <tr>
  162. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> MatrixMultiply </td>
  163. <td>(</td>
  164. <td class="paramtype">transformA&#160;</td>
  165. <td class="paramname">, </td>
  166. </tr>
  167. <tr>
  168. <td class="paramkey"></td>
  169. <td></td>
  170. <td class="paramtype">transformB&#160;</td>
  171. <td class="paramname">&#160;</td>
  172. </tr>
  173. <tr>
  174. <td></td>
  175. <td>)</td>
  176. <td></td><td></td>
  177. </tr>
  178. </table>
  179. </div><div class="memdoc">
  180. <p>Use the MatrixMultiply function to multiply two seven-element transform matrices to produce a new seven element matrix. </p>
  181. <dl class="params"><dt>Parameters</dt><dd>
  182. <table class="params">
  183. <tr><td class="paramname">transformA</td><td>A seven-element transform matrix of the form PosY PosZ RotX RotY RotZ theta. </td></tr>
  184. <tr><td class="paramname">transformB</td><td>A seven-element transform matrix of the form PosY PosZ RotX RotY RotZ theta. </td></tr>
  185. </table>
  186. </dd>
  187. </dl>
  188. <dl class="section return"><dt>Returns</dt><dd>Returns a seven-element matrix resulting from transiformA x transformB. </dd></dl>
  189. <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>
  190. </div>
  191. </div>
  192. <a class="anchor" id="gafff5d5df9764fd781d436a883ceca09e"></a>
  193. <div class="memitem">
  194. <div class="memproto">
  195. <table class="memname">
  196. <tr>
  197. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> MatrixMulVector </td>
  198. <td>(</td>
  199. <td class="paramtype">transform&#160;</td>
  200. <td class="paramname">, </td>
  201. </tr>
  202. <tr>
  203. <td class="paramkey"></td>
  204. <td></td>
  205. <td class="paramtype">vector&#160;</td>
  206. <td class="paramname">&#160;</td>
  207. </tr>
  208. <tr>
  209. <td></td>
  210. <td>)</td>
  211. <td></td><td></td>
  212. </tr>
  213. </table>
  214. </div><div class="memdoc">
  215. <p>Use the MatrixMulVector function to multiply a seven-element transform matrix with a three-element matrix. </p>
  216. <dl class="params"><dt>Parameters</dt><dd>
  217. <table class="params">
  218. <tr><td class="paramname">transform</td><td>A seven-element transform matrix of the form PosY PosZ RotX RotY RotZ theta. </td></tr>
  219. <tr><td class="paramname">vector</td><td>A three-element vector. </td></tr>
  220. </table>
  221. </dd>
  222. </dl>
  223. <dl class="section return"><dt>Returns</dt><dd>Returns three-element resulting from vector * transform. </dd></dl>
  224. <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>
  225. </div>
  226. </div>
  227. </div><!-- contents -->
  228. <!-- start footer part -->
  229. <hr class="footer"/><address class="footer"><small>
  230. Generated by &#160;<a href="http://www.doxygen.org/index.html">
  231. <img class="footer" src="doxygen.png" alt="doxygen"/>
  232. </a> 1.8.3.1
  233. </small></address>
  234. </body>
  235. </html>