| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558 |
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
- <html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
- <head>
- <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
- <meta http-equiv="X-UA-Compatible" content="IE=11"/>
- <meta name="generator" content="Doxygen 1.9.8"/>
- <meta name="viewport" content="width=device-width, initial-scale=1"/>
- <title>TorqueScript Reference: Vector2 Math</title>
- <link href="tabs.css" rel="stylesheet" type="text/css"/>
- <script type="text/javascript" src="jquery.js"></script>
- <script type="text/javascript" src="dynsections.js"></script>
- <link href="doxygen.css" rel="stylesheet" type="text/css" />
- <link href="t2d-stylesheet-extra.css" rel="stylesheet" type="text/css"/>
- </head>
- <body>
- <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
- <div id="titlearea">
- <table cellspacing="0" cellpadding="0">
- <tbody>
- <tr id="projectrow">
- <td id="projectalign">
- <div id="projectname">TorqueScript Reference
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <!-- end header part -->
- <!-- Generated by Doxygen 1.9.8 -->
- <script type="text/javascript" src="menudata.js"></script>
- <script type="text/javascript" src="menu.js"></script>
- <script type="text/javascript">
- /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
- $(function() {
- initMenu('',false,false,'search.php','Search');
- });
- /* @license-end */
- </script>
- <div id="main-nav"></div>
- </div><!-- top -->
- <div class="header">
- <div class="summary">
- <a href="#func-members">Functions</a> </div>
- <div class="headertitle"><div class="title">Vector2 Math<div class="ingroups"><a class="el" href="group__TorqueScriptFunctions.html">Function Categories</a></div></div></div>
- </div><!--header-->
- <div class="contents">
- <table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
- Functions</h2></td></tr>
- <tr class="memitem:ga6ecb30bbf007e18418773cb98c324303" id="r_ga6ecb30bbf007e18418773cb98c324303"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> </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>
- <tr class="separator:ga6ecb30bbf007e18418773cb98c324303"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga2f0bbc1896677584f4f26183a957ce33" id="r_ga2f0bbc1896677584f4f26183a957ce33"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> </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>
- <tr class="separator:ga2f0bbc1896677584f4f26183a957ce33"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga88da5f5c71ac32e6f507da999b3f90e8" id="r_ga88da5f5c71ac32e6f507da999b3f90e8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> </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>
- <tr class="separator:ga88da5f5c71ac32e6f507da999b3f90e8"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:gae0a4dc209ed4d562c02e4237e718c998" id="r_gae0a4dc209ed4d562c02e4237e718c998"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> </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>
- <tr class="separator:gae0a4dc209ed4d562c02e4237e718c998"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga27b93cf688a4b8dd6a5456dcd4fc700f" id="r_ga27b93cf688a4b8dd6a5456dcd4fc700f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> </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>
- <tr class="separator:ga27b93cf688a4b8dd6a5456dcd4fc700f"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga30301fc4bab47cf920382bac80090182" id="r_ga30301fc4bab47cf920382bac80090182"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> </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>
- <tr class="separator:ga30301fc4bab47cf920382bac80090182"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:gab9990f0302735e67f005d981d794aa8c" id="r_gab9990f0302735e67f005d981d794aa8c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Vector2Math.html#gab9990f0302735e67f005d981d794aa8c">Vector2Direction</a> (F32 angle, F32 magnitude)</td></tr>
- <tr class="separator:gab9990f0302735e67f005d981d794aa8c"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga0f5078c1de0b26e8188ef94025ec12e2" id="r_ga0f5078c1de0b26e8188ef94025ec12e2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> </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>
- <tr class="separator:ga0f5078c1de0b26e8188ef94025ec12e2"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:gadab2b3ad1c05161add7da0f933d348ff" id="r_gadab2b3ad1c05161add7da0f933d348ff"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> </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>
- <tr class="separator:gadab2b3ad1c05161add7da0f933d348ff"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga453ede6d126208a3d17362535ecb5fc5" id="r_ga453ede6d126208a3d17362535ecb5fc5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> </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>
- <tr class="separator:ga453ede6d126208a3d17362535ecb5fc5"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga973666b5824d13483f36310dadf99bad" id="r_ga973666b5824d13483f36310dadf99bad"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> </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>
- <tr class="separator:ga973666b5824d13483f36310dadf99bad"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga23fce69b73939342cb663727a8245a44" id="r_ga23fce69b73939342cb663727a8245a44"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> </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>
- <tr class="separator:ga23fce69b73939342cb663727a8245a44"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga5847132aebd5f54c591c31a1b7f90eee" id="r_ga5847132aebd5f54c591c31a1b7f90eee"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> </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>
- <tr class="separator:ga5847132aebd5f54c591c31a1b7f90eee"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:gaedf4bedf64959ce0f0b230040aa09cd4" id="r_gaedf4bedf64959ce0f0b230040aa09cd4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> </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>
- <tr class="separator:gaedf4bedf64959ce0f0b230040aa09cd4"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga4b8887d71b6b95a9f635f8987cdb0952" id="r_ga4b8887d71b6b95a9f635f8987cdb0952"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> </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>
- <tr class="separator:ga4b8887d71b6b95a9f635f8987cdb0952"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:gab185b60e3234931f9bf06bd59715a200" id="r_gab185b60e3234931f9bf06bd59715a200"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> </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>
- <tr class="separator:gab185b60e3234931f9bf06bd59715a200"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga60e46b61bd6947f9c2d08c0430270bfe" id="r_ga60e46b61bd6947f9c2d08c0430270bfe"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> </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>
- <tr class="separator:ga60e46b61bd6947f9c2d08c0430270bfe"><td class="memSeparator" colspan="2"> </td></tr>
- </table>
- <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
- <h2 class="groupheader">Function Documentation</h2>
- <a id="ga6ecb30bbf007e18418773cb98c324303" name="ga6ecb30bbf007e18418773cb98c324303"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ga6ecb30bbf007e18418773cb98c324303">◆ </a></span>Vector2Abs()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> Vector2Abs </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="group__TorqueScriptTypes.html#ga9e94493e2a334dee294c516b9479f52b">Vector2</a> </td>
- <td class="paramname"><em>v1</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"><a class="el" href="group__TorqueScriptTypes.html#ga9e94493e2a334dee294c516b9479f52b">Vector2</a> </td>
- <td class="paramname"><em>v2</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Absolute difference of two 2-vectors </p><dl class="section return"><dt>Returns</dt><dd>abs(v1-v2)</dd></dl>
- <dl class="section user"><dt>See Engine Function/Method</dt><dd>Vector2::absolute </dd></dl>
- </div>
- </div>
- <a id="ga2f0bbc1896677584f4f26183a957ce33" name="ga2f0bbc1896677584f4f26183a957ce33"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ga2f0bbc1896677584f4f26183a957ce33">◆ </a></span>Vector2Add()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> Vector2Add </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="group__TorqueScriptTypes.html#ga9e94493e2a334dee294c516b9479f52b">Vector2</a> </td>
- <td class="paramname"><em>v1</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"><a class="el" href="group__TorqueScriptTypes.html#ga9e94493e2a334dee294c516b9479f52b">Vector2</a> </td>
- <td class="paramname"><em>v2</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Add two 2-vectors. </p><dl class="section return"><dt>Returns</dt><dd>v1+v2</dd></dl>
- <dl class="section user"><dt>See Engine Function/Method</dt><dd>Vector2::operator+ </dd></dl>
- </div>
- </div>
- <a id="ga88da5f5c71ac32e6f507da999b3f90e8" name="ga88da5f5c71ac32e6f507da999b3f90e8"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ga88da5f5c71ac32e6f507da999b3f90e8">◆ </a></span>Vector2AngleBetween()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> Vector2AngleBetween </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="group__TorqueScriptTypes.html#ga9e94493e2a334dee294c516b9479f52b">Vector2</a> </td>
- <td class="paramname"><em>v1</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"><a class="el" href="group__TorqueScriptTypes.html#ga9e94493e2a334dee294c516b9479f52b">Vector2</a> </td>
- <td class="paramname"><em>v2</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Angle between two 2D vectors. </p><dl class="section return"><dt>Returns</dt><dd>the angle between v1 and v2. </dd></dl>
- </div>
- </div>
- <a id="gae0a4dc209ed4d562c02e4237e718c998" name="gae0a4dc209ed4d562c02e4237e718c998"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#gae0a4dc209ed4d562c02e4237e718c998">◆ </a></span>Vector2AngleToPoint()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> Vector2AngleToPoint </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="group__TorqueScriptTypes.html#ga9e94493e2a334dee294c516b9479f52b">Vector2</a> </td>
- <td class="paramname"><em>p1</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"><a class="el" href="group__TorqueScriptTypes.html#ga9e94493e2a334dee294c516b9479f52b">Vector2</a> </td>
- <td class="paramname"><em>p2</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Angle from one point to another. </p><dl class="section return"><dt>Returns</dt><dd>the angle from p1 to p2. </dd></dl>
- </div>
- </div>
- <a id="ga27b93cf688a4b8dd6a5456dcd4fc700f" name="ga27b93cf688a4b8dd6a5456dcd4fc700f"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ga27b93cf688a4b8dd6a5456dcd4fc700f">◆ </a></span>Vector2AreaNormalize()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> Vector2AreaNormalize </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="group__TorqueScriptTypes.html#ga9e94493e2a334dee294c516b9479f52b">Vector2</a> </td>
- <td class="paramname"><em>v1</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"><a class="el" href="group__TorqueScriptTypes.html#ga9e94493e2a334dee294c516b9479f52b">Vector2</a> </td>
- <td class="paramname"><em>v2</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <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>
- </div>
- </div>
- <a id="ga30301fc4bab47cf920382bac80090182" name="ga30301fc4bab47cf920382bac80090182"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ga30301fc4bab47cf920382bac80090182">◆ </a></span>Vector2Compare()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> Vector2Compare </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="group__TorqueScriptTypes.html#ga9e94493e2a334dee294c516b9479f52b">Vector2</a> </td>
- <td class="paramname"><em>p1</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"><a class="el" href="group__TorqueScriptTypes.html#ga9e94493e2a334dee294c516b9479f52b">Vector2</a> </td>
- <td class="paramname"><em>p2</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">[Vector2 epsilon=0.0001] ? </td>
- <td class="paramname"> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <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>
- </div>
- </div>
- <a id="gab9990f0302735e67f005d981d794aa8c" name="gab9990f0302735e67f005d981d794aa8c"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#gab9990f0302735e67f005d981d794aa8c">◆ </a></span>Vector2Direction()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> 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">
- <p>vector from angle and magnitude. Calculates a direction from an angle and magnitude. </p><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>
- </div>
- </div>
- <a id="ga0f5078c1de0b26e8188ef94025ec12e2" name="ga0f5078c1de0b26e8188ef94025ec12e2"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ga0f5078c1de0b26e8188ef94025ec12e2">◆ </a></span>Vector2Distance()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> Vector2Distance </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="group__TorqueScriptTypes.html#ga9e94493e2a334dee294c516b9479f52b">Vector2</a> </td>
- <td class="paramname"><em>p1</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"><a class="el" href="group__TorqueScriptTypes.html#ga9e94493e2a334dee294c516b9479f52b">Vector2</a> </td>
- <td class="paramname"><em>p2</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Distance between two 2D Points. </p><dl class="section return"><dt>Returns</dt><dd>the distance between points p1 and p2 </dd></dl>
- </div>
- </div>
- <a id="gadab2b3ad1c05161add7da0f933d348ff" name="gadab2b3ad1c05161add7da0f933d348ff"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#gadab2b3ad1c05161add7da0f933d348ff">◆ </a></span>Vector2Dot()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> Vector2Dot </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="group__TorqueScriptTypes.html#ga9e94493e2a334dee294c516b9479f52b">Vector2</a> </td>
- <td class="paramname"><em>v1</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"><a class="el" href="group__TorqueScriptTypes.html#ga9e94493e2a334dee294c516b9479f52b">Vector2</a> </td>
- <td class="paramname"><em>v2</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Dot-Product of two 2D vectors. </p><dl class="section return"><dt>Returns</dt><dd>dot-product of v1 and v2.</dd></dl>
- <dl class="section user"><dt>See Engine Function/Method</dt><dd>Vector2::dot </dd></dl>
- </div>
- </div>
- <a id="ga453ede6d126208a3d17362535ecb5fc5" name="ga453ede6d126208a3d17362535ecb5fc5"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ga453ede6d126208a3d17362535ecb5fc5">◆ </a></span>Vector2Inverse()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> Vector2Inverse </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="group__TorqueScriptTypes.html#ga9e94493e2a334dee294c516b9479f52b">Vector2</a> </td>
- <td class="paramname"><em>v1</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Inverse of a 2D vector. </p><dl class="section return"><dt>Returns</dt><dd>the inverse of v1.</dd></dl>
- <dl class="section user"><dt>See Engine Function/Method</dt><dd>Vector2::operator-() </dd></dl>
- </div>
- </div>
- <a id="ga973666b5824d13483f36310dadf99bad" name="ga973666b5824d13483f36310dadf99bad"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ga973666b5824d13483f36310dadf99bad">◆ </a></span>Vector2InverseX()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> Vector2InverseX </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="group__TorqueScriptTypes.html#ga9e94493e2a334dee294c516b9479f52b">Vector2</a> </td>
- <td class="paramname"><em>v1</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <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>
- </div>
- </div>
- <a id="ga23fce69b73939342cb663727a8245a44" name="ga23fce69b73939342cb663727a8245a44"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ga23fce69b73939342cb663727a8245a44">◆ </a></span>Vector2InverseY()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> Vector2InverseY </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="group__TorqueScriptTypes.html#ga9e94493e2a334dee294c516b9479f52b">Vector2</a> </td>
- <td class="paramname"><em>v1</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <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>
- </div>
- </div>
- <a id="ga5847132aebd5f54c591c31a1b7f90eee" name="ga5847132aebd5f54c591c31a1b7f90eee"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ga5847132aebd5f54c591c31a1b7f90eee">◆ </a></span>Vector2Length()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> Vector2Length </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="group__TorqueScriptTypes.html#ga9e94493e2a334dee294c516b9479f52b">Vector2</a> </td>
- <td class="paramname"><em>v1</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Length of a 2D vector. </p><dl class="section return"><dt>Returns</dt><dd>the length of v1.</dd></dl>
- <dl class="section user"><dt>See Engine Function/Method</dt><dd>Vector2::Length </dd></dl>
- </div>
- </div>
- <a id="gaedf4bedf64959ce0f0b230040aa09cd4" name="gaedf4bedf64959ce0f0b230040aa09cd4"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#gaedf4bedf64959ce0f0b230040aa09cd4">◆ </a></span>Vector2Mult()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> Vector2Mult </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="group__TorqueScriptTypes.html#ga9e94493e2a334dee294c516b9479f52b">Vector2</a> </td>
- <td class="paramname"><em>v1</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"><a class="el" href="group__TorqueScriptTypes.html#ga9e94493e2a334dee294c516b9479f52b">Vector2</a> </td>
- <td class="paramname"><em>v2</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Multiply two 2D vectors (Not Dot-Product!) </p><dl class="section return"><dt>Returns</dt><dd>v1 mult v2. </dd></dl>
- </div>
- </div>
- <a id="ga4b8887d71b6b95a9f635f8987cdb0952" name="ga4b8887d71b6b95a9f635f8987cdb0952"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ga4b8887d71b6b95a9f635f8987cdb0952">◆ </a></span>Vector2Normalize()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> Vector2Normalize </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="group__TorqueScriptTypes.html#ga9e94493e2a334dee294c516b9479f52b">Vector2</a> </td>
- <td class="paramname"><em>v1</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Normalize a 2D vector. </p><dl class="section return"><dt>Returns</dt><dd>Normalized v1.</dd></dl>
- <dl class="section user"><dt>See Engine Function/Method</dt><dd>Vector2::Normalize </dd></dl>
- </div>
- </div>
- <a id="gab185b60e3234931f9bf06bd59715a200" name="gab185b60e3234931f9bf06bd59715a200"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#gab185b60e3234931f9bf06bd59715a200">◆ </a></span>Vector2Scale()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> Vector2Scale </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="group__TorqueScriptTypes.html#ga9e94493e2a334dee294c516b9479f52b">Vector2</a> </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">
- <p>Scale a 2D vector. </p><dl class="section return"><dt>Returns</dt><dd>v1 scaled by scale.</dd></dl>
- <dl class="section user"><dt>See Engine Function/Method</dt><dd>Vector2::operator* </dd></dl>
- </div>
- </div>
- <a id="ga60e46b61bd6947f9c2d08c0430270bfe" name="ga60e46b61bd6947f9c2d08c0430270bfe"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ga60e46b61bd6947f9c2d08c0430270bfe">◆ </a></span>Vector2Sub()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> Vector2Sub </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="group__TorqueScriptTypes.html#ga9e94493e2a334dee294c516b9479f52b">Vector2</a> </td>
- <td class="paramname"><em>v1</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"><a class="el" href="group__TorqueScriptTypes.html#ga9e94493e2a334dee294c516b9479f52b">Vector2</a> </td>
- <td class="paramname"><em>v2</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Subtract two 2D vectors. </p><dl class="section return"><dt>Returns</dt><dd>v1-v2</dd></dl>
- <dl class="section user"><dt>See Engine Function/Method</dt><dd>Vector2::operator-(Vector2) </dd></dl>
- </div>
- </div>
- </div><!-- contents -->
- <!-- start footer part -->
- <hr class="footer"/><address class="footer"><small>
- Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
- </small></address>
- </body>
- </html>
|