group__Vector2Math.html 34 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=11"/>
  6. <meta name="generator" content="Doxygen 1.9.8"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>TorqueScript Reference: Vector2 Math</title>
  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  13. <link href="t2d-stylesheet-extra.css" rel="stylesheet" type="text/css"/>
  14. </head>
  15. <body>
  16. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  17. <div id="titlearea">
  18. <table cellspacing="0" cellpadding="0">
  19. <tbody>
  20. <tr id="projectrow">
  21. <td id="projectalign">
  22. <div id="projectname">TorqueScript Reference
  23. </div>
  24. </td>
  25. </tr>
  26. </tbody>
  27. </table>
  28. </div>
  29. <!-- end header part -->
  30. <!-- Generated by Doxygen 1.9.8 -->
  31. <script type="text/javascript" src="menudata.js"></script>
  32. <script type="text/javascript" src="menu.js"></script>
  33. <script type="text/javascript">
  34. /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  35. $(function() {
  36. initMenu('',false,false,'search.php','Search');
  37. });
  38. /* @license-end */
  39. </script>
  40. <div id="main-nav"></div>
  41. </div><!-- top -->
  42. <div class="header">
  43. <div class="summary">
  44. <a href="#func-members">Functions</a> </div>
  45. <div class="headertitle"><div class="title">Vector2 Math<div class="ingroups"><a class="el" href="group__TorqueScriptFunctions.html">Function Categories</a></div></div></div>
  46. </div><!--header-->
  47. <div class="contents">
  48. <table class="memberdecls">
  49. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
  50. Functions</h2></td></tr>
  51. <tr class="memitem:ga6ecb30bbf007e18418773cb98c324303" id="r_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>
  52. <tr class="separator:ga6ecb30bbf007e18418773cb98c324303"><td class="memSeparator" colspan="2">&#160;</td></tr>
  53. <tr class="memitem:ga2f0bbc1896677584f4f26183a957ce33" id="r_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>
  54. <tr class="separator:ga2f0bbc1896677584f4f26183a957ce33"><td class="memSeparator" colspan="2">&#160;</td></tr>
  55. <tr class="memitem:ga88da5f5c71ac32e6f507da999b3f90e8" id="r_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>
  56. <tr class="separator:ga88da5f5c71ac32e6f507da999b3f90e8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  57. <tr class="memitem:gae0a4dc209ed4d562c02e4237e718c998" id="r_gae0a4dc209ed4d562c02e4237e718c998"><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#gae0a4dc209ed4d562c02e4237e718c998">Vector2AngleToPoint</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>
  58. <tr class="separator:gae0a4dc209ed4d562c02e4237e718c998"><td class="memSeparator" colspan="2">&#160;</td></tr>
  59. <tr class="memitem:ga27b93cf688a4b8dd6a5456dcd4fc700f" id="r_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>
  60. <tr class="separator:ga27b93cf688a4b8dd6a5456dcd4fc700f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  61. <tr class="memitem:ga30301fc4bab47cf920382bac80090182" id="r_ga30301fc4bab47cf920382bac80090182"><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#ga30301fc4bab47cf920382bac80090182">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>
  62. <tr class="separator:ga30301fc4bab47cf920382bac80090182"><td class="memSeparator" colspan="2">&#160;</td></tr>
  63. <tr class="memitem:gab9990f0302735e67f005d981d794aa8c" id="r_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>
  64. <tr class="separator:gab9990f0302735e67f005d981d794aa8c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  65. <tr class="memitem:ga0f5078c1de0b26e8188ef94025ec12e2" id="r_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>
  66. <tr class="separator:ga0f5078c1de0b26e8188ef94025ec12e2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  67. <tr class="memitem:gadab2b3ad1c05161add7da0f933d348ff" id="r_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>
  68. <tr class="separator:gadab2b3ad1c05161add7da0f933d348ff"><td class="memSeparator" colspan="2">&#160;</td></tr>
  69. <tr class="memitem:ga453ede6d126208a3d17362535ecb5fc5" id="r_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>
  70. <tr class="separator:ga453ede6d126208a3d17362535ecb5fc5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  71. <tr class="memitem:ga973666b5824d13483f36310dadf99bad" id="r_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>
  72. <tr class="separator:ga973666b5824d13483f36310dadf99bad"><td class="memSeparator" colspan="2">&#160;</td></tr>
  73. <tr class="memitem:ga23fce69b73939342cb663727a8245a44" id="r_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>
  74. <tr class="separator:ga23fce69b73939342cb663727a8245a44"><td class="memSeparator" colspan="2">&#160;</td></tr>
  75. <tr class="memitem:ga5847132aebd5f54c591c31a1b7f90eee" id="r_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>
  76. <tr class="separator:ga5847132aebd5f54c591c31a1b7f90eee"><td class="memSeparator" colspan="2">&#160;</td></tr>
  77. <tr class="memitem:gaedf4bedf64959ce0f0b230040aa09cd4" id="r_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>
  78. <tr class="separator:gaedf4bedf64959ce0f0b230040aa09cd4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  79. <tr class="memitem:ga4b8887d71b6b95a9f635f8987cdb0952" id="r_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>
  80. <tr class="separator:ga4b8887d71b6b95a9f635f8987cdb0952"><td class="memSeparator" colspan="2">&#160;</td></tr>
  81. <tr class="memitem:gab185b60e3234931f9bf06bd59715a200" id="r_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>
  82. <tr class="separator:gab185b60e3234931f9bf06bd59715a200"><td class="memSeparator" colspan="2">&#160;</td></tr>
  83. <tr class="memitem:ga60e46b61bd6947f9c2d08c0430270bfe" id="r_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>
  84. <tr class="separator:ga60e46b61bd6947f9c2d08c0430270bfe"><td class="memSeparator" colspan="2">&#160;</td></tr>
  85. </table>
  86. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  87. <h2 class="groupheader">Function Documentation</h2>
  88. <a id="ga6ecb30bbf007e18418773cb98c324303" name="ga6ecb30bbf007e18418773cb98c324303"></a>
  89. <h2 class="memtitle"><span class="permalink"><a href="#ga6ecb30bbf007e18418773cb98c324303">&#9670;&#160;</a></span>Vector2Abs()</h2>
  90. <div class="memitem">
  91. <div class="memproto">
  92. <table class="memname">
  93. <tr>
  94. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> Vector2Abs </td>
  95. <td>(</td>
  96. <td class="paramtype"><a class="el" href="group__TorqueScriptTypes.html#ga9e94493e2a334dee294c516b9479f52b">Vector2</a>&#160;</td>
  97. <td class="paramname"><em>v1</em>, </td>
  98. </tr>
  99. <tr>
  100. <td class="paramkey"></td>
  101. <td></td>
  102. <td class="paramtype"><a class="el" href="group__TorqueScriptTypes.html#ga9e94493e2a334dee294c516b9479f52b">Vector2</a>&#160;</td>
  103. <td class="paramname"><em>v2</em>&#160;</td>
  104. </tr>
  105. <tr>
  106. <td></td>
  107. <td>)</td>
  108. <td></td><td></td>
  109. </tr>
  110. </table>
  111. </div><div class="memdoc">
  112. <p>Absolute difference of two 2-vectors </p><dl class="section return"><dt>Returns</dt><dd>abs(v1-v2)</dd></dl>
  113. <dl class="section user"><dt>See Engine Function/Method</dt><dd>Vector2::absolute </dd></dl>
  114. </div>
  115. </div>
  116. <a id="ga2f0bbc1896677584f4f26183a957ce33" name="ga2f0bbc1896677584f4f26183a957ce33"></a>
  117. <h2 class="memtitle"><span class="permalink"><a href="#ga2f0bbc1896677584f4f26183a957ce33">&#9670;&#160;</a></span>Vector2Add()</h2>
  118. <div class="memitem">
  119. <div class="memproto">
  120. <table class="memname">
  121. <tr>
  122. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> Vector2Add </td>
  123. <td>(</td>
  124. <td class="paramtype"><a class="el" href="group__TorqueScriptTypes.html#ga9e94493e2a334dee294c516b9479f52b">Vector2</a>&#160;</td>
  125. <td class="paramname"><em>v1</em>, </td>
  126. </tr>
  127. <tr>
  128. <td class="paramkey"></td>
  129. <td></td>
  130. <td class="paramtype"><a class="el" href="group__TorqueScriptTypes.html#ga9e94493e2a334dee294c516b9479f52b">Vector2</a>&#160;</td>
  131. <td class="paramname"><em>v2</em>&#160;</td>
  132. </tr>
  133. <tr>
  134. <td></td>
  135. <td>)</td>
  136. <td></td><td></td>
  137. </tr>
  138. </table>
  139. </div><div class="memdoc">
  140. <p>Add two 2-vectors. </p><dl class="section return"><dt>Returns</dt><dd>v1+v2</dd></dl>
  141. <dl class="section user"><dt>See Engine Function/Method</dt><dd>Vector2::operator+ </dd></dl>
  142. </div>
  143. </div>
  144. <a id="ga88da5f5c71ac32e6f507da999b3f90e8" name="ga88da5f5c71ac32e6f507da999b3f90e8"></a>
  145. <h2 class="memtitle"><span class="permalink"><a href="#ga88da5f5c71ac32e6f507da999b3f90e8">&#9670;&#160;</a></span>Vector2AngleBetween()</h2>
  146. <div class="memitem">
  147. <div class="memproto">
  148. <table class="memname">
  149. <tr>
  150. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> Vector2AngleBetween </td>
  151. <td>(</td>
  152. <td class="paramtype"><a class="el" href="group__TorqueScriptTypes.html#ga9e94493e2a334dee294c516b9479f52b">Vector2</a>&#160;</td>
  153. <td class="paramname"><em>v1</em>, </td>
  154. </tr>
  155. <tr>
  156. <td class="paramkey"></td>
  157. <td></td>
  158. <td class="paramtype"><a class="el" href="group__TorqueScriptTypes.html#ga9e94493e2a334dee294c516b9479f52b">Vector2</a>&#160;</td>
  159. <td class="paramname"><em>v2</em>&#160;</td>
  160. </tr>
  161. <tr>
  162. <td></td>
  163. <td>)</td>
  164. <td></td><td></td>
  165. </tr>
  166. </table>
  167. </div><div class="memdoc">
  168. <p>Angle between two 2D vectors. </p><dl class="section return"><dt>Returns</dt><dd>the angle between v1 and v2. </dd></dl>
  169. </div>
  170. </div>
  171. <a id="gae0a4dc209ed4d562c02e4237e718c998" name="gae0a4dc209ed4d562c02e4237e718c998"></a>
  172. <h2 class="memtitle"><span class="permalink"><a href="#gae0a4dc209ed4d562c02e4237e718c998">&#9670;&#160;</a></span>Vector2AngleToPoint()</h2>
  173. <div class="memitem">
  174. <div class="memproto">
  175. <table class="memname">
  176. <tr>
  177. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> Vector2AngleToPoint </td>
  178. <td>(</td>
  179. <td class="paramtype"><a class="el" href="group__TorqueScriptTypes.html#ga9e94493e2a334dee294c516b9479f52b">Vector2</a>&#160;</td>
  180. <td class="paramname"><em>p1</em>, </td>
  181. </tr>
  182. <tr>
  183. <td class="paramkey"></td>
  184. <td></td>
  185. <td class="paramtype"><a class="el" href="group__TorqueScriptTypes.html#ga9e94493e2a334dee294c516b9479f52b">Vector2</a>&#160;</td>
  186. <td class="paramname"><em>p2</em>&#160;</td>
  187. </tr>
  188. <tr>
  189. <td></td>
  190. <td>)</td>
  191. <td></td><td></td>
  192. </tr>
  193. </table>
  194. </div><div class="memdoc">
  195. <p>Angle from one point to another. </p><dl class="section return"><dt>Returns</dt><dd>the angle from p1 to p2. </dd></dl>
  196. </div>
  197. </div>
  198. <a id="ga27b93cf688a4b8dd6a5456dcd4fc700f" name="ga27b93cf688a4b8dd6a5456dcd4fc700f"></a>
  199. <h2 class="memtitle"><span class="permalink"><a href="#ga27b93cf688a4b8dd6a5456dcd4fc700f">&#9670;&#160;</a></span>Vector2AreaNormalize()</h2>
  200. <div class="memitem">
  201. <div class="memproto">
  202. <table class="memname">
  203. <tr>
  204. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> Vector2AreaNormalize </td>
  205. <td>(</td>
  206. <td class="paramtype"><a class="el" href="group__TorqueScriptTypes.html#ga9e94493e2a334dee294c516b9479f52b">Vector2</a>&#160;</td>
  207. <td class="paramname"><em>v1</em>, </td>
  208. </tr>
  209. <tr>
  210. <td class="paramkey"></td>
  211. <td></td>
  212. <td class="paramtype"><a class="el" href="group__TorqueScriptTypes.html#ga9e94493e2a334dee294c516b9479f52b">Vector2</a>&#160;</td>
  213. <td class="paramname"><em>v2</em>&#160;</td>
  214. </tr>
  215. <tr>
  216. <td></td>
  217. <td>)</td>
  218. <td></td><td></td>
  219. </tr>
  220. </table>
  221. </div><div class="memdoc">
  222. <p>Normalize Rectangle (two 2D vectors) with relation to each other. </p><dl class="section return"><dt>Returns</dt><dd>Normalize rectangle of v1 and v2. </dd></dl>
  223. </div>
  224. </div>
  225. <a id="ga30301fc4bab47cf920382bac80090182" name="ga30301fc4bab47cf920382bac80090182"></a>
  226. <h2 class="memtitle"><span class="permalink"><a href="#ga30301fc4bab47cf920382bac80090182">&#9670;&#160;</a></span>Vector2Compare()</h2>
  227. <div class="memitem">
  228. <div class="memproto">
  229. <table class="memname">
  230. <tr>
  231. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> Vector2Compare </td>
  232. <td>(</td>
  233. <td class="paramtype"><a class="el" href="group__TorqueScriptTypes.html#ga9e94493e2a334dee294c516b9479f52b">Vector2</a>&#160;</td>
  234. <td class="paramname"><em>p1</em>, </td>
  235. </tr>
  236. <tr>
  237. <td class="paramkey"></td>
  238. <td></td>
  239. <td class="paramtype"><a class="el" href="group__TorqueScriptTypes.html#ga9e94493e2a334dee294c516b9479f52b">Vector2</a>&#160;</td>
  240. <td class="paramname"><em>p2</em>, </td>
  241. </tr>
  242. <tr>
  243. <td class="paramkey"></td>
  244. <td></td>
  245. <td class="paramtype">[Vector2 epsilon=0.0001] ?&#160;</td>
  246. <td class="paramname">&#160;</td>
  247. </tr>
  248. <tr>
  249. <td></td>
  250. <td>)</td>
  251. <td></td><td></td>
  252. </tr>
  253. </table>
  254. </div><div class="memdoc">
  255. <p>Equality of two 2D Points. Compares points p1 and p2 with optional difference (epsilon). </p><dl class="section return"><dt>Returns</dt><dd>true if equal </dd></dl>
  256. </div>
  257. </div>
  258. <a id="gab9990f0302735e67f005d981d794aa8c" name="gab9990f0302735e67f005d981d794aa8c"></a>
  259. <h2 class="memtitle"><span class="permalink"><a href="#gab9990f0302735e67f005d981d794aa8c">&#9670;&#160;</a></span>Vector2Direction()</h2>
  260. <div class="memitem">
  261. <div class="memproto">
  262. <table class="memname">
  263. <tr>
  264. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> Vector2Direction </td>
  265. <td>(</td>
  266. <td class="paramtype">F32&#160;</td>
  267. <td class="paramname"><em>angle</em>, </td>
  268. </tr>
  269. <tr>
  270. <td class="paramkey"></td>
  271. <td></td>
  272. <td class="paramtype">F32&#160;</td>
  273. <td class="paramname"><em>magnitude</em>&#160;</td>
  274. </tr>
  275. <tr>
  276. <td></td>
  277. <td>)</td>
  278. <td></td><td></td>
  279. </tr>
  280. </table>
  281. </div><div class="memdoc">
  282. <p>vector from angle and magnitude. Calculates a direction from an angle and magnitude. </p><dl class="params"><dt>Parameters</dt><dd>
  283. <table class="params">
  284. <tr><td class="paramname">angle</td><td>The angle of the direction. </td></tr>
  285. <tr><td class="paramname">magnitude</td><td>The magnitude of the direction. </td></tr>
  286. </table>
  287. </dd>
  288. </dl>
  289. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
  290. </div>
  291. </div>
  292. <a id="ga0f5078c1de0b26e8188ef94025ec12e2" name="ga0f5078c1de0b26e8188ef94025ec12e2"></a>
  293. <h2 class="memtitle"><span class="permalink"><a href="#ga0f5078c1de0b26e8188ef94025ec12e2">&#9670;&#160;</a></span>Vector2Distance()</h2>
  294. <div class="memitem">
  295. <div class="memproto">
  296. <table class="memname">
  297. <tr>
  298. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> Vector2Distance </td>
  299. <td>(</td>
  300. <td class="paramtype"><a class="el" href="group__TorqueScriptTypes.html#ga9e94493e2a334dee294c516b9479f52b">Vector2</a>&#160;</td>
  301. <td class="paramname"><em>p1</em>, </td>
  302. </tr>
  303. <tr>
  304. <td class="paramkey"></td>
  305. <td></td>
  306. <td class="paramtype"><a class="el" href="group__TorqueScriptTypes.html#ga9e94493e2a334dee294c516b9479f52b">Vector2</a>&#160;</td>
  307. <td class="paramname"><em>p2</em>&#160;</td>
  308. </tr>
  309. <tr>
  310. <td></td>
  311. <td>)</td>
  312. <td></td><td></td>
  313. </tr>
  314. </table>
  315. </div><div class="memdoc">
  316. <p>Distance between two 2D Points. </p><dl class="section return"><dt>Returns</dt><dd>the distance between points p1 and p2 </dd></dl>
  317. </div>
  318. </div>
  319. <a id="gadab2b3ad1c05161add7da0f933d348ff" name="gadab2b3ad1c05161add7da0f933d348ff"></a>
  320. <h2 class="memtitle"><span class="permalink"><a href="#gadab2b3ad1c05161add7da0f933d348ff">&#9670;&#160;</a></span>Vector2Dot()</h2>
  321. <div class="memitem">
  322. <div class="memproto">
  323. <table class="memname">
  324. <tr>
  325. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> Vector2Dot </td>
  326. <td>(</td>
  327. <td class="paramtype"><a class="el" href="group__TorqueScriptTypes.html#ga9e94493e2a334dee294c516b9479f52b">Vector2</a>&#160;</td>
  328. <td class="paramname"><em>v1</em>, </td>
  329. </tr>
  330. <tr>
  331. <td class="paramkey"></td>
  332. <td></td>
  333. <td class="paramtype"><a class="el" href="group__TorqueScriptTypes.html#ga9e94493e2a334dee294c516b9479f52b">Vector2</a>&#160;</td>
  334. <td class="paramname"><em>v2</em>&#160;</td>
  335. </tr>
  336. <tr>
  337. <td></td>
  338. <td>)</td>
  339. <td></td><td></td>
  340. </tr>
  341. </table>
  342. </div><div class="memdoc">
  343. <p>Dot-Product of two 2D vectors. </p><dl class="section return"><dt>Returns</dt><dd>dot-product of v1 and v2.</dd></dl>
  344. <dl class="section user"><dt>See Engine Function/Method</dt><dd>Vector2::dot </dd></dl>
  345. </div>
  346. </div>
  347. <a id="ga453ede6d126208a3d17362535ecb5fc5" name="ga453ede6d126208a3d17362535ecb5fc5"></a>
  348. <h2 class="memtitle"><span class="permalink"><a href="#ga453ede6d126208a3d17362535ecb5fc5">&#9670;&#160;</a></span>Vector2Inverse()</h2>
  349. <div class="memitem">
  350. <div class="memproto">
  351. <table class="memname">
  352. <tr>
  353. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> Vector2Inverse </td>
  354. <td>(</td>
  355. <td class="paramtype"><a class="el" href="group__TorqueScriptTypes.html#ga9e94493e2a334dee294c516b9479f52b">Vector2</a>&#160;</td>
  356. <td class="paramname"><em>v1</em></td><td>)</td>
  357. <td></td>
  358. </tr>
  359. </table>
  360. </div><div class="memdoc">
  361. <p>Inverse of a 2D vector. </p><dl class="section return"><dt>Returns</dt><dd>the inverse of v1.</dd></dl>
  362. <dl class="section user"><dt>See Engine Function/Method</dt><dd>Vector2::operator-() </dd></dl>
  363. </div>
  364. </div>
  365. <a id="ga973666b5824d13483f36310dadf99bad" name="ga973666b5824d13483f36310dadf99bad"></a>
  366. <h2 class="memtitle"><span class="permalink"><a href="#ga973666b5824d13483f36310dadf99bad">&#9670;&#160;</a></span>Vector2InverseX()</h2>
  367. <div class="memitem">
  368. <div class="memproto">
  369. <table class="memname">
  370. <tr>
  371. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> Vector2InverseX </td>
  372. <td>(</td>
  373. <td class="paramtype"><a class="el" href="group__TorqueScriptTypes.html#ga9e94493e2a334dee294c516b9479f52b">Vector2</a>&#160;</td>
  374. <td class="paramname"><em>v1</em></td><td>)</td>
  375. <td></td>
  376. </tr>
  377. </table>
  378. </div><div class="memdoc">
  379. <p>Inverse X component of a 2D vector. </p><dl class="section return"><dt>Returns</dt><dd>the inverse of the v1 X component. </dd></dl>
  380. </div>
  381. </div>
  382. <a id="ga23fce69b73939342cb663727a8245a44" name="ga23fce69b73939342cb663727a8245a44"></a>
  383. <h2 class="memtitle"><span class="permalink"><a href="#ga23fce69b73939342cb663727a8245a44">&#9670;&#160;</a></span>Vector2InverseY()</h2>
  384. <div class="memitem">
  385. <div class="memproto">
  386. <table class="memname">
  387. <tr>
  388. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> Vector2InverseY </td>
  389. <td>(</td>
  390. <td class="paramtype"><a class="el" href="group__TorqueScriptTypes.html#ga9e94493e2a334dee294c516b9479f52b">Vector2</a>&#160;</td>
  391. <td class="paramname"><em>v1</em></td><td>)</td>
  392. <td></td>
  393. </tr>
  394. </table>
  395. </div><div class="memdoc">
  396. <p>Inverse Y component of a 2D vector. </p><dl class="section return"><dt>Returns</dt><dd>the inverse of the v1 Y component. </dd></dl>
  397. </div>
  398. </div>
  399. <a id="ga5847132aebd5f54c591c31a1b7f90eee" name="ga5847132aebd5f54c591c31a1b7f90eee"></a>
  400. <h2 class="memtitle"><span class="permalink"><a href="#ga5847132aebd5f54c591c31a1b7f90eee">&#9670;&#160;</a></span>Vector2Length()</h2>
  401. <div class="memitem">
  402. <div class="memproto">
  403. <table class="memname">
  404. <tr>
  405. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> Vector2Length </td>
  406. <td>(</td>
  407. <td class="paramtype"><a class="el" href="group__TorqueScriptTypes.html#ga9e94493e2a334dee294c516b9479f52b">Vector2</a>&#160;</td>
  408. <td class="paramname"><em>v1</em></td><td>)</td>
  409. <td></td>
  410. </tr>
  411. </table>
  412. </div><div class="memdoc">
  413. <p>Length of a 2D vector. </p><dl class="section return"><dt>Returns</dt><dd>the length of v1.</dd></dl>
  414. <dl class="section user"><dt>See Engine Function/Method</dt><dd>Vector2::Length </dd></dl>
  415. </div>
  416. </div>
  417. <a id="gaedf4bedf64959ce0f0b230040aa09cd4" name="gaedf4bedf64959ce0f0b230040aa09cd4"></a>
  418. <h2 class="memtitle"><span class="permalink"><a href="#gaedf4bedf64959ce0f0b230040aa09cd4">&#9670;&#160;</a></span>Vector2Mult()</h2>
  419. <div class="memitem">
  420. <div class="memproto">
  421. <table class="memname">
  422. <tr>
  423. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> Vector2Mult </td>
  424. <td>(</td>
  425. <td class="paramtype"><a class="el" href="group__TorqueScriptTypes.html#ga9e94493e2a334dee294c516b9479f52b">Vector2</a>&#160;</td>
  426. <td class="paramname"><em>v1</em>, </td>
  427. </tr>
  428. <tr>
  429. <td class="paramkey"></td>
  430. <td></td>
  431. <td class="paramtype"><a class="el" href="group__TorqueScriptTypes.html#ga9e94493e2a334dee294c516b9479f52b">Vector2</a>&#160;</td>
  432. <td class="paramname"><em>v2</em>&#160;</td>
  433. </tr>
  434. <tr>
  435. <td></td>
  436. <td>)</td>
  437. <td></td><td></td>
  438. </tr>
  439. </table>
  440. </div><div class="memdoc">
  441. <p>Multiply two 2D vectors (Not Dot-Product!) </p><dl class="section return"><dt>Returns</dt><dd>v1 mult v2. </dd></dl>
  442. </div>
  443. </div>
  444. <a id="ga4b8887d71b6b95a9f635f8987cdb0952" name="ga4b8887d71b6b95a9f635f8987cdb0952"></a>
  445. <h2 class="memtitle"><span class="permalink"><a href="#ga4b8887d71b6b95a9f635f8987cdb0952">&#9670;&#160;</a></span>Vector2Normalize()</h2>
  446. <div class="memitem">
  447. <div class="memproto">
  448. <table class="memname">
  449. <tr>
  450. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> Vector2Normalize </td>
  451. <td>(</td>
  452. <td class="paramtype"><a class="el" href="group__TorqueScriptTypes.html#ga9e94493e2a334dee294c516b9479f52b">Vector2</a>&#160;</td>
  453. <td class="paramname"><em>v1</em></td><td>)</td>
  454. <td></td>
  455. </tr>
  456. </table>
  457. </div><div class="memdoc">
  458. <p>Normalize a 2D vector. </p><dl class="section return"><dt>Returns</dt><dd>Normalized v1.</dd></dl>
  459. <dl class="section user"><dt>See Engine Function/Method</dt><dd>Vector2::Normalize </dd></dl>
  460. </div>
  461. </div>
  462. <a id="gab185b60e3234931f9bf06bd59715a200" name="gab185b60e3234931f9bf06bd59715a200"></a>
  463. <h2 class="memtitle"><span class="permalink"><a href="#gab185b60e3234931f9bf06bd59715a200">&#9670;&#160;</a></span>Vector2Scale()</h2>
  464. <div class="memitem">
  465. <div class="memproto">
  466. <table class="memname">
  467. <tr>
  468. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> Vector2Scale </td>
  469. <td>(</td>
  470. <td class="paramtype"><a class="el" href="group__TorqueScriptTypes.html#ga9e94493e2a334dee294c516b9479f52b">Vector2</a>&#160;</td>
  471. <td class="paramname"><em>v1</em>, </td>
  472. </tr>
  473. <tr>
  474. <td class="paramkey"></td>
  475. <td></td>
  476. <td class="paramtype">scale&#160;</td>
  477. <td class="paramname">&#160;</td>
  478. </tr>
  479. <tr>
  480. <td></td>
  481. <td>)</td>
  482. <td></td><td></td>
  483. </tr>
  484. </table>
  485. </div><div class="memdoc">
  486. <p>Scale a 2D vector. </p><dl class="section return"><dt>Returns</dt><dd>v1 scaled by scale.</dd></dl>
  487. <dl class="section user"><dt>See Engine Function/Method</dt><dd>Vector2::operator* </dd></dl>
  488. </div>
  489. </div>
  490. <a id="ga60e46b61bd6947f9c2d08c0430270bfe" name="ga60e46b61bd6947f9c2d08c0430270bfe"></a>
  491. <h2 class="memtitle"><span class="permalink"><a href="#ga60e46b61bd6947f9c2d08c0430270bfe">&#9670;&#160;</a></span>Vector2Sub()</h2>
  492. <div class="memitem">
  493. <div class="memproto">
  494. <table class="memname">
  495. <tr>
  496. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> Vector2Sub </td>
  497. <td>(</td>
  498. <td class="paramtype"><a class="el" href="group__TorqueScriptTypes.html#ga9e94493e2a334dee294c516b9479f52b">Vector2</a>&#160;</td>
  499. <td class="paramname"><em>v1</em>, </td>
  500. </tr>
  501. <tr>
  502. <td class="paramkey"></td>
  503. <td></td>
  504. <td class="paramtype"><a class="el" href="group__TorqueScriptTypes.html#ga9e94493e2a334dee294c516b9479f52b">Vector2</a>&#160;</td>
  505. <td class="paramname"><em>v2</em>&#160;</td>
  506. </tr>
  507. <tr>
  508. <td></td>
  509. <td>)</td>
  510. <td></td><td></td>
  511. </tr>
  512. </table>
  513. </div><div class="memdoc">
  514. <p>Subtract two 2D vectors. </p><dl class="section return"><dt>Returns</dt><dd>v1-v2</dd></dl>
  515. <dl class="section user"><dt>See Engine Function/Method</dt><dd>Vector2::operator-(Vector2) </dd></dl>
  516. </div>
  517. </div>
  518. </div><!-- contents -->
  519. <!-- start footer part -->
  520. <hr class="footer"/><address class="footer"><small>
  521. 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
  522. </small></address>
  523. </body>
  524. </html>