group__Vector2Math.html 30 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541
  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: Vector2 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">Vector2 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:ga6ecb30bbf007e18418773cb98c324303"><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__Vector2Math.html#ga6ecb30bbf007e18418773cb98c324303">Vector2Abs</a> (<a class="el" href="group__TorqueScriptTypes.html#ga9e94493e2a334dee294c516b9479f52b">Vector2</a> v1, <a class="el" href="group__TorqueScriptTypes.html#ga9e94493e2a334dee294c516b9479f52b">Vector2</a> v2)</td></tr>
  50. <tr class="separator:ga6ecb30bbf007e18418773cb98c324303"><td class="memSeparator" colspan="2">&#160;</td></tr>
  51. <tr class="memitem:ga2f0bbc1896677584f4f26183a957ce33"><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__Vector2Math.html#ga2f0bbc1896677584f4f26183a957ce33">Vector2Add</a> (<a class="el" href="group__TorqueScriptTypes.html#ga9e94493e2a334dee294c516b9479f52b">Vector2</a> v1, <a class="el" href="group__TorqueScriptTypes.html#ga9e94493e2a334dee294c516b9479f52b">Vector2</a> v2)</td></tr>
  52. <tr class="separator:ga2f0bbc1896677584f4f26183a957ce33"><td class="memSeparator" colspan="2">&#160;</td></tr>
  53. <tr class="memitem:ga88da5f5c71ac32e6f507da999b3f90e8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Vector2Math.html#ga88da5f5c71ac32e6f507da999b3f90e8">Vector2AngleBetween</a> (<a class="el" href="group__TorqueScriptTypes.html#ga9e94493e2a334dee294c516b9479f52b">Vector2</a> v1, <a class="el" href="group__TorqueScriptTypes.html#ga9e94493e2a334dee294c516b9479f52b">Vector2</a> v2)</td></tr>
  54. <tr class="separator:ga88da5f5c71ac32e6f507da999b3f90e8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  55. <tr class="memitem:ga92f8c876613641944464f0ec5bdf2083"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Vector2Math.html#ga92f8c876613641944464f0ec5bdf2083">Vector2AngleToPoint</a> (<a class="el" href="group__TorqueScriptTypes.html#ga9e94493e2a334dee294c516b9479f52b">Vector2</a> p1, <a class="el" href="group__TorqueScriptTypes.html#ga9e94493e2a334dee294c516b9479f52b">Vector2</a> p1)</td></tr>
  56. <tr class="separator:ga92f8c876613641944464f0ec5bdf2083"><td class="memSeparator" colspan="2">&#160;</td></tr>
  57. <tr class="memitem:ga27b93cf688a4b8dd6a5456dcd4fc700f"><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__Vector2Math.html#ga27b93cf688a4b8dd6a5456dcd4fc700f">Vector2AreaNormalize</a> (<a class="el" href="group__TorqueScriptTypes.html#ga9e94493e2a334dee294c516b9479f52b">Vector2</a> v1, <a class="el" href="group__TorqueScriptTypes.html#ga9e94493e2a334dee294c516b9479f52b">Vector2</a> v2)</td></tr>
  58. <tr class="separator:ga27b93cf688a4b8dd6a5456dcd4fc700f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  59. <tr class="memitem:ga65e3d81431e4e59b3915d8915a61b7ac"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Vector2Math.html#ga65e3d81431e4e59b3915d8915a61b7ac">Vector2Compare</a> (<a class="el" href="group__TorqueScriptTypes.html#ga9e94493e2a334dee294c516b9479f52b">Vector2</a> p1, <a class="el" href="group__TorqueScriptTypes.html#ga9e94493e2a334dee294c516b9479f52b">Vector2</a> p2,[<a class="el" href="group__TorqueScriptTypes.html#ga9e94493e2a334dee294c516b9479f52b">Vector2</a> epsilon=0.0001]?)</td></tr>
  60. <tr class="separator:ga65e3d81431e4e59b3915d8915a61b7ac"><td class="memSeparator" colspan="2">&#160;</td></tr>
  61. <tr class="memitem:gab9990f0302735e67f005d981d794aa8c"><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__Vector2Math.html#gab9990f0302735e67f005d981d794aa8c">Vector2Direction</a> (F32 angle, F32 magnitude)</td></tr>
  62. <tr class="separator:gab9990f0302735e67f005d981d794aa8c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  63. <tr class="memitem:ga0f5078c1de0b26e8188ef94025ec12e2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Vector2Math.html#ga0f5078c1de0b26e8188ef94025ec12e2">Vector2Distance</a> (<a class="el" href="group__TorqueScriptTypes.html#ga9e94493e2a334dee294c516b9479f52b">Vector2</a> p1, <a class="el" href="group__TorqueScriptTypes.html#ga9e94493e2a334dee294c516b9479f52b">Vector2</a> p2)</td></tr>
  64. <tr class="separator:ga0f5078c1de0b26e8188ef94025ec12e2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  65. <tr class="memitem:gadab2b3ad1c05161add7da0f933d348ff"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Vector2Math.html#gadab2b3ad1c05161add7da0f933d348ff">Vector2Dot</a> (<a class="el" href="group__TorqueScriptTypes.html#ga9e94493e2a334dee294c516b9479f52b">Vector2</a> v1, <a class="el" href="group__TorqueScriptTypes.html#ga9e94493e2a334dee294c516b9479f52b">Vector2</a> v2)</td></tr>
  66. <tr class="separator:gadab2b3ad1c05161add7da0f933d348ff"><td class="memSeparator" colspan="2">&#160;</td></tr>
  67. <tr class="memitem:ga453ede6d126208a3d17362535ecb5fc5"><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__Vector2Math.html#ga453ede6d126208a3d17362535ecb5fc5">Vector2Inverse</a> (<a class="el" href="group__TorqueScriptTypes.html#ga9e94493e2a334dee294c516b9479f52b">Vector2</a> v1)</td></tr>
  68. <tr class="separator:ga453ede6d126208a3d17362535ecb5fc5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  69. <tr class="memitem:ga973666b5824d13483f36310dadf99bad"><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__Vector2Math.html#ga973666b5824d13483f36310dadf99bad">Vector2InverseX</a> (<a class="el" href="group__TorqueScriptTypes.html#ga9e94493e2a334dee294c516b9479f52b">Vector2</a> v1)</td></tr>
  70. <tr class="separator:ga973666b5824d13483f36310dadf99bad"><td class="memSeparator" colspan="2">&#160;</td></tr>
  71. <tr class="memitem:ga23fce69b73939342cb663727a8245a44"><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__Vector2Math.html#ga23fce69b73939342cb663727a8245a44">Vector2InverseY</a> (<a class="el" href="group__TorqueScriptTypes.html#ga9e94493e2a334dee294c516b9479f52b">Vector2</a> v1)</td></tr>
  72. <tr class="separator:ga23fce69b73939342cb663727a8245a44"><td class="memSeparator" colspan="2">&#160;</td></tr>
  73. <tr class="memitem:ga5847132aebd5f54c591c31a1b7f90eee"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Vector2Math.html#ga5847132aebd5f54c591c31a1b7f90eee">Vector2Length</a> (<a class="el" href="group__TorqueScriptTypes.html#ga9e94493e2a334dee294c516b9479f52b">Vector2</a> v1)</td></tr>
  74. <tr class="separator:ga5847132aebd5f54c591c31a1b7f90eee"><td class="memSeparator" colspan="2">&#160;</td></tr>
  75. <tr class="memitem:gaedf4bedf64959ce0f0b230040aa09cd4"><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__Vector2Math.html#gaedf4bedf64959ce0f0b230040aa09cd4">Vector2Mult</a> (<a class="el" href="group__TorqueScriptTypes.html#ga9e94493e2a334dee294c516b9479f52b">Vector2</a> v1, <a class="el" href="group__TorqueScriptTypes.html#ga9e94493e2a334dee294c516b9479f52b">Vector2</a> v2)</td></tr>
  76. <tr class="separator:gaedf4bedf64959ce0f0b230040aa09cd4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  77. <tr class="memitem:ga4b8887d71b6b95a9f635f8987cdb0952"><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__Vector2Math.html#ga4b8887d71b6b95a9f635f8987cdb0952">Vector2Normalize</a> (<a class="el" href="group__TorqueScriptTypes.html#ga9e94493e2a334dee294c516b9479f52b">Vector2</a> v1)</td></tr>
  78. <tr class="separator:ga4b8887d71b6b95a9f635f8987cdb0952"><td class="memSeparator" colspan="2">&#160;</td></tr>
  79. <tr class="memitem:gab185b60e3234931f9bf06bd59715a200"><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__Vector2Math.html#gab185b60e3234931f9bf06bd59715a200">Vector2Scale</a> (<a class="el" href="group__TorqueScriptTypes.html#ga9e94493e2a334dee294c516b9479f52b">Vector2</a> v1, scale)</td></tr>
  80. <tr class="separator:gab185b60e3234931f9bf06bd59715a200"><td class="memSeparator" colspan="2">&#160;</td></tr>
  81. <tr class="memitem:ga60e46b61bd6947f9c2d08c0430270bfe"><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__Vector2Math.html#ga60e46b61bd6947f9c2d08c0430270bfe">Vector2Sub</a> (<a class="el" href="group__TorqueScriptTypes.html#ga9e94493e2a334dee294c516b9479f52b">Vector2</a> v1, <a class="el" href="group__TorqueScriptTypes.html#ga9e94493e2a334dee294c516b9479f52b">Vector2</a> v2)</td></tr>
  82. <tr class="separator:ga60e46b61bd6947f9c2d08c0430270bfe"><td class="memSeparator" colspan="2">&#160;</td></tr>
  83. </table>
  84. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  85. <h2 class="groupheader">Function Documentation</h2>
  86. <a class="anchor" id="ga6ecb30bbf007e18418773cb98c324303"></a>
  87. <div class="memitem">
  88. <div class="memproto">
  89. <table class="memname">
  90. <tr>
  91. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> Vector2Abs </td>
  92. <td>(</td>
  93. <td class="paramtype"><a class="el" href="group__TorqueScriptTypes.html#ga9e94493e2a334dee294c516b9479f52b">Vector2</a>&#160;</td>
  94. <td class="paramname"><em>v1</em>, </td>
  95. </tr>
  96. <tr>
  97. <td class="paramkey"></td>
  98. <td></td>
  99. <td class="paramtype"><a class="el" href="group__TorqueScriptTypes.html#ga9e94493e2a334dee294c516b9479f52b">Vector2</a>&#160;</td>
  100. <td class="paramname"><em>v2</em>&#160;</td>
  101. </tr>
  102. <tr>
  103. <td></td>
  104. <td>)</td>
  105. <td></td><td></td>
  106. </tr>
  107. </table>
  108. </div><div class="memdoc">
  109. <p>Absolute difference of two 2-vectors </p>
  110. <dl class="section return"><dt>Returns</dt><dd>abs(v1-v2)</dd></dl>
  111. <dl class="section user"><dt>See Engine Function/Method</dt><dd>Vector2::absolute </dd></dl>
  112. </div>
  113. </div>
  114. <a class="anchor" id="ga2f0bbc1896677584f4f26183a957ce33"></a>
  115. <div class="memitem">
  116. <div class="memproto">
  117. <table class="memname">
  118. <tr>
  119. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> Vector2Add </td>
  120. <td>(</td>
  121. <td class="paramtype"><a class="el" href="group__TorqueScriptTypes.html#ga9e94493e2a334dee294c516b9479f52b">Vector2</a>&#160;</td>
  122. <td class="paramname"><em>v1</em>, </td>
  123. </tr>
  124. <tr>
  125. <td class="paramkey"></td>
  126. <td></td>
  127. <td class="paramtype"><a class="el" href="group__TorqueScriptTypes.html#ga9e94493e2a334dee294c516b9479f52b">Vector2</a>&#160;</td>
  128. <td class="paramname"><em>v2</em>&#160;</td>
  129. </tr>
  130. <tr>
  131. <td></td>
  132. <td>)</td>
  133. <td></td><td></td>
  134. </tr>
  135. </table>
  136. </div><div class="memdoc">
  137. <p>Add two 2-vectors. </p>
  138. <dl class="section return"><dt>Returns</dt><dd>v1+v2</dd></dl>
  139. <dl class="section user"><dt>See Engine Function/Method</dt><dd>Vector2::operator+ </dd></dl>
  140. </div>
  141. </div>
  142. <a class="anchor" id="ga88da5f5c71ac32e6f507da999b3f90e8"></a>
  143. <div class="memitem">
  144. <div class="memproto">
  145. <table class="memname">
  146. <tr>
  147. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> Vector2AngleBetween </td>
  148. <td>(</td>
  149. <td class="paramtype"><a class="el" href="group__TorqueScriptTypes.html#ga9e94493e2a334dee294c516b9479f52b">Vector2</a>&#160;</td>
  150. <td class="paramname"><em>v1</em>, </td>
  151. </tr>
  152. <tr>
  153. <td class="paramkey"></td>
  154. <td></td>
  155. <td class="paramtype"><a class="el" href="group__TorqueScriptTypes.html#ga9e94493e2a334dee294c516b9479f52b">Vector2</a>&#160;</td>
  156. <td class="paramname"><em>v2</em>&#160;</td>
  157. </tr>
  158. <tr>
  159. <td></td>
  160. <td>)</td>
  161. <td></td><td></td>
  162. </tr>
  163. </table>
  164. </div><div class="memdoc">
  165. <p>Angle between two 2D vectors. </p>
  166. <dl class="section return"><dt>Returns</dt><dd>the angle between v1 and v2. </dd></dl>
  167. </div>
  168. </div>
  169. <a class="anchor" id="ga92f8c876613641944464f0ec5bdf2083"></a>
  170. <div class="memitem">
  171. <div class="memproto">
  172. <table class="memname">
  173. <tr>
  174. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> Vector2AngleToPoint </td>
  175. <td>(</td>
  176. <td class="paramtype"><a class="el" href="group__TorqueScriptTypes.html#ga9e94493e2a334dee294c516b9479f52b">Vector2</a>&#160;</td>
  177. <td class="paramname"><em>p1</em>, </td>
  178. </tr>
  179. <tr>
  180. <td class="paramkey"></td>
  181. <td></td>
  182. <td class="paramtype"><a class="el" href="group__TorqueScriptTypes.html#ga9e94493e2a334dee294c516b9479f52b">Vector2</a>&#160;</td>
  183. <td class="paramname"><em>p1</em>&#160;</td>
  184. </tr>
  185. <tr>
  186. <td></td>
  187. <td>)</td>
  188. <td></td><td></td>
  189. </tr>
  190. </table>
  191. </div><div class="memdoc">
  192. <p>Angle from one point to another. </p>
  193. <dl class="section return"><dt>Returns</dt><dd>the angle from p1 to p2. </dd></dl>
  194. </div>
  195. </div>
  196. <a class="anchor" id="ga27b93cf688a4b8dd6a5456dcd4fc700f"></a>
  197. <div class="memitem">
  198. <div class="memproto">
  199. <table class="memname">
  200. <tr>
  201. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> Vector2AreaNormalize </td>
  202. <td>(</td>
  203. <td class="paramtype"><a class="el" href="group__TorqueScriptTypes.html#ga9e94493e2a334dee294c516b9479f52b">Vector2</a>&#160;</td>
  204. <td class="paramname"><em>v1</em>, </td>
  205. </tr>
  206. <tr>
  207. <td class="paramkey"></td>
  208. <td></td>
  209. <td class="paramtype"><a class="el" href="group__TorqueScriptTypes.html#ga9e94493e2a334dee294c516b9479f52b">Vector2</a>&#160;</td>
  210. <td class="paramname"><em>v2</em>&#160;</td>
  211. </tr>
  212. <tr>
  213. <td></td>
  214. <td>)</td>
  215. <td></td><td></td>
  216. </tr>
  217. </table>
  218. </div><div class="memdoc">
  219. <p>Normalize Rectangle (two 2D vectors) with relation to each other. </p>
  220. <dl class="section return"><dt>Returns</dt><dd>Normalize rectangle of v1 and v2. </dd></dl>
  221. </div>
  222. </div>
  223. <a class="anchor" id="ga65e3d81431e4e59b3915d8915a61b7ac"></a>
  224. <div class="memitem">
  225. <div class="memproto">
  226. <table class="memname">
  227. <tr>
  228. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> Vector2Compare </td>
  229. <td>(</td>
  230. <td class="paramtype"><a class="el" href="group__TorqueScriptTypes.html#ga9e94493e2a334dee294c516b9479f52b">Vector2</a>&#160;</td>
  231. <td class="paramname"><em>p1</em>, </td>
  232. </tr>
  233. <tr>
  234. <td class="paramkey"></td>
  235. <td></td>
  236. <td class="paramtype"><a class="el" href="group__TorqueScriptTypes.html#ga9e94493e2a334dee294c516b9479f52b">Vector2</a>&#160;</td>
  237. <td class="paramname"><em>p2</em>, </td>
  238. </tr>
  239. <tr>
  240. <td class="paramkey"></td>
  241. <td></td>
  242. <td class="paramtype">[Vector2 epsilon=0.0001] ?&#160;</td>
  243. <td class="paramname">&#160;</td>
  244. </tr>
  245. <tr>
  246. <td></td>
  247. <td>)</td>
  248. <td></td><td></td>
  249. </tr>
  250. </table>
  251. </div><div class="memdoc">
  252. <p>Equality of two 2D Points. Compares points p1 and p2 with optional difference (epsilon). </p>
  253. <dl class="section return"><dt>Returns</dt><dd>true if equal </dd></dl>
  254. </div>
  255. </div>
  256. <a class="anchor" id="gab9990f0302735e67f005d981d794aa8c"></a>
  257. <div class="memitem">
  258. <div class="memproto">
  259. <table class="memname">
  260. <tr>
  261. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> Vector2Direction </td>
  262. <td>(</td>
  263. <td class="paramtype">F32&#160;</td>
  264. <td class="paramname"><em>angle</em>, </td>
  265. </tr>
  266. <tr>
  267. <td class="paramkey"></td>
  268. <td></td>
  269. <td class="paramtype">F32&#160;</td>
  270. <td class="paramname"><em>magnitude</em>&#160;</td>
  271. </tr>
  272. <tr>
  273. <td></td>
  274. <td>)</td>
  275. <td></td><td></td>
  276. </tr>
  277. </table>
  278. </div><div class="memdoc">
  279. <p>vector from angle and magnitude. Calculates a direction from an angle and magnitude. </p>
  280. <dl class="params"><dt>Parameters</dt><dd>
  281. <table class="params">
  282. <tr><td class="paramname">angle</td><td>The angle of the direction. </td></tr>
  283. <tr><td class="paramname">magnitude</td><td>The magnitude of the direction. </td></tr>
  284. </table>
  285. </dd>
  286. </dl>
  287. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
  288. </div>
  289. </div>
  290. <a class="anchor" id="ga0f5078c1de0b26e8188ef94025ec12e2"></a>
  291. <div class="memitem">
  292. <div class="memproto">
  293. <table class="memname">
  294. <tr>
  295. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> Vector2Distance </td>
  296. <td>(</td>
  297. <td class="paramtype"><a class="el" href="group__TorqueScriptTypes.html#ga9e94493e2a334dee294c516b9479f52b">Vector2</a>&#160;</td>
  298. <td class="paramname"><em>p1</em>, </td>
  299. </tr>
  300. <tr>
  301. <td class="paramkey"></td>
  302. <td></td>
  303. <td class="paramtype"><a class="el" href="group__TorqueScriptTypes.html#ga9e94493e2a334dee294c516b9479f52b">Vector2</a>&#160;</td>
  304. <td class="paramname"><em>p2</em>&#160;</td>
  305. </tr>
  306. <tr>
  307. <td></td>
  308. <td>)</td>
  309. <td></td><td></td>
  310. </tr>
  311. </table>
  312. </div><div class="memdoc">
  313. <p>Distance between two 2D Points. </p>
  314. <dl class="section return"><dt>Returns</dt><dd>the distance between points p1 and p2 </dd></dl>
  315. </div>
  316. </div>
  317. <a class="anchor" id="gadab2b3ad1c05161add7da0f933d348ff"></a>
  318. <div class="memitem">
  319. <div class="memproto">
  320. <table class="memname">
  321. <tr>
  322. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> Vector2Dot </td>
  323. <td>(</td>
  324. <td class="paramtype"><a class="el" href="group__TorqueScriptTypes.html#ga9e94493e2a334dee294c516b9479f52b">Vector2</a>&#160;</td>
  325. <td class="paramname"><em>v1</em>, </td>
  326. </tr>
  327. <tr>
  328. <td class="paramkey"></td>
  329. <td></td>
  330. <td class="paramtype"><a class="el" href="group__TorqueScriptTypes.html#ga9e94493e2a334dee294c516b9479f52b">Vector2</a>&#160;</td>
  331. <td class="paramname"><em>v2</em>&#160;</td>
  332. </tr>
  333. <tr>
  334. <td></td>
  335. <td>)</td>
  336. <td></td><td></td>
  337. </tr>
  338. </table>
  339. </div><div class="memdoc">
  340. <p>Dot-Product of two 2D vectors. </p>
  341. <dl class="section return"><dt>Returns</dt><dd>dot-product of v1 and v2.</dd></dl>
  342. <dl class="section user"><dt>See Engine Function/Method</dt><dd>Vector2::dot </dd></dl>
  343. </div>
  344. </div>
  345. <a class="anchor" id="ga453ede6d126208a3d17362535ecb5fc5"></a>
  346. <div class="memitem">
  347. <div class="memproto">
  348. <table class="memname">
  349. <tr>
  350. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> Vector2Inverse </td>
  351. <td>(</td>
  352. <td class="paramtype"><a class="el" href="group__TorqueScriptTypes.html#ga9e94493e2a334dee294c516b9479f52b">Vector2</a>&#160;</td>
  353. <td class="paramname"><em>v1</em></td><td>)</td>
  354. <td></td>
  355. </tr>
  356. </table>
  357. </div><div class="memdoc">
  358. <p>Inverse of a 2D vector. </p>
  359. <dl class="section return"><dt>Returns</dt><dd>the inverse of v1.</dd></dl>
  360. <dl class="section user"><dt>See Engine Function/Method</dt><dd>Vector2::operator-() </dd></dl>
  361. </div>
  362. </div>
  363. <a class="anchor" id="ga973666b5824d13483f36310dadf99bad"></a>
  364. <div class="memitem">
  365. <div class="memproto">
  366. <table class="memname">
  367. <tr>
  368. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> Vector2InverseX </td>
  369. <td>(</td>
  370. <td class="paramtype"><a class="el" href="group__TorqueScriptTypes.html#ga9e94493e2a334dee294c516b9479f52b">Vector2</a>&#160;</td>
  371. <td class="paramname"><em>v1</em></td><td>)</td>
  372. <td></td>
  373. </tr>
  374. </table>
  375. </div><div class="memdoc">
  376. <p>Inverse X component of a 2D vector. </p>
  377. <dl class="section return"><dt>Returns</dt><dd>the inverse of the v1 X component. </dd></dl>
  378. </div>
  379. </div>
  380. <a class="anchor" id="ga23fce69b73939342cb663727a8245a44"></a>
  381. <div class="memitem">
  382. <div class="memproto">
  383. <table class="memname">
  384. <tr>
  385. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> Vector2InverseY </td>
  386. <td>(</td>
  387. <td class="paramtype"><a class="el" href="group__TorqueScriptTypes.html#ga9e94493e2a334dee294c516b9479f52b">Vector2</a>&#160;</td>
  388. <td class="paramname"><em>v1</em></td><td>)</td>
  389. <td></td>
  390. </tr>
  391. </table>
  392. </div><div class="memdoc">
  393. <p>Inverse Y component of a 2D vector. </p>
  394. <dl class="section return"><dt>Returns</dt><dd>the inverse of the v1 Y component. </dd></dl>
  395. </div>
  396. </div>
  397. <a class="anchor" id="ga5847132aebd5f54c591c31a1b7f90eee"></a>
  398. <div class="memitem">
  399. <div class="memproto">
  400. <table class="memname">
  401. <tr>
  402. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> Vector2Length </td>
  403. <td>(</td>
  404. <td class="paramtype"><a class="el" href="group__TorqueScriptTypes.html#ga9e94493e2a334dee294c516b9479f52b">Vector2</a>&#160;</td>
  405. <td class="paramname"><em>v1</em></td><td>)</td>
  406. <td></td>
  407. </tr>
  408. </table>
  409. </div><div class="memdoc">
  410. <p>Length of a 2D vector. </p>
  411. <dl class="section return"><dt>Returns</dt><dd>the length of v1.</dd></dl>
  412. <dl class="section user"><dt>See Engine Function/Method</dt><dd>Vector2::Length </dd></dl>
  413. </div>
  414. </div>
  415. <a class="anchor" id="gaedf4bedf64959ce0f0b230040aa09cd4"></a>
  416. <div class="memitem">
  417. <div class="memproto">
  418. <table class="memname">
  419. <tr>
  420. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> Vector2Mult </td>
  421. <td>(</td>
  422. <td class="paramtype"><a class="el" href="group__TorqueScriptTypes.html#ga9e94493e2a334dee294c516b9479f52b">Vector2</a>&#160;</td>
  423. <td class="paramname"><em>v1</em>, </td>
  424. </tr>
  425. <tr>
  426. <td class="paramkey"></td>
  427. <td></td>
  428. <td class="paramtype"><a class="el" href="group__TorqueScriptTypes.html#ga9e94493e2a334dee294c516b9479f52b">Vector2</a>&#160;</td>
  429. <td class="paramname"><em>v2</em>&#160;</td>
  430. </tr>
  431. <tr>
  432. <td></td>
  433. <td>)</td>
  434. <td></td><td></td>
  435. </tr>
  436. </table>
  437. </div><div class="memdoc">
  438. <p>Multiply two 2D vectors (Not Dot-Product!) </p>
  439. <dl class="section return"><dt>Returns</dt><dd>v1 mult v2. </dd></dl>
  440. </div>
  441. </div>
  442. <a class="anchor" id="ga4b8887d71b6b95a9f635f8987cdb0952"></a>
  443. <div class="memitem">
  444. <div class="memproto">
  445. <table class="memname">
  446. <tr>
  447. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> Vector2Normalize </td>
  448. <td>(</td>
  449. <td class="paramtype"><a class="el" href="group__TorqueScriptTypes.html#ga9e94493e2a334dee294c516b9479f52b">Vector2</a>&#160;</td>
  450. <td class="paramname"><em>v1</em></td><td>)</td>
  451. <td></td>
  452. </tr>
  453. </table>
  454. </div><div class="memdoc">
  455. <p>Normalize a 2D vector. </p>
  456. <dl class="section return"><dt>Returns</dt><dd>Normalized v1.</dd></dl>
  457. <dl class="section user"><dt>See Engine Function/Method</dt><dd>Vector2::Normalize </dd></dl>
  458. </div>
  459. </div>
  460. <a class="anchor" id="gab185b60e3234931f9bf06bd59715a200"></a>
  461. <div class="memitem">
  462. <div class="memproto">
  463. <table class="memname">
  464. <tr>
  465. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> Vector2Scale </td>
  466. <td>(</td>
  467. <td class="paramtype"><a class="el" href="group__TorqueScriptTypes.html#ga9e94493e2a334dee294c516b9479f52b">Vector2</a>&#160;</td>
  468. <td class="paramname"><em>v1</em>, </td>
  469. </tr>
  470. <tr>
  471. <td class="paramkey"></td>
  472. <td></td>
  473. <td class="paramtype">scale&#160;</td>
  474. <td class="paramname">&#160;</td>
  475. </tr>
  476. <tr>
  477. <td></td>
  478. <td>)</td>
  479. <td></td><td></td>
  480. </tr>
  481. </table>
  482. </div><div class="memdoc">
  483. <p>Scale a 2D vector. </p>
  484. <dl class="section return"><dt>Returns</dt><dd>v1 scaled by scale.</dd></dl>
  485. <dl class="section user"><dt>See Engine Function/Method</dt><dd>Vector2::operator* </dd></dl>
  486. </div>
  487. </div>
  488. <a class="anchor" id="ga60e46b61bd6947f9c2d08c0430270bfe"></a>
  489. <div class="memitem">
  490. <div class="memproto">
  491. <table class="memname">
  492. <tr>
  493. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> Vector2Sub </td>
  494. <td>(</td>
  495. <td class="paramtype"><a class="el" href="group__TorqueScriptTypes.html#ga9e94493e2a334dee294c516b9479f52b">Vector2</a>&#160;</td>
  496. <td class="paramname"><em>v1</em>, </td>
  497. </tr>
  498. <tr>
  499. <td class="paramkey"></td>
  500. <td></td>
  501. <td class="paramtype"><a class="el" href="group__TorqueScriptTypes.html#ga9e94493e2a334dee294c516b9479f52b">Vector2</a>&#160;</td>
  502. <td class="paramname"><em>v2</em>&#160;</td>
  503. </tr>
  504. <tr>
  505. <td></td>
  506. <td>)</td>
  507. <td></td><td></td>
  508. </tr>
  509. </table>
  510. </div><div class="memdoc">
  511. <p>Subtract two 2D vectors. </p>
  512. <dl class="section return"><dt>Returns</dt><dd>v1-v2</dd></dl>
  513. <dl class="section user"><dt>See Engine Function/Method</dt><dd>Vector2::operator-(Vector2) </dd></dl>
  514. </div>
  515. </div>
  516. </div><!-- contents -->
  517. <!-- start footer part -->
  518. <hr class="footer"/><address class="footer"><small>
  519. Generated by &#160;<a href="http://www.doxygen.org/index.html">
  520. <img class="footer" src="doxygen.png" alt="doxygen"/>
  521. </a> 1.8.3.1
  522. </small></address>
  523. </body>
  524. </html>