group__Vector2Math.html 29 KB

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