namespaceFunctions_1_1Vector2Math.html 30 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544
  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: Functions::Vector2Math Namespace Reference</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. </head>
  13. <body>
  14. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  15. <div id="titlearea">
  16. <table cellspacing="0" cellpadding="0">
  17. <tbody>
  18. <tr style="height: 56px;">
  19. <td style="padding-left: 0.5em;">
  20. <div id="projectname">TorqueScript Reference
  21. </div>
  22. </td>
  23. </tr>
  24. </tbody>
  25. </table>
  26. </div>
  27. <!-- end header part -->
  28. <!-- Generated by Doxygen 1.8.3.1 -->
  29. <div id="navrow1" class="tabs">
  30. <ul class="tablist">
  31. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  32. <li><a href="namespaceFunctions.html"><span>Functions</span></a></li>
  33. <li><a href="usergroup0.html"><span>Classes</span></a></li>
  34. </ul>
  35. </div>
  36. <div id="nav-path" class="navpath">
  37. <ul>
  38. <li class="navelem"><a class="el" href="namespaceFunctions.html">Functions</a></li><li class="navelem"><a class="el" href="namespaceFunctions_1_1Vector2Math.html">Vector2Math</a></li> </ul>
  39. </div>
  40. </div><!-- top -->
  41. <div class="header">
  42. <div class="summary">
  43. <a href="#func-members">Functions</a> </div>
  44. <div class="headertitle">
  45. <div class="title">Functions::Vector2Math Namespace Reference</div> </div>
  46. </div><!--header-->
  47. <div class="contents">
  48. <table class="memberdecls">
  49. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  50. Functions</h2></td></tr>
  51. <tr class="memitem:a355a9b905b8baa03aececb6e109f840e"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceFunctions_1_1Vector2Math.html#a355a9b905b8baa03aececb6e109f840e">Vector2Abs</a> (<a class="elRef" doxygen="Torque2D.tag:../../torque2D/html/" href="../../torque2D/html/struct_vector2.html">Vector2</a> v1, <a class="elRef" doxygen="Torque2D.tag:../../torque2D/html/" href="../../torque2D/html/struct_vector2.html">Vector2</a> v2)</td></tr>
  52. <tr class="separator:a355a9b905b8baa03aececb6e109f840e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  53. <tr class="memitem:a45d7366d3c55e865c1886458e23d5e77"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceFunctions_1_1Vector2Math.html#a45d7366d3c55e865c1886458e23d5e77">Vector2Add</a> (<a class="elRef" doxygen="Torque2D.tag:../../torque2D/html/" href="../../torque2D/html/struct_vector2.html">Vector2</a> v1, <a class="elRef" doxygen="Torque2D.tag:../../torque2D/html/" href="../../torque2D/html/struct_vector2.html">Vector2</a> v2)</td></tr>
  54. <tr class="separator:a45d7366d3c55e865c1886458e23d5e77"><td class="memSeparator" colspan="2">&#160;</td></tr>
  55. <tr class="memitem:a7b5e6846faf093c7ba3638c7eb461a27"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceFunctions_1_1Vector2Math.html#a7b5e6846faf093c7ba3638c7eb461a27">Vector2AngleBetween</a> (<a class="elRef" doxygen="Torque2D.tag:../../torque2D/html/" href="../../torque2D/html/struct_vector2.html">Vector2</a> v1, <a class="elRef" doxygen="Torque2D.tag:../../torque2D/html/" href="../../torque2D/html/struct_vector2.html">Vector2</a> v2)</td></tr>
  56. <tr class="separator:a7b5e6846faf093c7ba3638c7eb461a27"><td class="memSeparator" colspan="2">&#160;</td></tr>
  57. <tr class="memitem:ace4799eae5f90acb6ff86cbfb33e27b1"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceFunctions_1_1Vector2Math.html#ace4799eae5f90acb6ff86cbfb33e27b1">Vector2AngleToPoint</a> (<a class="elRef" doxygen="Torque2D.tag:../../torque2D/html/" href="../../torque2D/html/struct_vector2.html">Vector2</a> p1, <a class="elRef" doxygen="Torque2D.tag:../../torque2D/html/" href="../../torque2D/html/struct_vector2.html">Vector2</a> p1)</td></tr>
  58. <tr class="separator:ace4799eae5f90acb6ff86cbfb33e27b1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  59. <tr class="memitem:ab16694023e1b2eb6b692297197187a59"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceFunctions_1_1Vector2Math.html#ab16694023e1b2eb6b692297197187a59">Vector2AreaNormalize</a> (<a class="elRef" doxygen="Torque2D.tag:../../torque2D/html/" href="../../torque2D/html/struct_vector2.html">Vector2</a> v1, <a class="elRef" doxygen="Torque2D.tag:../../torque2D/html/" href="../../torque2D/html/struct_vector2.html">Vector2</a> v2)</td></tr>
  60. <tr class="separator:ab16694023e1b2eb6b692297197187a59"><td class="memSeparator" colspan="2">&#160;</td></tr>
  61. <tr class="memitem:ad4a2a86fb52bb7aa2b8245218d5eab94"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceFunctions_1_1Vector2Math.html#ad4a2a86fb52bb7aa2b8245218d5eab94">Vector2Compare</a> (<a class="elRef" doxygen="Torque2D.tag:../../torque2D/html/" href="../../torque2D/html/struct_vector2.html">Vector2</a> p1, <a class="elRef" doxygen="Torque2D.tag:../../torque2D/html/" href="../../torque2D/html/struct_vector2.html">Vector2</a> p2,[epsilon])</td></tr>
  62. <tr class="separator:ad4a2a86fb52bb7aa2b8245218d5eab94"><td class="memSeparator" colspan="2">&#160;</td></tr>
  63. <tr class="memitem:aa3b7fc1d75d95ae100864adad7f01c3b"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceFunctions_1_1Vector2Math.html#aa3b7fc1d75d95ae100864adad7f01c3b">Vector2Direction</a> (F32 angle, F32 magnitude)</td></tr>
  64. <tr class="separator:aa3b7fc1d75d95ae100864adad7f01c3b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  65. <tr class="memitem:a7df0a878238bc0f0d6f1b728e2247b91"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceFunctions_1_1Vector2Math.html#a7df0a878238bc0f0d6f1b728e2247b91">Vector2Distance</a> (<a class="elRef" doxygen="Torque2D.tag:../../torque2D/html/" href="../../torque2D/html/struct_vector2.html">Vector2</a> p1, <a class="elRef" doxygen="Torque2D.tag:../../torque2D/html/" href="../../torque2D/html/struct_vector2.html">Vector2</a> p2)</td></tr>
  66. <tr class="separator:a7df0a878238bc0f0d6f1b728e2247b91"><td class="memSeparator" colspan="2">&#160;</td></tr>
  67. <tr class="memitem:aef40e53cae6619ef1e66eee6d863b34f"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceFunctions_1_1Vector2Math.html#aef40e53cae6619ef1e66eee6d863b34f">Vector2Dot</a> (<a class="elRef" doxygen="Torque2D.tag:../../torque2D/html/" href="../../torque2D/html/struct_vector2.html">Vector2</a> v1, <a class="elRef" doxygen="Torque2D.tag:../../torque2D/html/" href="../../torque2D/html/struct_vector2.html">Vector2</a> v2)</td></tr>
  68. <tr class="separator:aef40e53cae6619ef1e66eee6d863b34f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  69. <tr class="memitem:a1a99897e3a7ff1f484585d12209abf12"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceFunctions_1_1Vector2Math.html#a1a99897e3a7ff1f484585d12209abf12">Vector2Inverse</a> (<a class="elRef" doxygen="Torque2D.tag:../../torque2D/html/" href="../../torque2D/html/struct_vector2.html">Vector2</a> v1)</td></tr>
  70. <tr class="separator:a1a99897e3a7ff1f484585d12209abf12"><td class="memSeparator" colspan="2">&#160;</td></tr>
  71. <tr class="memitem:a25e85b83bf790449c34eef5b7611ea7b"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceFunctions_1_1Vector2Math.html#a25e85b83bf790449c34eef5b7611ea7b">Vector2InverseX</a> (<a class="elRef" doxygen="Torque2D.tag:../../torque2D/html/" href="../../torque2D/html/struct_vector2.html">Vector2</a> v1)</td></tr>
  72. <tr class="separator:a25e85b83bf790449c34eef5b7611ea7b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  73. <tr class="memitem:a66c37ad83325de339b2c7004faea08bf"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceFunctions_1_1Vector2Math.html#a66c37ad83325de339b2c7004faea08bf">Vector2InverseY</a> (<a class="elRef" doxygen="Torque2D.tag:../../torque2D/html/" href="../../torque2D/html/struct_vector2.html">Vector2</a> v1)</td></tr>
  74. <tr class="separator:a66c37ad83325de339b2c7004faea08bf"><td class="memSeparator" colspan="2">&#160;</td></tr>
  75. <tr class="memitem:abe24ae5e1e98950fec72da45b8f47f77"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceFunctions_1_1Vector2Math.html#abe24ae5e1e98950fec72da45b8f47f77">Vector2Length</a> (<a class="elRef" doxygen="Torque2D.tag:../../torque2D/html/" href="../../torque2D/html/struct_vector2.html">Vector2</a> v1)</td></tr>
  76. <tr class="separator:abe24ae5e1e98950fec72da45b8f47f77"><td class="memSeparator" colspan="2">&#160;</td></tr>
  77. <tr class="memitem:a2bb53cdf1c6f0e040d56b7939481c6af"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceFunctions_1_1Vector2Math.html#a2bb53cdf1c6f0e040d56b7939481c6af">Vector2Mult</a> (<a class="elRef" doxygen="Torque2D.tag:../../torque2D/html/" href="../../torque2D/html/struct_vector2.html">Vector2</a> v1, <a class="elRef" doxygen="Torque2D.tag:../../torque2D/html/" href="../../torque2D/html/struct_vector2.html">Vector2</a> v2)</td></tr>
  78. <tr class="separator:a2bb53cdf1c6f0e040d56b7939481c6af"><td class="memSeparator" colspan="2">&#160;</td></tr>
  79. <tr class="memitem:ae886056188db9ec19954b42d0f77d293"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceFunctions_1_1Vector2Math.html#ae886056188db9ec19954b42d0f77d293">Vector2Normalize</a> (<a class="elRef" doxygen="Torque2D.tag:../../torque2D/html/" href="../../torque2D/html/struct_vector2.html">Vector2</a> v1)</td></tr>
  80. <tr class="separator:ae886056188db9ec19954b42d0f77d293"><td class="memSeparator" colspan="2">&#160;</td></tr>
  81. <tr class="memitem:a13a6261d222be040598e47f6885d5a23"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceFunctions_1_1Vector2Math.html#a13a6261d222be040598e47f6885d5a23">Vector2Scale</a> (<a class="elRef" doxygen="Torque2D.tag:../../torque2D/html/" href="../../torque2D/html/struct_vector2.html">Vector2</a> v1, scale)</td></tr>
  82. <tr class="separator:a13a6261d222be040598e47f6885d5a23"><td class="memSeparator" colspan="2">&#160;</td></tr>
  83. <tr class="memitem:a5e0525076e2e3853b66113178ea1d444"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceFunctions_1_1Vector2Math.html#a5e0525076e2e3853b66113178ea1d444">Vector2Sub</a> (<a class="elRef" doxygen="Torque2D.tag:../../torque2D/html/" href="../../torque2D/html/struct_vector2.html">Vector2</a> v1, <a class="elRef" doxygen="Torque2D.tag:../../torque2D/html/" href="../../torque2D/html/struct_vector2.html">Vector2</a> v2)</td></tr>
  84. <tr class="separator:a5e0525076e2e3853b66113178ea1d444"><td class="memSeparator" colspan="2">&#160;</td></tr>
  85. </table>
  86. <h2 class="groupheader">Function Documentation</h2>
  87. <a class="anchor" id="a355a9b905b8baa03aececb6e109f840e"></a>
  88. <div class="memitem">
  89. <div class="memproto">
  90. <table class="memname">
  91. <tr>
  92. <td class="memname">string Functions::Vector2Math::Vector2Abs </td>
  93. <td>(</td>
  94. <td class="paramtype"><a class="elRef" doxygen="Torque2D.tag:../../torque2D/html/" href="../../torque2D/html/struct_vector2.html">Vector2</a>&#160;</td>
  95. <td class="paramname"><em>v1</em>, </td>
  96. </tr>
  97. <tr>
  98. <td class="paramkey"></td>
  99. <td></td>
  100. <td class="paramtype"><a class="elRef" doxygen="Torque2D.tag:../../torque2D/html/" href="../../torque2D/html/struct_vector2.html">Vector2</a>&#160;</td>
  101. <td class="paramname"><em>v2</em>&#160;</td>
  102. </tr>
  103. <tr>
  104. <td></td>
  105. <td>)</td>
  106. <td></td><td></td>
  107. </tr>
  108. </table>
  109. </div><div class="memdoc">
  110. <p>Absolute difference of two 2-Vectors </p>
  111. <dl class="section return"><dt>Returns</dt><dd>abs(v1-v2)</dd></dl>
  112. <dl class="section user"><dt>From Engine</dt><dd></dd></dl>
  113. <dl class="section see"><dt>See Also</dt><dd><a class="elRef" doxygen="Torque2D.tag:../../torque2D/html/" href="../../torque2D/html/struct_vector2.html#ad5d4ce555b364c4ecd05a6890e516289">Vector2::absolute</a> </dd></dl>
  114. </div>
  115. </div>
  116. <a class="anchor" id="a45d7366d3c55e865c1886458e23d5e77"></a>
  117. <div class="memitem">
  118. <div class="memproto">
  119. <table class="memname">
  120. <tr>
  121. <td class="memname">string Functions::Vector2Math::Vector2Add </td>
  122. <td>(</td>
  123. <td class="paramtype"><a class="elRef" doxygen="Torque2D.tag:../../torque2D/html/" href="../../torque2D/html/struct_vector2.html">Vector2</a>&#160;</td>
  124. <td class="paramname"><em>v1</em>, </td>
  125. </tr>
  126. <tr>
  127. <td class="paramkey"></td>
  128. <td></td>
  129. <td class="paramtype"><a class="elRef" doxygen="Torque2D.tag:../../torque2D/html/" href="../../torque2D/html/struct_vector2.html">Vector2</a>&#160;</td>
  130. <td class="paramname"><em>v2</em>&#160;</td>
  131. </tr>
  132. <tr>
  133. <td></td>
  134. <td>)</td>
  135. <td></td><td></td>
  136. </tr>
  137. </table>
  138. </div><div class="memdoc">
  139. <p>Add two 2-Vectors. </p>
  140. <dl class="section return"><dt>Returns</dt><dd>v1+v2</dd></dl>
  141. <dl class="section user"><dt>From Engine</dt><dd></dd></dl>
  142. <dl class="section see"><dt>See Also</dt><dd><a class="elRef" doxygen="Torque2D.tag:../../torque2D/html/" href="../../torque2D/html/struct_vector2.html#acceb2fffa22e88e87d986af3837348a0">Vector2::operator+</a> </dd></dl>
  143. </div>
  144. </div>
  145. <a class="anchor" id="a7b5e6846faf093c7ba3638c7eb461a27"></a>
  146. <div class="memitem">
  147. <div class="memproto">
  148. <table class="memname">
  149. <tr>
  150. <td class="memname">float Functions::Vector2Math::Vector2AngleBetween </td>
  151. <td>(</td>
  152. <td class="paramtype"><a class="elRef" doxygen="Torque2D.tag:../../torque2D/html/" href="../../torque2D/html/struct_vector2.html">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="elRef" doxygen="Torque2D.tag:../../torque2D/html/" href="../../torque2D/html/struct_vector2.html">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>
  169. <dl class="section return"><dt>Returns</dt><dd>the angle between v1 and v2. </dd></dl>
  170. </div>
  171. </div>
  172. <a class="anchor" id="ace4799eae5f90acb6ff86cbfb33e27b1"></a>
  173. <div class="memitem">
  174. <div class="memproto">
  175. <table class="memname">
  176. <tr>
  177. <td class="memname">float Functions::Vector2Math::Vector2AngleToPoint </td>
  178. <td>(</td>
  179. <td class="paramtype"><a class="elRef" doxygen="Torque2D.tag:../../torque2D/html/" href="../../torque2D/html/struct_vector2.html">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="elRef" doxygen="Torque2D.tag:../../torque2D/html/" href="../../torque2D/html/struct_vector2.html">Vector2</a>&#160;</td>
  186. <td class="paramname"><em>p1</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>
  196. <dl class="section return"><dt>Returns</dt><dd>the angle from p1 to p2. </dd></dl>
  197. </div>
  198. </div>
  199. <a class="anchor" id="ab16694023e1b2eb6b692297197187a59"></a>
  200. <div class="memitem">
  201. <div class="memproto">
  202. <table class="memname">
  203. <tr>
  204. <td class="memname">string Functions::Vector2Math::Vector2AreaNormalize </td>
  205. <td>(</td>
  206. <td class="paramtype"><a class="elRef" doxygen="Torque2D.tag:../../torque2D/html/" href="../../torque2D/html/struct_vector2.html">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="elRef" doxygen="Torque2D.tag:../../torque2D/html/" href="../../torque2D/html/struct_vector2.html">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>
  223. <dl class="section return"><dt>Returns</dt><dd>Normalize rectangle of v1 and v2. </dd></dl>
  224. </div>
  225. </div>
  226. <a class="anchor" id="ad4a2a86fb52bb7aa2b8245218d5eab94"></a>
  227. <div class="memitem">
  228. <div class="memproto">
  229. <table class="memname">
  230. <tr>
  231. <td class="memname">bool Functions::Vector2Math::Vector2Compare </td>
  232. <td>(</td>
  233. <td class="paramtype"><a class="elRef" doxygen="Torque2D.tag:../../torque2D/html/" href="../../torque2D/html/struct_vector2.html">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="elRef" doxygen="Torque2D.tag:../../torque2D/html/" href="../../torque2D/html/struct_vector2.html">Vector2</a>&#160;</td>
  240. <td class="paramname"><em>p2</em>&#160;</td>
  241. </tr>
  242. <tr>
  243. <td></td>
  244. <td>)</td>
  245. <td></td><td></td>
  246. </tr>
  247. </table>
  248. </div><div class="memdoc">
  249. <p>Equality of two 2D Points. Compares points p1 and p2 with optional difference (epsilon). </p>
  250. <dl class="section return"><dt>Returns</dt><dd>true if equal </dd></dl>
  251. </div>
  252. </div>
  253. <a class="anchor" id="aa3b7fc1d75d95ae100864adad7f01c3b"></a>
  254. <div class="memitem">
  255. <div class="memproto">
  256. <table class="memname">
  257. <tr>
  258. <td class="memname">string Functions::Vector2Math::Vector2Direction </td>
  259. <td>(</td>
  260. <td class="paramtype">F32&#160;</td>
  261. <td class="paramname"><em>angle</em>, </td>
  262. </tr>
  263. <tr>
  264. <td class="paramkey"></td>
  265. <td></td>
  266. <td class="paramtype">F32&#160;</td>
  267. <td class="paramname"><em>magnitude</em>&#160;</td>
  268. </tr>
  269. <tr>
  270. <td></td>
  271. <td>)</td>
  272. <td></td><td></td>
  273. </tr>
  274. </table>
  275. </div><div class="memdoc">
  276. <p><a class="elRef" doxygen="Torque2D.tag:../../torque2D/html/" href="../../torque2D/html/class_vector.html">Vector</a> from angle and magnitude. Calculates a direction from an angle and magnitude. </p>
  277. <dl class="params"><dt>Parameters</dt><dd>
  278. <table class="params">
  279. <tr><td class="paramname">angle</td><td>The angle of the direction. </td></tr>
  280. <tr><td class="paramname">magnitude</td><td>The magnitude of the direction. </td></tr>
  281. </table>
  282. </dd>
  283. </dl>
  284. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
  285. </div>
  286. </div>
  287. <a class="anchor" id="a7df0a878238bc0f0d6f1b728e2247b91"></a>
  288. <div class="memitem">
  289. <div class="memproto">
  290. <table class="memname">
  291. <tr>
  292. <td class="memname">float Functions::Vector2Math::Vector2Distance </td>
  293. <td>(</td>
  294. <td class="paramtype"><a class="elRef" doxygen="Torque2D.tag:../../torque2D/html/" href="../../torque2D/html/struct_vector2.html">Vector2</a>&#160;</td>
  295. <td class="paramname"><em>p1</em>, </td>
  296. </tr>
  297. <tr>
  298. <td class="paramkey"></td>
  299. <td></td>
  300. <td class="paramtype"><a class="elRef" doxygen="Torque2D.tag:../../torque2D/html/" href="../../torque2D/html/struct_vector2.html">Vector2</a>&#160;</td>
  301. <td class="paramname"><em>p2</em>&#160;</td>
  302. </tr>
  303. <tr>
  304. <td></td>
  305. <td>)</td>
  306. <td></td><td></td>
  307. </tr>
  308. </table>
  309. </div><div class="memdoc">
  310. <p>Distance between two 2D Points. </p>
  311. <dl class="section return"><dt>Returns</dt><dd>the distance between points p1 and p2 </dd></dl>
  312. </div>
  313. </div>
  314. <a class="anchor" id="aef40e53cae6619ef1e66eee6d863b34f"></a>
  315. <div class="memitem">
  316. <div class="memproto">
  317. <table class="memname">
  318. <tr>
  319. <td class="memname">float Functions::Vector2Math::Vector2Dot </td>
  320. <td>(</td>
  321. <td class="paramtype"><a class="elRef" doxygen="Torque2D.tag:../../torque2D/html/" href="../../torque2D/html/struct_vector2.html">Vector2</a>&#160;</td>
  322. <td class="paramname"><em>v1</em>, </td>
  323. </tr>
  324. <tr>
  325. <td class="paramkey"></td>
  326. <td></td>
  327. <td class="paramtype"><a class="elRef" doxygen="Torque2D.tag:../../torque2D/html/" href="../../torque2D/html/struct_vector2.html">Vector2</a>&#160;</td>
  328. <td class="paramname"><em>v2</em>&#160;</td>
  329. </tr>
  330. <tr>
  331. <td></td>
  332. <td>)</td>
  333. <td></td><td></td>
  334. </tr>
  335. </table>
  336. </div><div class="memdoc">
  337. <p>Dot-Product of two 2D Vectors. </p>
  338. <dl class="section return"><dt>Returns</dt><dd>dot-product of v1 and v2.</dd></dl>
  339. <dl class="section user"><dt>From Engine</dt><dd></dd></dl>
  340. <dl class="section see"><dt>See Also</dt><dd><a class="elRef" doxygen="Torque2D.tag:../../torque2D/html/" href="../../torque2D/html/struct_vector2.html#ad592d54288bd053d74fdf58edd1dad67">Vector2::dot</a> </dd></dl>
  341. </div>
  342. </div>
  343. <a class="anchor" id="a1a99897e3a7ff1f484585d12209abf12"></a>
  344. <div class="memitem">
  345. <div class="memproto">
  346. <table class="memname">
  347. <tr>
  348. <td class="memname">string Functions::Vector2Math::Vector2Inverse </td>
  349. <td>(</td>
  350. <td class="paramtype"><a class="elRef" doxygen="Torque2D.tag:../../torque2D/html/" href="../../torque2D/html/struct_vector2.html">Vector2</a>&#160;</td>
  351. <td class="paramname"><em>v1</em></td><td>)</td>
  352. <td></td>
  353. </tr>
  354. </table>
  355. </div><div class="memdoc">
  356. <p>Inverse of a 2D <a class="elRef" doxygen="Torque2D.tag:../../torque2D/html/" href="../../torque2D/html/class_vector.html">Vector</a>. </p>
  357. <dl class="section return"><dt>Returns</dt><dd>the inverse of v1.</dd></dl>
  358. <dl class="section user"><dt>From Engine</dt><dd></dd></dl>
  359. <dl class="section see"><dt>See Also</dt><dd><a class="elRef" doxygen="Torque2D.tag:../../torque2D/html/" href="../../torque2D/html/struct_vector2.html#ac25a17bc434a3d7f86dcdee227cb417b">Vector2::operator-()</a> </dd></dl>
  360. </div>
  361. </div>
  362. <a class="anchor" id="a25e85b83bf790449c34eef5b7611ea7b"></a>
  363. <div class="memitem">
  364. <div class="memproto">
  365. <table class="memname">
  366. <tr>
  367. <td class="memname">string Functions::Vector2Math::Vector2InverseX </td>
  368. <td>(</td>
  369. <td class="paramtype"><a class="elRef" doxygen="Torque2D.tag:../../torque2D/html/" href="../../torque2D/html/struct_vector2.html">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 <a class="elRef" doxygen="Torque2D.tag:../../torque2D/html/" href="../../torque2D/html/class_vector.html">Vector</a>. </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="a66c37ad83325de339b2c7004faea08bf"></a>
  380. <div class="memitem">
  381. <div class="memproto">
  382. <table class="memname">
  383. <tr>
  384. <td class="memname">string Functions::Vector2Math::Vector2InverseY </td>
  385. <td>(</td>
  386. <td class="paramtype"><a class="elRef" doxygen="Torque2D.tag:../../torque2D/html/" href="../../torque2D/html/struct_vector2.html">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 <a class="elRef" doxygen="Torque2D.tag:../../torque2D/html/" href="../../torque2D/html/class_vector.html">Vector</a>. </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="abe24ae5e1e98950fec72da45b8f47f77"></a>
  397. <div class="memitem">
  398. <div class="memproto">
  399. <table class="memname">
  400. <tr>
  401. <td class="memname">float Functions::Vector2Math::Vector2Length </td>
  402. <td>(</td>
  403. <td class="paramtype"><a class="elRef" doxygen="Torque2D.tag:../../torque2D/html/" href="../../torque2D/html/struct_vector2.html">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 <a class="elRef" doxygen="Torque2D.tag:../../torque2D/html/" href="../../torque2D/html/class_vector.html">Vector</a>. </p>
  410. <dl class="section return"><dt>Returns</dt><dd>the length of v1.</dd></dl>
  411. <dl class="section user"><dt>From Engine</dt><dd></dd></dl>
  412. <dl class="section see"><dt>See Also</dt><dd>Vector2::Length </dd></dl>
  413. </div>
  414. </div>
  415. <a class="anchor" id="a2bb53cdf1c6f0e040d56b7939481c6af"></a>
  416. <div class="memitem">
  417. <div class="memproto">
  418. <table class="memname">
  419. <tr>
  420. <td class="memname">string Functions::Vector2Math::Vector2Mult </td>
  421. <td>(</td>
  422. <td class="paramtype"><a class="elRef" doxygen="Torque2D.tag:../../torque2D/html/" href="../../torque2D/html/struct_vector2.html">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="elRef" doxygen="Torque2D.tag:../../torque2D/html/" href="../../torque2D/html/struct_vector2.html">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="ae886056188db9ec19954b42d0f77d293"></a>
  443. <div class="memitem">
  444. <div class="memproto">
  445. <table class="memname">
  446. <tr>
  447. <td class="memname">string Functions::Vector2Math::Vector2Normalize </td>
  448. <td>(</td>
  449. <td class="paramtype"><a class="elRef" doxygen="Torque2D.tag:../../torque2D/html/" href="../../torque2D/html/struct_vector2.html">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 <a class="elRef" doxygen="Torque2D.tag:../../torque2D/html/" href="../../torque2D/html/class_vector.html">Vector</a>. </p>
  456. <dl class="section return"><dt>Returns</dt><dd>Normalized v1.</dd></dl>
  457. <dl class="section user"><dt>From Engine</dt><dd></dd></dl>
  458. <dl class="section see"><dt>See Also</dt><dd><a class="elRef" doxygen="Torque2D.tag:../../torque2D/html/" href="../../torque2D/html/struct_vector2.html#acce5f6c4ded8c9be8886362b02e41b0b">Vector2::Normalize</a> </dd></dl>
  459. </div>
  460. </div>
  461. <a class="anchor" id="a13a6261d222be040598e47f6885d5a23"></a>
  462. <div class="memitem">
  463. <div class="memproto">
  464. <table class="memname">
  465. <tr>
  466. <td class="memname">string Functions::Vector2Math::Vector2Scale </td>
  467. <td>(</td>
  468. <td class="paramtype"><a class="elRef" doxygen="Torque2D.tag:../../torque2D/html/" href="../../torque2D/html/struct_vector2.html">Vector2</a>&#160;</td>
  469. <td class="paramname"><em>v1</em>, </td>
  470. </tr>
  471. <tr>
  472. <td class="paramkey"></td>
  473. <td></td>
  474. <td class="paramtype">scale&#160;</td>
  475. <td class="paramname">&#160;</td>
  476. </tr>
  477. <tr>
  478. <td></td>
  479. <td>)</td>
  480. <td></td><td></td>
  481. </tr>
  482. </table>
  483. </div><div class="memdoc">
  484. <p>Scale a 2D <a class="elRef" doxygen="Torque2D.tag:../../torque2D/html/" href="../../torque2D/html/class_vector.html">Vector</a>. </p>
  485. <dl class="section return"><dt>Returns</dt><dd>v1 scaled by scale.</dd></dl>
  486. <dl class="section user"><dt>From Engine</dt><dd></dd></dl>
  487. <dl class="section see"><dt>See Also</dt><dd><a class="elRef" doxygen="Torque2D.tag:../../torque2D/html/" href="../../torque2D/html/struct_vector2.html#ac05d908e7b3dc51a1414780c9f787394">Vector2::operator*</a> </dd></dl>
  488. </div>
  489. </div>
  490. <a class="anchor" id="a5e0525076e2e3853b66113178ea1d444"></a>
  491. <div class="memitem">
  492. <div class="memproto">
  493. <table class="memname">
  494. <tr>
  495. <td class="memname">string Functions::Vector2Math::Vector2Sub </td>
  496. <td>(</td>
  497. <td class="paramtype"><a class="elRef" doxygen="Torque2D.tag:../../torque2D/html/" href="../../torque2D/html/struct_vector2.html">Vector2</a>&#160;</td>
  498. <td class="paramname"><em>v1</em>, </td>
  499. </tr>
  500. <tr>
  501. <td class="paramkey"></td>
  502. <td></td>
  503. <td class="paramtype"><a class="elRef" doxygen="Torque2D.tag:../../torque2D/html/" href="../../torque2D/html/struct_vector2.html">Vector2</a>&#160;</td>
  504. <td class="paramname"><em>v2</em>&#160;</td>
  505. </tr>
  506. <tr>
  507. <td></td>
  508. <td>)</td>
  509. <td></td><td></td>
  510. </tr>
  511. </table>
  512. </div><div class="memdoc">
  513. <p>Subtract two 2D Vectors. </p>
  514. <dl class="section return"><dt>Returns</dt><dd>v1-v2</dd></dl>
  515. <dl class="section user"><dt>From Engine</dt><dd></dd></dl>
  516. <dl class="section see"><dt>See Also</dt><dd>Vector2::operator-(Vector2) </dd></dl>
  517. </div>
  518. </div>
  519. </div><!-- contents -->
  520. <!-- start footer part -->
  521. <hr class="footer"/><address class="footer"><small>
  522. Generated on Mon Apr 15 2013 10:42:56 for TorqueScript Reference by &#160;<a href="http://www.doxygen.org/index.html">
  523. <img class="footer" src="doxygen.png" alt="doxygen"/>
  524. </a> 1.8.3.1
  525. </small></address>
  526. </body>
  527. </html>