| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532 |
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
- <html xmlns="http://www.w3.org/1999/xhtml">
- <head>
- <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
- <title>Vector2Math</title>
- <link href="torquedoc.css" rel="stylesheet" type="text/css"/>
- </head>
- <body>
- <table width="100%" class="header">
- <tr>
- </tr>
- <tr><td class="headermenu">
- <center>
- <a class="qindex" href="index.html">Main</a>
- <a class="qindex" target="_blank" href="https://github.com/GarageGames/Torque2D">GitHub</a>
- </center>
- </td></tr>
- </table>
- <br>
- <!-- END HEADER -->
- <!-- Generated by Doxygen 1.8.3.1 -->
- </div><!-- top -->
- <div class="header">
- <div class="summary">
- <a href="#func-members">Functions</a> </div>
- <div class="headertitle">
- <div class="title">Vector2Math</div> </div>
- </div><!--header-->
- <div class="contents">
- <table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
- Functions</h2></td></tr>
- <tr class="memitem:gac90572aca051bfa3e09c7caf148d1558"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Vector2Math.html#gac90572aca051bfa3e09c7caf148d1558">Vector2Abs</a> (Vector2 v1, Vector2 v2)</td></tr>
- <tr class="separator:gac90572aca051bfa3e09c7caf148d1558"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga354a8bc7c7dedf6cb45e6586b2edabca"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Vector2Math.html#ga354a8bc7c7dedf6cb45e6586b2edabca">Vector2Add</a> (Vector2 v1, Vector2 v2)</td></tr>
- <tr class="separator:ga354a8bc7c7dedf6cb45e6586b2edabca"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:gab4ad61aa083dccd62b61b80c5b5f4c3b"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Vector2Math.html#gab4ad61aa083dccd62b61b80c5b5f4c3b">Vector2AngleBetween</a> (Vector2 v1, Vector2 v2)</td></tr>
- <tr class="separator:gab4ad61aa083dccd62b61b80c5b5f4c3b"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:gad22c735f793d613af07dd6ceffc7e6a5"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Vector2Math.html#gad22c735f793d613af07dd6ceffc7e6a5">Vector2AngleToPoint</a> (Vector2 p1, Vector2 p1)</td></tr>
- <tr class="separator:gad22c735f793d613af07dd6ceffc7e6a5"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga960565cbc62d9ea96b173f4ffd2642f5"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Vector2Math.html#ga960565cbc62d9ea96b173f4ffd2642f5">Vector2AreaNormalize</a> (Vector2 v1, Vector2 v2)</td></tr>
- <tr class="separator:ga960565cbc62d9ea96b173f4ffd2642f5"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga4a542e91f07dec3f0af7cbef8144dc27"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Vector2Math.html#ga4a542e91f07dec3f0af7cbef8144dc27">Vector2Compare</a> (Vector2 p1, Vector2 p2,[epsilon])</td></tr>
- <tr class="separator:ga4a542e91f07dec3f0af7cbef8144dc27"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga8bfafe540a1c2d58457fca7898dc340f"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Vector2Math.html#ga8bfafe540a1c2d58457fca7898dc340f">Vector2Direction</a> (F32 angle, F32 magnitude)</td></tr>
- <tr class="separator:ga8bfafe540a1c2d58457fca7898dc340f"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga5c099dbb8bc5c745d77182a839156f6e"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Vector2Math.html#ga5c099dbb8bc5c745d77182a839156f6e">Vector2Distance</a> (Vector2 p1, Vector2 p2)</td></tr>
- <tr class="separator:ga5c099dbb8bc5c745d77182a839156f6e"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:gad4e5d8c14eae27f247251e2d9a088608"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Vector2Math.html#gad4e5d8c14eae27f247251e2d9a088608">Vector2Dot</a> (Vector2 v1, Vector2 v2)</td></tr>
- <tr class="separator:gad4e5d8c14eae27f247251e2d9a088608"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:gad3a4ebae6bcf918c0ba959afac044169"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Vector2Math.html#gad3a4ebae6bcf918c0ba959afac044169">Vector2Inverse</a> (Vector2 v1)</td></tr>
- <tr class="separator:gad3a4ebae6bcf918c0ba959afac044169"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga572d80eaca01d92a9a90593dd5a3344f"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Vector2Math.html#ga572d80eaca01d92a9a90593dd5a3344f">Vector2InverseX</a> (Vector2 v1)</td></tr>
- <tr class="separator:ga572d80eaca01d92a9a90593dd5a3344f"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga65ec28a4dd5756e7f7acb5f7d1635ac5"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Vector2Math.html#ga65ec28a4dd5756e7f7acb5f7d1635ac5">Vector2InverseY</a> (Vector2 v1)</td></tr>
- <tr class="separator:ga65ec28a4dd5756e7f7acb5f7d1635ac5"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga9e51cb4cf7dfbd95553792586dc22982"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Vector2Math.html#ga9e51cb4cf7dfbd95553792586dc22982">Vector2Length</a> (Vector2 v1)</td></tr>
- <tr class="separator:ga9e51cb4cf7dfbd95553792586dc22982"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga4c892571b19028e39f1e082fec8b351c"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Vector2Math.html#ga4c892571b19028e39f1e082fec8b351c">Vector2Mult</a> (Vector2 v1, Vector2 v2)</td></tr>
- <tr class="separator:ga4c892571b19028e39f1e082fec8b351c"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:gad9ea93dd91f94cb3fe3d5baada7ef5c9"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Vector2Math.html#gad9ea93dd91f94cb3fe3d5baada7ef5c9">Vector2Normalize</a> (Vector2 v1)</td></tr>
- <tr class="separator:gad9ea93dd91f94cb3fe3d5baada7ef5c9"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga7690bb7cd4bb1d55f5d3aed45ed35412"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Vector2Math.html#ga7690bb7cd4bb1d55f5d3aed45ed35412">Vector2Scale</a> (Vector2 v1, scale)</td></tr>
- <tr class="separator:ga7690bb7cd4bb1d55f5d3aed45ed35412"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:gabb28c303c7b4146062c06b0c54824f39"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Vector2Math.html#gabb28c303c7b4146062c06b0c54824f39">Vector2Sub</a> (Vector2 v1, Vector2 v2)</td></tr>
- <tr class="separator:gabb28c303c7b4146062c06b0c54824f39"><td class="memSeparator" colspan="2"> </td></tr>
- </table>
- <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
- <p>Vector2 math functions. </p>
- <h2 class="groupheader">Function Documentation</h2>
- <a class="anchor" id="gac90572aca051bfa3e09c7caf148d1558"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">string Vector2Abs </td>
- <td>(</td>
- <td class="paramtype">Vector2 </td>
- <td class="paramname"><em>v1</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">Vector2 </td>
- <td class="paramname"><em>v2</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <ul>
- <li>Returns abs(v1-v2). </li>
- </ul>
- </div>
- </div>
- <a class="anchor" id="ga354a8bc7c7dedf6cb45e6586b2edabca"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">string Vector2Add </td>
- <td>(</td>
- <td class="paramtype">Vector2 </td>
- <td class="paramname"><em>v1</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">Vector2 </td>
- <td class="paramname"><em>v2</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <ul>
- <li>Returns v1+v2. </li>
- </ul>
- </div>
- </div>
- <a class="anchor" id="gab4ad61aa083dccd62b61b80c5b5f4c3b"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">float Vector2AngleBetween </td>
- <td>(</td>
- <td class="paramtype">Vector2 </td>
- <td class="paramname"><em>v1</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">Vector2 </td>
- <td class="paramname"><em>v2</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <ul>
- <li>Returns the angle between v1 and v2. </li>
- </ul>
- </div>
- </div>
- <a class="anchor" id="gad22c735f793d613af07dd6ceffc7e6a5"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">float Vector2AngleToPoint </td>
- <td>(</td>
- <td class="paramtype">Vector2 </td>
- <td class="paramname"><em>p1</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">Vector2 </td>
- <td class="paramname"><em>p1</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <ul>
- <li>Returns the angle from p1 to p2. </li>
- </ul>
- </div>
- </div>
- <a class="anchor" id="ga960565cbc62d9ea96b173f4ffd2642f5"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">string Vector2AreaNormalize </td>
- <td>(</td>
- <td class="paramtype">Vector2 </td>
- <td class="paramname"><em>v1</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">Vector2 </td>
- <td class="paramname"><em>v2</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <ul>
- <li>Returns Normalize rectangle of v1 and v2. </li>
- </ul>
- </div>
- </div>
- <a class="anchor" id="ga4a542e91f07dec3f0af7cbef8144dc27"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">bool Vector2Compare </td>
- <td>(</td>
- <td class="paramtype">Vector2 </td>
- <td class="paramname"><em>p1</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">Vector2 </td>
- <td class="paramname"><em>p2</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <ul>
- <li>Compares points p1 and p2 with optional difference (epsilon). </li>
- </ul>
- </div>
- </div>
- <a class="anchor" id="ga8bfafe540a1c2d58457fca7898dc340f"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">string Vector2Direction </td>
- <td>(</td>
- <td class="paramtype">F32 </td>
- <td class="paramname"><em>angle</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">F32 </td>
- <td class="paramname"><em>magnitude</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <ul>
- <li>Calculates a direction from an angle and magnitude. <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">angle</td><td>The angle of the direction. </td></tr>
- <tr><td class="paramname">magnitude</td><td>The magnitude of the direction. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
- </li>
- </ul>
- </div>
- </div>
- <a class="anchor" id="ga5c099dbb8bc5c745d77182a839156f6e"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">float Vector2Distance </td>
- <td>(</td>
- <td class="paramtype">Vector2 </td>
- <td class="paramname"><em>p1</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">Vector2 </td>
- <td class="paramname"><em>p2</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <ul>
- <li>Returns the distance between points p1 and p2. </li>
- </ul>
- </div>
- </div>
- <a class="anchor" id="gad4e5d8c14eae27f247251e2d9a088608"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">float Vector2Dot </td>
- <td>(</td>
- <td class="paramtype">Vector2 </td>
- <td class="paramname"><em>v1</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">Vector2 </td>
- <td class="paramname"><em>v2</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <ul>
- <li>Returns dot-product of v1 and v2. </li>
- </ul>
- </div>
- </div>
- <a class="anchor" id="gad3a4ebae6bcf918c0ba959afac044169"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">string Vector2Inverse </td>
- <td>(</td>
- <td class="paramtype">Vector2 </td>
- <td class="paramname"><em>v1</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <ul>
- <li>Returns the inverse of v1. </li>
- </ul>
- </div>
- </div>
- <a class="anchor" id="ga572d80eaca01d92a9a90593dd5a3344f"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">string Vector2InverseX </td>
- <td>(</td>
- <td class="paramtype">Vector2 </td>
- <td class="paramname"><em>v1</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <ul>
- <li>Returns the inverse of the v1 X component. </li>
- </ul>
- </div>
- </div>
- <a class="anchor" id="ga65ec28a4dd5756e7f7acb5f7d1635ac5"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">string Vector2InverseY </td>
- <td>(</td>
- <td class="paramtype">Vector2 </td>
- <td class="paramname"><em>v1</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <ul>
- <li>Returns the inverse of the v1 Y component. </li>
- </ul>
- </div>
- </div>
- <a class="anchor" id="ga9e51cb4cf7dfbd95553792586dc22982"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">float Vector2Length </td>
- <td>(</td>
- <td class="paramtype">Vector2 </td>
- <td class="paramname"><em>v1</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <ul>
- <li>Returns the length of v1. </li>
- </ul>
- </div>
- </div>
- <a class="anchor" id="ga4c892571b19028e39f1e082fec8b351c"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">string Vector2Mult </td>
- <td>(</td>
- <td class="paramtype">Vector2 </td>
- <td class="paramname"><em>v1</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">Vector2 </td>
- <td class="paramname"><em>v2</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <ul>
- <li>Returns v1 mult v2. </li>
- </ul>
- </div>
- </div>
- <a class="anchor" id="gad9ea93dd91f94cb3fe3d5baada7ef5c9"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">string Vector2Normalize </td>
- <td>(</td>
- <td class="paramtype">Vector2 </td>
- <td class="paramname"><em>v1</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <ul>
- <li>Returns Normalized v1. </li>
- </ul>
- </div>
- </div>
- <a class="anchor" id="ga7690bb7cd4bb1d55f5d3aed45ed35412"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">string Vector2Scale </td>
- <td>(</td>
- <td class="paramtype">Vector2 </td>
- <td class="paramname"><em>v1</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">scale </td>
- <td class="paramname"> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <ul>
- <li>Returns v1 scaled by scale. </li>
- </ul>
- </div>
- </div>
- <a class="anchor" id="gabb28c303c7b4146062c06b0c54824f39"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">string Vector2Sub </td>
- <td>(</td>
- <td class="paramtype">Vector2 </td>
- <td class="paramname"><em>v1</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">Vector2 </td>
- <td class="paramname"><em>v2</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <ul>
- <li>Returns v1-v2. </li>
- </ul>
- </div>
- </div>
- </div><!-- contents -->
- <!-- START FOOTER -->
- <br>
- <br>
- <center>
- <div style="color: #777777;">
- Copyright © 2013 <a style="color: #777777;" target="_blank" href="http://www.garagegames.com">GarageGames, LLC</a>. All Rights Reserved.
- </div>
- </center>
- </body>
- </html>
|