| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857 |
- <!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"/>
- <meta http-equiv="X-UA-Compatible" content="IE=9"/>
- <meta name="generator" content="Doxygen 1.8.3.1"/>
- <title>TorqueScript Reference: Math (Non-Vector)</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 style="height: 56px;">
- <td style="padding-left: 0.5em;">
- <div id="projectname">TorqueScript Reference
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <!-- end header part -->
- <!-- Generated by Doxygen 1.8.3.1 -->
- <div id="navrow1" class="tabs">
- <ul class="tablist">
- <li><a href="index.html"><span>Main Page</span></a></li>
- <li><a href="pages.html"><span>Related Pages</span></a></li>
- <li><a href="modules.html"><span>Modules</span></a></li>
- <li><a href="annotated.html"><span>Classes</span></a></li>
- </ul>
- </div>
- </div><!-- top -->
- <div class="header">
- <div class="summary">
- <a href="#func-members">Functions</a> </div>
- <div class="headertitle">
- <div class="title">Math (Non-Vector)<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 name="func-members"></a>
- Functions</h2></td></tr>
- <tr class="memitem:gad90644459f01e3f3a33c139aaeeb91fe"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__MathFunctions.html#gad90644459f01e3f3a33c139aaeeb91fe">addBitToMask</a> (mask, <a class="el" href="group__MathFunctions.html#gab41cbb5c202a8e0410bc11004ddb9442">bit</a>)</td></tr>
- <tr class="separator:gad90644459f01e3f3a33c139aaeeb91fe"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:gab41cbb5c202a8e0410bc11004ddb9442"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="group__MathFunctions.html#gab41cbb5c202a8e0410bc11004ddb9442">bit</a> ()</td></tr>
- <tr class="separator:gab41cbb5c202a8e0410bc11004ddb9442"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga14fc5e2305e82f4cd371a94b796ece21"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="group__MathFunctions.html#ga14fc5e2305e82f4cd371a94b796ece21">bitInverse</a> ()</td></tr>
- <tr class="separator:ga14fc5e2305e82f4cd371a94b796ece21"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:gaa6fe8dd852c9f234a3d95f1acf02f891"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="group__MathFunctions.html#gaa6fe8dd852c9f234a3d95f1acf02f891">bits</a> ()</td></tr>
- <tr class="separator:gaa6fe8dd852c9f234a3d95f1acf02f891"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga13467ba4765acdac6390a570c210fce2"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="group__MathFunctions.html#ga13467ba4765acdac6390a570c210fce2">mAbs</a> (val)</td></tr>
- <tr class="separator:ga13467ba4765acdac6390a570c210fce2"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:gab6c861dd35670c656e8632f2d824c836"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="group__MathFunctions.html#gab6c861dd35670c656e8632f2d824c836">mAcos</a> (val)</td></tr>
- <tr class="separator:gab6c861dd35670c656e8632f2d824c836"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga1898e8164aadb87482bba0b191a3bd2f"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="group__MathFunctions.html#ga1898e8164aadb87482bba0b191a3bd2f">mAsin</a> (val)</td></tr>
- <tr class="separator:ga1898e8164aadb87482bba0b191a3bd2f"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga729168c83e87ef33afcacdd06e9db0b6"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="group__MathFunctions.html#ga729168c83e87ef33afcacdd06e9db0b6">mAtan</a> (val)</td></tr>
- <tr class="separator:ga729168c83e87ef33afcacdd06e9db0b6"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga24ff0eae16204f349ac529b1c0a1b007"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__MathFunctions.html#ga24ff0eae16204f349ac529b1c0a1b007">mCeil</a> (val)</td></tr>
- <tr class="separator:ga24ff0eae16204f349ac529b1c0a1b007"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:gaef620e14ca73b683aba235a638b2fbb3"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="group__MathFunctions.html#gaef620e14ca73b683aba235a638b2fbb3">mClamp</a> (float number, float min, float max)</td></tr>
- <tr class="separator:gaef620e14ca73b683aba235a638b2fbb3"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga60925cab04cc33ffe6768621450aed26"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="group__MathFunctions.html#ga60925cab04cc33ffe6768621450aed26">mCos</a> (val)</td></tr>
- <tr class="separator:ga60925cab04cc33ffe6768621450aed26"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:gac73a3322299c719be204d817230489aa"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="group__MathFunctions.html#gac73a3322299c719be204d817230489aa">mDegToRad</a> (val)</td></tr>
- <tr class="separator:gac73a3322299c719be204d817230489aa"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:gac2d0303498d68ec1e66ee403b2309bd4"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="group__MathFunctions.html#gac2d0303498d68ec1e66ee403b2309bd4">mFloatLength</a> (val, numDecimals)</td></tr>
- <tr class="separator:gac2d0303498d68ec1e66ee403b2309bd4"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:gabed237c81469b0feba099dcfa22de0c3"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__MathFunctions.html#gabed237c81469b0feba099dcfa22de0c3">mFloor</a> (val)</td></tr>
- <tr class="separator:gabed237c81469b0feba099dcfa22de0c3"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga117d6fa6302020924fe5e65f5be83830"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="group__MathFunctions.html#ga117d6fa6302020924fe5e65f5be83830">mGetMax</a> (a, b)</td></tr>
- <tr class="separator:ga117d6fa6302020924fe5e65f5be83830"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga602231d16d4f9c8eaba8b8846ea09f3f"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="group__MathFunctions.html#ga602231d16d4f9c8eaba8b8846ea09f3f">mGetMin</a> (a, b)</td></tr>
- <tr class="separator:ga602231d16d4f9c8eaba8b8846ea09f3f"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:gae229f9e50c90a865ed465fa23dffed75"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="group__MathFunctions.html#gae229f9e50c90a865ed465fa23dffed75">mLog</a> (val)</td></tr>
- <tr class="separator:gae229f9e50c90a865ed465fa23dffed75"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga9fab93f0b2fb82b4cb7a10b0ad0fe788"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="group__MathFunctions.html#ga9fab93f0b2fb82b4cb7a10b0ad0fe788">mPow</a> (val, power)</td></tr>
- <tr class="separator:ga9fab93f0b2fb82b4cb7a10b0ad0fe788"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:gad366eddd7ad2d77bfd9838d3951a6ebc"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="group__MathFunctions.html#gad366eddd7ad2d77bfd9838d3951a6ebc">mRadToDeg</a> (val)</td></tr>
- <tr class="separator:gad366eddd7ad2d77bfd9838d3951a6ebc"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga4480fde17dcb0ca088770789f4c8bf65"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="group__MathFunctions.html#ga4480fde17dcb0ca088770789f4c8bf65">mRound</a> (float v)</td></tr>
- <tr class="separator:ga4480fde17dcb0ca088770789f4c8bf65"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga87eba52c49dead41330be339d3ff21fe"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="group__MathFunctions.html#ga87eba52c49dead41330be339d3ff21fe">mSin</a> (val)</td></tr>
- <tr class="separator:ga87eba52c49dead41330be339d3ff21fe"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga45d08fe7cc09a7b3df5bdbc73ece2d18"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="group__MathFunctions.html#ga45d08fe7cc09a7b3df5bdbc73ece2d18">mSolveCubic</a> (float a, float b, float c, float d)</td></tr>
- <tr class="separator:ga45d08fe7cc09a7b3df5bdbc73ece2d18"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga9c1efea8e988c6fa5c4ea35da797132e"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="group__MathFunctions.html#ga9c1efea8e988c6fa5c4ea35da797132e">mSolveQuadratic</a> (float a, float b, float c)</td></tr>
- <tr class="separator:ga9c1efea8e988c6fa5c4ea35da797132e"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga1ca6ff16aa75ebcb4273a06909630cec"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="group__MathFunctions.html#ga1ca6ff16aa75ebcb4273a06909630cec">mSolveQuartic</a> (float a, float b, float c, float d, float e)</td></tr>
- <tr class="separator:ga1ca6ff16aa75ebcb4273a06909630cec"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:gaf8400080e9157341bd02ccb0d36540f5"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="group__MathFunctions.html#gaf8400080e9157341bd02ccb0d36540f5">mSqrt</a> (val)</td></tr>
- <tr class="separator:gaf8400080e9157341bd02ccb0d36540f5"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:gad4c06a2ea2500f717543ac282d9fba99"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="group__MathFunctions.html#gad4c06a2ea2500f717543ac282d9fba99">mTan</a> (val)</td></tr>
- <tr class="separator:gad4c06a2ea2500f717543ac282d9fba99"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:gadd1a0a9f9451423d99508fe8e4985df0"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__MathFunctions.html#gadd1a0a9f9451423d99508fe8e4985df0">removeBitFromMask</a> (mask, <a class="el" href="group__MathFunctions.html#gab41cbb5c202a8e0410bc11004ddb9442">bit</a>)</td></tr>
- <tr class="separator:gadd1a0a9f9451423d99508fe8e4985df0"><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 class="anchor" id="gad90644459f01e3f3a33c139aaeeb91fe"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">int addBitToMask </td>
- <td>(</td>
- <td class="paramtype">mask </td>
- <td class="paramname">, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"><a class="el" href="group__MathFunctions.html#gab41cbb5c202a8e0410bc11004ddb9442">bit</a> </td>
- <td class="paramname"> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Returns the mask with a bit added to it </p>
- </div>
- </div>
- <a class="anchor" id="gab41cbb5c202a8e0410bc11004ddb9442"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">string bit </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Converts a bit-position into a value. </p>
- </div>
- </div>
- <a class="anchor" id="ga14fc5e2305e82f4cd371a94b796ece21"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">string bitInverse </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Returns the ones complement of a bit. </p>
- </div>
- </div>
- <a class="anchor" id="gaa6fe8dd852c9f234a3d95f1acf02f891"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">string bits </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Converts a list of bit-positions into a value. </p>
- </div>
- </div>
- <a class="anchor" id="ga13467ba4765acdac6390a570c210fce2"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">float mAbs </td>
- <td>(</td>
- <td class="paramtype">val </td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Use the mAbs function to get the magnitude of val. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">val</td><td>An integer or a floating-point value. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>Returns the magnitude of val </dd></dl>
- </div>
- </div>
- <a class="anchor" id="gab6c861dd35670c656e8632f2d824c836"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">float mAcos </td>
- <td>(</td>
- <td class="paramtype">val </td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Use the mAcos function to get the inverse cosine of val in radians. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">val</td><td>A value between -1.0 and 1.0 equal to the cosine of some angle theta. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>Returns the inverse cosine of val in radians. This value will be in the range [ 0 , 3.14159 ]. </dd></dl>
- <dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__MathFunctions.html#ga60925cab04cc33ffe6768621450aed26">mCos</a> </dd></dl>
- <p>Referenced by <a class="el" href="group__Vector2Math.html#gab4ad61aa083dccd62b61b80c5b5f4c3b">Vector2AngleBetween()</a>.</p>
- </div>
- </div>
- <a class="anchor" id="ga1898e8164aadb87482bba0b191a3bd2f"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">float mAsin </td>
- <td>(</td>
- <td class="paramtype">val </td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Use the mAsin function to get the inverse sine of val in radians. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">val</td><td>A value between -1.0 and 1.0 equal to the sine of some angle theta. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>Returns the inverse sine of val in radians. This value will be in the range [ - 3.14159/2 , 3.14159/2 ]. </dd></dl>
- <dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__MathFunctions.html#ga87eba52c49dead41330be339d3ff21fe">mSin</a> </dd></dl>
- </div>
- </div>
- <a class="anchor" id="ga729168c83e87ef33afcacdd06e9db0b6"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">float mAtan </td>
- <td>(</td>
- <td class="paramtype">val </td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Use the mAtan function to get the inverse tangent of rise/run in radians. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">rise</td><td>Vertical component of a line. </td></tr>
- <tr><td class="paramname">run</td><td>Horizontal component of a line. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>Returns the slope in radians (the arc-tangent) of a line with the given rise and run. </dd></dl>
- <dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__MathFunctions.html#gad4c06a2ea2500f717543ac282d9fba99">mTan</a> </dd></dl>
- <p>Referenced by <a class="el" href="group__Vector2Math.html#gad22c735f793d613af07dd6ceffc7e6a5">Vector2AngleToPoint()</a>.</p>
- </div>
- </div>
- <a class="anchor" id="ga24ff0eae16204f349ac529b1c0a1b007"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">int mCeil </td>
- <td>(</td>
- <td class="paramtype">val </td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Use the mCeil function to calculate the next highest integer value from val. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">val</td><td>A floating-point value. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>Returns an integer representing the next highest integer from val. </dd></dl>
- <dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__MathFunctions.html#gabed237c81469b0feba099dcfa22de0c3">mFloor</a> </dd></dl>
- </div>
- </div>
- <a class="anchor" id="gaef620e14ca73b683aba235a638b2fbb3"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">float mClamp </td>
- <td>(</td>
- <td class="paramtype">float </td>
- <td class="paramname"><em>number</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">float </td>
- <td class="paramname"><em>min</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">float </td>
- <td class="paramname"><em>max</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Clamp a value between two other values. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">number</td><td>A float value representing the number to clamp </td></tr>
- <tr><td class="paramname">min</td><td>The lower bound </td></tr>
- <tr><td class="paramname">max</td><td>The upper bound </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>A float value the is within the given range </dd></dl>
- </div>
- </div>
- <a class="anchor" id="ga60925cab04cc33ffe6768621450aed26"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">float mCos </td>
- <td>(</td>
- <td class="paramtype">val </td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Use the mCos function to get the cosine of the radian angle val. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">val</td><td>A value between -3.14159 and 3.14159. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>Returns the cosine of val. This value will be in the range [ -1.0 , 1.0 ]. </dd></dl>
- <dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__MathFunctions.html#gab6c861dd35670c656e8632f2d824c836">mAcos</a> </dd></dl>
- </div>
- </div>
- <a class="anchor" id="gac73a3322299c719be204d817230489aa"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">float mDegToRad </td>
- <td>(</td>
- <td class="paramtype">val </td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Use the mDegToRad function to convert degrees to radians. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">val</td><td>A floating-point number representing some number of degrees. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>Returns the equivalent of the degree value val in radians. </dd></dl>
- <dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__MathFunctions.html#gad366eddd7ad2d77bfd9838d3951a6ebc">mRadToDeg</a> </dd></dl>
- <p>Referenced by <a class="el" href="group__Vector2Math.html#ga8bfafe540a1c2d58457fca7898dc340f">Vector2Direction()</a>.</p>
- </div>
- </div>
- <a class="anchor" id="gac2d0303498d68ec1e66ee403b2309bd4"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">string mFloatLength </td>
- <td>(</td>
- <td class="paramtype">val </td>
- <td class="paramname">, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">numDecimals </td>
- <td class="paramname"> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Use the mFloatLength function to limit the number of decimal places in val to numDecimals. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">val</td><td>A floating-point value. </td></tr>
- <tr><td class="paramname">numDecimals</td><td>An integer between 0 and inf representing the number of decimal places to allow val to have. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>Returns a floating-point value equivalent to a truncated version of val, where the new version has numDecimals decimal places </dd></dl>
- </div>
- </div>
- <a class="anchor" id="gabed237c81469b0feba099dcfa22de0c3"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">int mFloor </td>
- <td>(</td>
- <td class="paramtype">val </td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Use the mFloor function to calculate the next lowest integer value from val. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">val</td><td>A floating-point value. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>Returns an integer representing the next lowest integer from val. </dd></dl>
- <dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__MathFunctions.html#ga24ff0eae16204f349ac529b1c0a1b007">mCeil</a> </dd></dl>
- </div>
- </div>
- <a class="anchor" id="ga117d6fa6302020924fe5e65f5be83830"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">float mGetMax </td>
- <td>(</td>
- <td class="paramtype">a </td>
- <td class="paramname">, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">b </td>
- <td class="paramname"> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Returns the Maximum of two values. </p>
- </div>
- </div>
- <a class="anchor" id="ga602231d16d4f9c8eaba8b8846ea09f3f"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">float mGetMin </td>
- <td>(</td>
- <td class="paramtype">a </td>
- <td class="paramname">, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">b </td>
- <td class="paramname"> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Returns the Minimum of two values. </p>
- </div>
- </div>
- <a class="anchor" id="gae229f9e50c90a865ed465fa23dffed75"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">float mLog </td>
- <td>(</td>
- <td class="paramtype">val </td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Use the mLog function to calculate the natural logarithm of val. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">val</td><td>A numeric value. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>Returns the natural logarithm of val </dd></dl>
- </div>
- </div>
- <a class="anchor" id="ga9fab93f0b2fb82b4cb7a10b0ad0fe788"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">float mPow </td>
- <td>(</td>
- <td class="paramtype">val </td>
- <td class="paramname">, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">power </td>
- <td class="paramname"> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Use the mPow function to calculated val raised to the power of power. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">val</td><td>A numeric (integer or floating-point) value to be raised to a power. </td></tr>
- <tr><td class="paramname">power</td><td>A numeric (integer or floating-point) power to raise val to. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>Returns val^power </dd></dl>
- </div>
- </div>
- <a class="anchor" id="gad366eddd7ad2d77bfd9838d3951a6ebc"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">float mRadToDeg </td>
- <td>(</td>
- <td class="paramtype">val </td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Use the mRadToDeg function to convert radians to degrees. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">val</td><td>A floating-point number representing some number of radians. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>Returns the equivalent of the radian value val in degrees. </dd></dl>
- <dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__MathFunctions.html#gac73a3322299c719be204d817230489aa">mDegToRad</a> </dd></dl>
- <p>Referenced by <a class="el" href="group__Vector2Math.html#gab4ad61aa083dccd62b61b80c5b5f4c3b">Vector2AngleBetween()</a>, and <a class="el" href="group__Vector2Math.html#gad22c735f793d613af07dd6ceffc7e6a5">Vector2AngleToPoint()</a>.</p>
- </div>
- </div>
- <a class="anchor" id="ga4480fde17dcb0ca088770789f4c8bf65"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">float mRound </td>
- <td>(</td>
- <td class="paramtype">float </td>
- <td class="paramname"><em>v</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Rounds a number. 0.5 is rounded up. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">val</td><td>A floating-point value </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>Returns the integer value closest to the given float </dd></dl>
- </div>
- </div>
- <a class="anchor" id="ga87eba52c49dead41330be339d3ff21fe"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">float mSin </td>
- <td>(</td>
- <td class="paramtype">val </td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Use the mSin function to get the sine of the radian angle val. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">val</td><td>A value between -3.14159 and 3.14159. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>Returns the sine of val. This value will be in the range [ -1.0 , 1.0 ]. </dd></dl>
- <dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__MathFunctions.html#ga1898e8164aadb87482bba0b191a3bd2f">mAsin</a> </dd></dl>
- </div>
- </div>
- <a class="anchor" id="ga45d08fe7cc09a7b3df5bdbc73ece2d18"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">string mSolveCubic </td>
- <td>(</td>
- <td class="paramtype">float </td>
- <td class="paramname"><em>a</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">float </td>
- <td class="paramname"><em>b</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">float </td>
- <td class="paramname"><em>c</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">float </td>
- <td class="paramname"><em>d</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Solve a cubic equation of form a*x^3 + b*x^2 + c*x + d = 0. </p>
- <dl class="section return"><dt>Returns</dt><dd>A 4-tuple, contanining: sol x0 x1 x2. sol is the number of solutions (being 0, 1, 2, or 3), and x0, x1, x2 are the solutions, if any. Unused x's are undefined. </dd></dl>
- </div>
- </div>
- <a class="anchor" id="ga9c1efea8e988c6fa5c4ea35da797132e"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">string mSolveQuadratic </td>
- <td>(</td>
- <td class="paramtype">float </td>
- <td class="paramname"><em>a</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">float </td>
- <td class="paramname"><em>b</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">float </td>
- <td class="paramname"><em>c</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Solve a quadratic equation of form a*x^2 + b*x + c = 0. </p>
- <dl class="section return"><dt>Returns</dt><dd>A triple, contanining: sol x0 x1. sol is the number of solutions (being 0, 1, or 2), and x0 and x1 are the solutions, if any. Unused x's are undefined. </dd></dl>
- </div>
- </div>
- <a class="anchor" id="ga1ca6ff16aa75ebcb4273a06909630cec"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">string mSolveQuartic </td>
- <td>(</td>
- <td class="paramtype">float </td>
- <td class="paramname"><em>a</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">float </td>
- <td class="paramname"><em>b</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">float </td>
- <td class="paramname"><em>c</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">float </td>
- <td class="paramname"><em>d</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">float </td>
- <td class="paramname"><em>e</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Solve a quartic equation of form a*x^4 + b*x^3 + c*x^2 + d*x + e = 0. </p>
- <dl class="section return"><dt>Returns</dt><dd>A 5-tuple, contanining: sol x0 x1 x2 x3. sol is the number of solutions (ranging from 0-4), and x0, x1, x2 and x3 are the solutions, if any. Unused x's are undefined. </dd></dl>
- </div>
- </div>
- <a class="anchor" id="gaf8400080e9157341bd02ccb0d36540f5"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">float mSqrt </td>
- <td>(</td>
- <td class="paramtype">val </td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Use the mSqrt function to calculated the square root of val. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">val</td><td>A numeric value. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>Returns the the squareroot of val </dd></dl>
- </div>
- </div>
- <a class="anchor" id="gad4c06a2ea2500f717543ac282d9fba99"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">float mTan </td>
- <td>(</td>
- <td class="paramtype">val </td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Use the mTan function to get the tangent of the radian angle val. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">val</td><td>A value between -3.14159/2 and 3.14159/2. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>Returns the tangent of val. This value will be in the range [ -inf.0 , inf.0 ]. </dd></dl>
- <dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__MathFunctions.html#ga729168c83e87ef33afcacdd06e9db0b6">mAtan</a> </dd></dl>
- </div>
- </div>
- <a class="anchor" id="gadd1a0a9f9451423d99508fe8e4985df0"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">int removeBitFromMask </td>
- <td>(</td>
- <td class="paramtype">mask </td>
- <td class="paramname">, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"><a class="el" href="group__MathFunctions.html#gab41cbb5c202a8e0410bc11004ddb9442">bit</a> </td>
- <td class="paramname"> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Returns the mask with a bit removed from it </p>
- </div>
- </div>
- </div><!-- contents -->
- <!-- start footer part -->
- <hr class="footer"/><address class="footer"><small>
- Generated by  <a href="http://www.doxygen.org/index.html">
- <img class="footer" src="doxygen.png" alt="doxygen"/>
- </a> 1.8.3.1
- </small></address>
- </body>
- </html>
|