group__MathFunctions.html 37 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857
  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: Math (Non-Vector)</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. <link href="t2d-stylesheet-extra.css" rel="stylesheet" type="text/css"/>
  13. </head>
  14. <body>
  15. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  16. <div id="titlearea">
  17. <table cellspacing="0" cellpadding="0">
  18. <tbody>
  19. <tr style="height: 56px;">
  20. <td style="padding-left: 0.5em;">
  21. <div id="projectname">TorqueScript Reference
  22. </div>
  23. </td>
  24. </tr>
  25. </tbody>
  26. </table>
  27. </div>
  28. <!-- end header part -->
  29. <!-- Generated by Doxygen 1.8.3.1 -->
  30. <div id="navrow1" class="tabs">
  31. <ul class="tablist">
  32. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  33. <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
  34. <li><a href="modules.html"><span>Modules</span></a></li>
  35. <li><a href="annotated.html"><span>Classes</span></a></li>
  36. </ul>
  37. </div>
  38. </div><!-- top -->
  39. <div class="header">
  40. <div class="summary">
  41. <a href="#func-members">Functions</a> </div>
  42. <div class="headertitle">
  43. <div class="title">Math (Non-Vector)<div class="ingroups"><a class="el" href="group__TorqueScriptFunctions.html">Function Categories</a></div></div> </div>
  44. </div><!--header-->
  45. <div class="contents">
  46. <table class="memberdecls">
  47. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  48. Functions</h2></td></tr>
  49. <tr class="memitem:gad90644459f01e3f3a33c139aaeeb91fe"><td class="memItemLeft" align="right" valign="top">int&#160;</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>
  50. <tr class="separator:gad90644459f01e3f3a33c139aaeeb91fe"><td class="memSeparator" colspan="2">&#160;</td></tr>
  51. <tr class="memitem:gab41cbb5c202a8e0410bc11004ddb9442"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__MathFunctions.html#gab41cbb5c202a8e0410bc11004ddb9442">bit</a> ()</td></tr>
  52. <tr class="separator:gab41cbb5c202a8e0410bc11004ddb9442"><td class="memSeparator" colspan="2">&#160;</td></tr>
  53. <tr class="memitem:ga14fc5e2305e82f4cd371a94b796ece21"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__MathFunctions.html#ga14fc5e2305e82f4cd371a94b796ece21">bitInverse</a> ()</td></tr>
  54. <tr class="separator:ga14fc5e2305e82f4cd371a94b796ece21"><td class="memSeparator" colspan="2">&#160;</td></tr>
  55. <tr class="memitem:gaa6fe8dd852c9f234a3d95f1acf02f891"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__MathFunctions.html#gaa6fe8dd852c9f234a3d95f1acf02f891">bits</a> ()</td></tr>
  56. <tr class="separator:gaa6fe8dd852c9f234a3d95f1acf02f891"><td class="memSeparator" colspan="2">&#160;</td></tr>
  57. <tr class="memitem:ga13467ba4765acdac6390a570c210fce2"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__MathFunctions.html#ga13467ba4765acdac6390a570c210fce2">mAbs</a> (val)</td></tr>
  58. <tr class="separator:ga13467ba4765acdac6390a570c210fce2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  59. <tr class="memitem:gab6c861dd35670c656e8632f2d824c836"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__MathFunctions.html#gab6c861dd35670c656e8632f2d824c836">mAcos</a> (val)</td></tr>
  60. <tr class="separator:gab6c861dd35670c656e8632f2d824c836"><td class="memSeparator" colspan="2">&#160;</td></tr>
  61. <tr class="memitem:ga1898e8164aadb87482bba0b191a3bd2f"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__MathFunctions.html#ga1898e8164aadb87482bba0b191a3bd2f">mAsin</a> (val)</td></tr>
  62. <tr class="separator:ga1898e8164aadb87482bba0b191a3bd2f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  63. <tr class="memitem:ga729168c83e87ef33afcacdd06e9db0b6"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__MathFunctions.html#ga729168c83e87ef33afcacdd06e9db0b6">mAtan</a> (val)</td></tr>
  64. <tr class="separator:ga729168c83e87ef33afcacdd06e9db0b6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  65. <tr class="memitem:ga24ff0eae16204f349ac529b1c0a1b007"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__MathFunctions.html#ga24ff0eae16204f349ac529b1c0a1b007">mCeil</a> (val)</td></tr>
  66. <tr class="separator:ga24ff0eae16204f349ac529b1c0a1b007"><td class="memSeparator" colspan="2">&#160;</td></tr>
  67. <tr class="memitem:gaef620e14ca73b683aba235a638b2fbb3"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__MathFunctions.html#gaef620e14ca73b683aba235a638b2fbb3">mClamp</a> (float number, float min, float max)</td></tr>
  68. <tr class="separator:gaef620e14ca73b683aba235a638b2fbb3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  69. <tr class="memitem:ga60925cab04cc33ffe6768621450aed26"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__MathFunctions.html#ga60925cab04cc33ffe6768621450aed26">mCos</a> (val)</td></tr>
  70. <tr class="separator:ga60925cab04cc33ffe6768621450aed26"><td class="memSeparator" colspan="2">&#160;</td></tr>
  71. <tr class="memitem:gac73a3322299c719be204d817230489aa"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__MathFunctions.html#gac73a3322299c719be204d817230489aa">mDegToRad</a> (val)</td></tr>
  72. <tr class="separator:gac73a3322299c719be204d817230489aa"><td class="memSeparator" colspan="2">&#160;</td></tr>
  73. <tr class="memitem:gac2d0303498d68ec1e66ee403b2309bd4"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__MathFunctions.html#gac2d0303498d68ec1e66ee403b2309bd4">mFloatLength</a> (val, numDecimals)</td></tr>
  74. <tr class="separator:gac2d0303498d68ec1e66ee403b2309bd4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  75. <tr class="memitem:gabed237c81469b0feba099dcfa22de0c3"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__MathFunctions.html#gabed237c81469b0feba099dcfa22de0c3">mFloor</a> (val)</td></tr>
  76. <tr class="separator:gabed237c81469b0feba099dcfa22de0c3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  77. <tr class="memitem:ga117d6fa6302020924fe5e65f5be83830"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__MathFunctions.html#ga117d6fa6302020924fe5e65f5be83830">mGetMax</a> (a, b)</td></tr>
  78. <tr class="separator:ga117d6fa6302020924fe5e65f5be83830"><td class="memSeparator" colspan="2">&#160;</td></tr>
  79. <tr class="memitem:ga602231d16d4f9c8eaba8b8846ea09f3f"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__MathFunctions.html#ga602231d16d4f9c8eaba8b8846ea09f3f">mGetMin</a> (a, b)</td></tr>
  80. <tr class="separator:ga602231d16d4f9c8eaba8b8846ea09f3f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  81. <tr class="memitem:gae229f9e50c90a865ed465fa23dffed75"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__MathFunctions.html#gae229f9e50c90a865ed465fa23dffed75">mLog</a> (val)</td></tr>
  82. <tr class="separator:gae229f9e50c90a865ed465fa23dffed75"><td class="memSeparator" colspan="2">&#160;</td></tr>
  83. <tr class="memitem:ga9fab93f0b2fb82b4cb7a10b0ad0fe788"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__MathFunctions.html#ga9fab93f0b2fb82b4cb7a10b0ad0fe788">mPow</a> (val, power)</td></tr>
  84. <tr class="separator:ga9fab93f0b2fb82b4cb7a10b0ad0fe788"><td class="memSeparator" colspan="2">&#160;</td></tr>
  85. <tr class="memitem:gad366eddd7ad2d77bfd9838d3951a6ebc"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__MathFunctions.html#gad366eddd7ad2d77bfd9838d3951a6ebc">mRadToDeg</a> (val)</td></tr>
  86. <tr class="separator:gad366eddd7ad2d77bfd9838d3951a6ebc"><td class="memSeparator" colspan="2">&#160;</td></tr>
  87. <tr class="memitem:ga4480fde17dcb0ca088770789f4c8bf65"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__MathFunctions.html#ga4480fde17dcb0ca088770789f4c8bf65">mRound</a> (float v)</td></tr>
  88. <tr class="separator:ga4480fde17dcb0ca088770789f4c8bf65"><td class="memSeparator" colspan="2">&#160;</td></tr>
  89. <tr class="memitem:ga87eba52c49dead41330be339d3ff21fe"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__MathFunctions.html#ga87eba52c49dead41330be339d3ff21fe">mSin</a> (val)</td></tr>
  90. <tr class="separator:ga87eba52c49dead41330be339d3ff21fe"><td class="memSeparator" colspan="2">&#160;</td></tr>
  91. <tr class="memitem:ga45d08fe7cc09a7b3df5bdbc73ece2d18"><td class="memItemLeft" align="right" valign="top">string&#160;</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>
  92. <tr class="separator:ga45d08fe7cc09a7b3df5bdbc73ece2d18"><td class="memSeparator" colspan="2">&#160;</td></tr>
  93. <tr class="memitem:ga9c1efea8e988c6fa5c4ea35da797132e"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__MathFunctions.html#ga9c1efea8e988c6fa5c4ea35da797132e">mSolveQuadratic</a> (float a, float b, float c)</td></tr>
  94. <tr class="separator:ga9c1efea8e988c6fa5c4ea35da797132e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  95. <tr class="memitem:ga1ca6ff16aa75ebcb4273a06909630cec"><td class="memItemLeft" align="right" valign="top">string&#160;</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>
  96. <tr class="separator:ga1ca6ff16aa75ebcb4273a06909630cec"><td class="memSeparator" colspan="2">&#160;</td></tr>
  97. <tr class="memitem:gaf8400080e9157341bd02ccb0d36540f5"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__MathFunctions.html#gaf8400080e9157341bd02ccb0d36540f5">mSqrt</a> (val)</td></tr>
  98. <tr class="separator:gaf8400080e9157341bd02ccb0d36540f5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  99. <tr class="memitem:gad4c06a2ea2500f717543ac282d9fba99"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__MathFunctions.html#gad4c06a2ea2500f717543ac282d9fba99">mTan</a> (val)</td></tr>
  100. <tr class="separator:gad4c06a2ea2500f717543ac282d9fba99"><td class="memSeparator" colspan="2">&#160;</td></tr>
  101. <tr class="memitem:gadd1a0a9f9451423d99508fe8e4985df0"><td class="memItemLeft" align="right" valign="top">int&#160;</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>
  102. <tr class="separator:gadd1a0a9f9451423d99508fe8e4985df0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  103. </table>
  104. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  105. <h2 class="groupheader">Function Documentation</h2>
  106. <a class="anchor" id="gad90644459f01e3f3a33c139aaeeb91fe"></a>
  107. <div class="memitem">
  108. <div class="memproto">
  109. <table class="memname">
  110. <tr>
  111. <td class="memname">int addBitToMask </td>
  112. <td>(</td>
  113. <td class="paramtype">mask&#160;</td>
  114. <td class="paramname">, </td>
  115. </tr>
  116. <tr>
  117. <td class="paramkey"></td>
  118. <td></td>
  119. <td class="paramtype"><a class="el" href="group__MathFunctions.html#gab41cbb5c202a8e0410bc11004ddb9442">bit</a>&#160;</td>
  120. <td class="paramname">&#160;</td>
  121. </tr>
  122. <tr>
  123. <td></td>
  124. <td>)</td>
  125. <td></td><td></td>
  126. </tr>
  127. </table>
  128. </div><div class="memdoc">
  129. <p>Returns the mask with a bit added to it </p>
  130. </div>
  131. </div>
  132. <a class="anchor" id="gab41cbb5c202a8e0410bc11004ddb9442"></a>
  133. <div class="memitem">
  134. <div class="memproto">
  135. <table class="memname">
  136. <tr>
  137. <td class="memname">string bit </td>
  138. <td>(</td>
  139. <td class="paramname"></td><td>)</td>
  140. <td></td>
  141. </tr>
  142. </table>
  143. </div><div class="memdoc">
  144. <p>Converts a bit-position into a value. </p>
  145. </div>
  146. </div>
  147. <a class="anchor" id="ga14fc5e2305e82f4cd371a94b796ece21"></a>
  148. <div class="memitem">
  149. <div class="memproto">
  150. <table class="memname">
  151. <tr>
  152. <td class="memname">string bitInverse </td>
  153. <td>(</td>
  154. <td class="paramname"></td><td>)</td>
  155. <td></td>
  156. </tr>
  157. </table>
  158. </div><div class="memdoc">
  159. <p>Returns the ones complement of a bit. </p>
  160. </div>
  161. </div>
  162. <a class="anchor" id="gaa6fe8dd852c9f234a3d95f1acf02f891"></a>
  163. <div class="memitem">
  164. <div class="memproto">
  165. <table class="memname">
  166. <tr>
  167. <td class="memname">string bits </td>
  168. <td>(</td>
  169. <td class="paramname"></td><td>)</td>
  170. <td></td>
  171. </tr>
  172. </table>
  173. </div><div class="memdoc">
  174. <p>Converts a list of bit-positions into a value. </p>
  175. </div>
  176. </div>
  177. <a class="anchor" id="ga13467ba4765acdac6390a570c210fce2"></a>
  178. <div class="memitem">
  179. <div class="memproto">
  180. <table class="memname">
  181. <tr>
  182. <td class="memname">float mAbs </td>
  183. <td>(</td>
  184. <td class="paramtype">val&#160;</td>
  185. <td class="paramname"></td><td>)</td>
  186. <td></td>
  187. </tr>
  188. </table>
  189. </div><div class="memdoc">
  190. <p>Use the mAbs function to get the magnitude of val. </p>
  191. <dl class="params"><dt>Parameters</dt><dd>
  192. <table class="params">
  193. <tr><td class="paramname">val</td><td>An integer or a floating-point value. </td></tr>
  194. </table>
  195. </dd>
  196. </dl>
  197. <dl class="section return"><dt>Returns</dt><dd>Returns the magnitude of val </dd></dl>
  198. </div>
  199. </div>
  200. <a class="anchor" id="gab6c861dd35670c656e8632f2d824c836"></a>
  201. <div class="memitem">
  202. <div class="memproto">
  203. <table class="memname">
  204. <tr>
  205. <td class="memname">float mAcos </td>
  206. <td>(</td>
  207. <td class="paramtype">val&#160;</td>
  208. <td class="paramname"></td><td>)</td>
  209. <td></td>
  210. </tr>
  211. </table>
  212. </div><div class="memdoc">
  213. <p>Use the mAcos function to get the inverse cosine of val in radians. </p>
  214. <dl class="params"><dt>Parameters</dt><dd>
  215. <table class="params">
  216. <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>
  217. </table>
  218. </dd>
  219. </dl>
  220. <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>
  221. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__MathFunctions.html#ga60925cab04cc33ffe6768621450aed26">mCos</a> </dd></dl>
  222. <p>Referenced by <a class="el" href="group__Vector2Math.html#gab4ad61aa083dccd62b61b80c5b5f4c3b">Vector2AngleBetween()</a>.</p>
  223. </div>
  224. </div>
  225. <a class="anchor" id="ga1898e8164aadb87482bba0b191a3bd2f"></a>
  226. <div class="memitem">
  227. <div class="memproto">
  228. <table class="memname">
  229. <tr>
  230. <td class="memname">float mAsin </td>
  231. <td>(</td>
  232. <td class="paramtype">val&#160;</td>
  233. <td class="paramname"></td><td>)</td>
  234. <td></td>
  235. </tr>
  236. </table>
  237. </div><div class="memdoc">
  238. <p>Use the mAsin function to get the inverse sine of val in radians. </p>
  239. <dl class="params"><dt>Parameters</dt><dd>
  240. <table class="params">
  241. <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>
  242. </table>
  243. </dd>
  244. </dl>
  245. <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>
  246. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__MathFunctions.html#ga87eba52c49dead41330be339d3ff21fe">mSin</a> </dd></dl>
  247. </div>
  248. </div>
  249. <a class="anchor" id="ga729168c83e87ef33afcacdd06e9db0b6"></a>
  250. <div class="memitem">
  251. <div class="memproto">
  252. <table class="memname">
  253. <tr>
  254. <td class="memname">float mAtan </td>
  255. <td>(</td>
  256. <td class="paramtype">val&#160;</td>
  257. <td class="paramname"></td><td>)</td>
  258. <td></td>
  259. </tr>
  260. </table>
  261. </div><div class="memdoc">
  262. <p>Use the mAtan function to get the inverse tangent of rise/run in radians. </p>
  263. <dl class="params"><dt>Parameters</dt><dd>
  264. <table class="params">
  265. <tr><td class="paramname">rise</td><td>Vertical component of a line. </td></tr>
  266. <tr><td class="paramname">run</td><td>Horizontal component of a line. </td></tr>
  267. </table>
  268. </dd>
  269. </dl>
  270. <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>
  271. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__MathFunctions.html#gad4c06a2ea2500f717543ac282d9fba99">mTan</a> </dd></dl>
  272. <p>Referenced by <a class="el" href="group__Vector2Math.html#gad22c735f793d613af07dd6ceffc7e6a5">Vector2AngleToPoint()</a>.</p>
  273. </div>
  274. </div>
  275. <a class="anchor" id="ga24ff0eae16204f349ac529b1c0a1b007"></a>
  276. <div class="memitem">
  277. <div class="memproto">
  278. <table class="memname">
  279. <tr>
  280. <td class="memname">int mCeil </td>
  281. <td>(</td>
  282. <td class="paramtype">val&#160;</td>
  283. <td class="paramname"></td><td>)</td>
  284. <td></td>
  285. </tr>
  286. </table>
  287. </div><div class="memdoc">
  288. <p>Use the mCeil function to calculate the next highest integer value from val. </p>
  289. <dl class="params"><dt>Parameters</dt><dd>
  290. <table class="params">
  291. <tr><td class="paramname">val</td><td>A floating-point value. </td></tr>
  292. </table>
  293. </dd>
  294. </dl>
  295. <dl class="section return"><dt>Returns</dt><dd>Returns an integer representing the next highest integer from val. </dd></dl>
  296. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__MathFunctions.html#gabed237c81469b0feba099dcfa22de0c3">mFloor</a> </dd></dl>
  297. </div>
  298. </div>
  299. <a class="anchor" id="gaef620e14ca73b683aba235a638b2fbb3"></a>
  300. <div class="memitem">
  301. <div class="memproto">
  302. <table class="memname">
  303. <tr>
  304. <td class="memname">float mClamp </td>
  305. <td>(</td>
  306. <td class="paramtype">float&#160;</td>
  307. <td class="paramname"><em>number</em>, </td>
  308. </tr>
  309. <tr>
  310. <td class="paramkey"></td>
  311. <td></td>
  312. <td class="paramtype">float&#160;</td>
  313. <td class="paramname"><em>min</em>, </td>
  314. </tr>
  315. <tr>
  316. <td class="paramkey"></td>
  317. <td></td>
  318. <td class="paramtype">float&#160;</td>
  319. <td class="paramname"><em>max</em>&#160;</td>
  320. </tr>
  321. <tr>
  322. <td></td>
  323. <td>)</td>
  324. <td></td><td></td>
  325. </tr>
  326. </table>
  327. </div><div class="memdoc">
  328. <p>Clamp a value between two other values. </p>
  329. <dl class="params"><dt>Parameters</dt><dd>
  330. <table class="params">
  331. <tr><td class="paramname">number</td><td>A float value representing the number to clamp </td></tr>
  332. <tr><td class="paramname">min</td><td>The lower bound </td></tr>
  333. <tr><td class="paramname">max</td><td>The upper bound </td></tr>
  334. </table>
  335. </dd>
  336. </dl>
  337. <dl class="section return"><dt>Returns</dt><dd>A float value the is within the given range </dd></dl>
  338. </div>
  339. </div>
  340. <a class="anchor" id="ga60925cab04cc33ffe6768621450aed26"></a>
  341. <div class="memitem">
  342. <div class="memproto">
  343. <table class="memname">
  344. <tr>
  345. <td class="memname">float mCos </td>
  346. <td>(</td>
  347. <td class="paramtype">val&#160;</td>
  348. <td class="paramname"></td><td>)</td>
  349. <td></td>
  350. </tr>
  351. </table>
  352. </div><div class="memdoc">
  353. <p>Use the mCos function to get the cosine of the radian angle val. </p>
  354. <dl class="params"><dt>Parameters</dt><dd>
  355. <table class="params">
  356. <tr><td class="paramname">val</td><td>A value between -3.14159 and 3.14159. </td></tr>
  357. </table>
  358. </dd>
  359. </dl>
  360. <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>
  361. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__MathFunctions.html#gab6c861dd35670c656e8632f2d824c836">mAcos</a> </dd></dl>
  362. </div>
  363. </div>
  364. <a class="anchor" id="gac73a3322299c719be204d817230489aa"></a>
  365. <div class="memitem">
  366. <div class="memproto">
  367. <table class="memname">
  368. <tr>
  369. <td class="memname">float mDegToRad </td>
  370. <td>(</td>
  371. <td class="paramtype">val&#160;</td>
  372. <td class="paramname"></td><td>)</td>
  373. <td></td>
  374. </tr>
  375. </table>
  376. </div><div class="memdoc">
  377. <p>Use the mDegToRad function to convert degrees to radians. </p>
  378. <dl class="params"><dt>Parameters</dt><dd>
  379. <table class="params">
  380. <tr><td class="paramname">val</td><td>A floating-point number representing some number of degrees. </td></tr>
  381. </table>
  382. </dd>
  383. </dl>
  384. <dl class="section return"><dt>Returns</dt><dd>Returns the equivalent of the degree value val in radians. </dd></dl>
  385. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__MathFunctions.html#gad366eddd7ad2d77bfd9838d3951a6ebc">mRadToDeg</a> </dd></dl>
  386. <p>Referenced by <a class="el" href="group__Vector2Math.html#ga8bfafe540a1c2d58457fca7898dc340f">Vector2Direction()</a>.</p>
  387. </div>
  388. </div>
  389. <a class="anchor" id="gac2d0303498d68ec1e66ee403b2309bd4"></a>
  390. <div class="memitem">
  391. <div class="memproto">
  392. <table class="memname">
  393. <tr>
  394. <td class="memname">string mFloatLength </td>
  395. <td>(</td>
  396. <td class="paramtype">val&#160;</td>
  397. <td class="paramname">, </td>
  398. </tr>
  399. <tr>
  400. <td class="paramkey"></td>
  401. <td></td>
  402. <td class="paramtype">numDecimals&#160;</td>
  403. <td class="paramname">&#160;</td>
  404. </tr>
  405. <tr>
  406. <td></td>
  407. <td>)</td>
  408. <td></td><td></td>
  409. </tr>
  410. </table>
  411. </div><div class="memdoc">
  412. <p>Use the mFloatLength function to limit the number of decimal places in val to numDecimals. </p>
  413. <dl class="params"><dt>Parameters</dt><dd>
  414. <table class="params">
  415. <tr><td class="paramname">val</td><td>A floating-point value. </td></tr>
  416. <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>
  417. </table>
  418. </dd>
  419. </dl>
  420. <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>
  421. </div>
  422. </div>
  423. <a class="anchor" id="gabed237c81469b0feba099dcfa22de0c3"></a>
  424. <div class="memitem">
  425. <div class="memproto">
  426. <table class="memname">
  427. <tr>
  428. <td class="memname">int mFloor </td>
  429. <td>(</td>
  430. <td class="paramtype">val&#160;</td>
  431. <td class="paramname"></td><td>)</td>
  432. <td></td>
  433. </tr>
  434. </table>
  435. </div><div class="memdoc">
  436. <p>Use the mFloor function to calculate the next lowest integer value from val. </p>
  437. <dl class="params"><dt>Parameters</dt><dd>
  438. <table class="params">
  439. <tr><td class="paramname">val</td><td>A floating-point value. </td></tr>
  440. </table>
  441. </dd>
  442. </dl>
  443. <dl class="section return"><dt>Returns</dt><dd>Returns an integer representing the next lowest integer from val. </dd></dl>
  444. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__MathFunctions.html#ga24ff0eae16204f349ac529b1c0a1b007">mCeil</a> </dd></dl>
  445. </div>
  446. </div>
  447. <a class="anchor" id="ga117d6fa6302020924fe5e65f5be83830"></a>
  448. <div class="memitem">
  449. <div class="memproto">
  450. <table class="memname">
  451. <tr>
  452. <td class="memname">float mGetMax </td>
  453. <td>(</td>
  454. <td class="paramtype">a&#160;</td>
  455. <td class="paramname">, </td>
  456. </tr>
  457. <tr>
  458. <td class="paramkey"></td>
  459. <td></td>
  460. <td class="paramtype">b&#160;</td>
  461. <td class="paramname">&#160;</td>
  462. </tr>
  463. <tr>
  464. <td></td>
  465. <td>)</td>
  466. <td></td><td></td>
  467. </tr>
  468. </table>
  469. </div><div class="memdoc">
  470. <p>Returns the Maximum of two values. </p>
  471. </div>
  472. </div>
  473. <a class="anchor" id="ga602231d16d4f9c8eaba8b8846ea09f3f"></a>
  474. <div class="memitem">
  475. <div class="memproto">
  476. <table class="memname">
  477. <tr>
  478. <td class="memname">float mGetMin </td>
  479. <td>(</td>
  480. <td class="paramtype">a&#160;</td>
  481. <td class="paramname">, </td>
  482. </tr>
  483. <tr>
  484. <td class="paramkey"></td>
  485. <td></td>
  486. <td class="paramtype">b&#160;</td>
  487. <td class="paramname">&#160;</td>
  488. </tr>
  489. <tr>
  490. <td></td>
  491. <td>)</td>
  492. <td></td><td></td>
  493. </tr>
  494. </table>
  495. </div><div class="memdoc">
  496. <p>Returns the Minimum of two values. </p>
  497. </div>
  498. </div>
  499. <a class="anchor" id="gae229f9e50c90a865ed465fa23dffed75"></a>
  500. <div class="memitem">
  501. <div class="memproto">
  502. <table class="memname">
  503. <tr>
  504. <td class="memname">float mLog </td>
  505. <td>(</td>
  506. <td class="paramtype">val&#160;</td>
  507. <td class="paramname"></td><td>)</td>
  508. <td></td>
  509. </tr>
  510. </table>
  511. </div><div class="memdoc">
  512. <p>Use the mLog function to calculate the natural logarithm of val. </p>
  513. <dl class="params"><dt>Parameters</dt><dd>
  514. <table class="params">
  515. <tr><td class="paramname">val</td><td>A numeric value. </td></tr>
  516. </table>
  517. </dd>
  518. </dl>
  519. <dl class="section return"><dt>Returns</dt><dd>Returns the natural logarithm of val </dd></dl>
  520. </div>
  521. </div>
  522. <a class="anchor" id="ga9fab93f0b2fb82b4cb7a10b0ad0fe788"></a>
  523. <div class="memitem">
  524. <div class="memproto">
  525. <table class="memname">
  526. <tr>
  527. <td class="memname">float mPow </td>
  528. <td>(</td>
  529. <td class="paramtype">val&#160;</td>
  530. <td class="paramname">, </td>
  531. </tr>
  532. <tr>
  533. <td class="paramkey"></td>
  534. <td></td>
  535. <td class="paramtype">power&#160;</td>
  536. <td class="paramname">&#160;</td>
  537. </tr>
  538. <tr>
  539. <td></td>
  540. <td>)</td>
  541. <td></td><td></td>
  542. </tr>
  543. </table>
  544. </div><div class="memdoc">
  545. <p>Use the mPow function to calculated val raised to the power of power. </p>
  546. <dl class="params"><dt>Parameters</dt><dd>
  547. <table class="params">
  548. <tr><td class="paramname">val</td><td>A numeric (integer or floating-point) value to be raised to a power. </td></tr>
  549. <tr><td class="paramname">power</td><td>A numeric (integer or floating-point) power to raise val to. </td></tr>
  550. </table>
  551. </dd>
  552. </dl>
  553. <dl class="section return"><dt>Returns</dt><dd>Returns val^power </dd></dl>
  554. </div>
  555. </div>
  556. <a class="anchor" id="gad366eddd7ad2d77bfd9838d3951a6ebc"></a>
  557. <div class="memitem">
  558. <div class="memproto">
  559. <table class="memname">
  560. <tr>
  561. <td class="memname">float mRadToDeg </td>
  562. <td>(</td>
  563. <td class="paramtype">val&#160;</td>
  564. <td class="paramname"></td><td>)</td>
  565. <td></td>
  566. </tr>
  567. </table>
  568. </div><div class="memdoc">
  569. <p>Use the mRadToDeg function to convert radians to degrees. </p>
  570. <dl class="params"><dt>Parameters</dt><dd>
  571. <table class="params">
  572. <tr><td class="paramname">val</td><td>A floating-point number representing some number of radians. </td></tr>
  573. </table>
  574. </dd>
  575. </dl>
  576. <dl class="section return"><dt>Returns</dt><dd>Returns the equivalent of the radian value val in degrees. </dd></dl>
  577. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__MathFunctions.html#gac73a3322299c719be204d817230489aa">mDegToRad</a> </dd></dl>
  578. <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>
  579. </div>
  580. </div>
  581. <a class="anchor" id="ga4480fde17dcb0ca088770789f4c8bf65"></a>
  582. <div class="memitem">
  583. <div class="memproto">
  584. <table class="memname">
  585. <tr>
  586. <td class="memname">float mRound </td>
  587. <td>(</td>
  588. <td class="paramtype">float&#160;</td>
  589. <td class="paramname"><em>v</em></td><td>)</td>
  590. <td></td>
  591. </tr>
  592. </table>
  593. </div><div class="memdoc">
  594. <p>Rounds a number. 0.5 is rounded up. </p>
  595. <dl class="params"><dt>Parameters</dt><dd>
  596. <table class="params">
  597. <tr><td class="paramname">val</td><td>A floating-point value </td></tr>
  598. </table>
  599. </dd>
  600. </dl>
  601. <dl class="section return"><dt>Returns</dt><dd>Returns the integer value closest to the given float </dd></dl>
  602. </div>
  603. </div>
  604. <a class="anchor" id="ga87eba52c49dead41330be339d3ff21fe"></a>
  605. <div class="memitem">
  606. <div class="memproto">
  607. <table class="memname">
  608. <tr>
  609. <td class="memname">float mSin </td>
  610. <td>(</td>
  611. <td class="paramtype">val&#160;</td>
  612. <td class="paramname"></td><td>)</td>
  613. <td></td>
  614. </tr>
  615. </table>
  616. </div><div class="memdoc">
  617. <p>Use the mSin function to get the sine of the radian angle val. </p>
  618. <dl class="params"><dt>Parameters</dt><dd>
  619. <table class="params">
  620. <tr><td class="paramname">val</td><td>A value between -3.14159 and 3.14159. </td></tr>
  621. </table>
  622. </dd>
  623. </dl>
  624. <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>
  625. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__MathFunctions.html#ga1898e8164aadb87482bba0b191a3bd2f">mAsin</a> </dd></dl>
  626. </div>
  627. </div>
  628. <a class="anchor" id="ga45d08fe7cc09a7b3df5bdbc73ece2d18"></a>
  629. <div class="memitem">
  630. <div class="memproto">
  631. <table class="memname">
  632. <tr>
  633. <td class="memname">string mSolveCubic </td>
  634. <td>(</td>
  635. <td class="paramtype">float&#160;</td>
  636. <td class="paramname"><em>a</em>, </td>
  637. </tr>
  638. <tr>
  639. <td class="paramkey"></td>
  640. <td></td>
  641. <td class="paramtype">float&#160;</td>
  642. <td class="paramname"><em>b</em>, </td>
  643. </tr>
  644. <tr>
  645. <td class="paramkey"></td>
  646. <td></td>
  647. <td class="paramtype">float&#160;</td>
  648. <td class="paramname"><em>c</em>, </td>
  649. </tr>
  650. <tr>
  651. <td class="paramkey"></td>
  652. <td></td>
  653. <td class="paramtype">float&#160;</td>
  654. <td class="paramname"><em>d</em>&#160;</td>
  655. </tr>
  656. <tr>
  657. <td></td>
  658. <td>)</td>
  659. <td></td><td></td>
  660. </tr>
  661. </table>
  662. </div><div class="memdoc">
  663. <p>Solve a cubic equation of form a*x^3 + b*x^2 + c*x + d = 0. </p>
  664. <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>
  665. </div>
  666. </div>
  667. <a class="anchor" id="ga9c1efea8e988c6fa5c4ea35da797132e"></a>
  668. <div class="memitem">
  669. <div class="memproto">
  670. <table class="memname">
  671. <tr>
  672. <td class="memname">string mSolveQuadratic </td>
  673. <td>(</td>
  674. <td class="paramtype">float&#160;</td>
  675. <td class="paramname"><em>a</em>, </td>
  676. </tr>
  677. <tr>
  678. <td class="paramkey"></td>
  679. <td></td>
  680. <td class="paramtype">float&#160;</td>
  681. <td class="paramname"><em>b</em>, </td>
  682. </tr>
  683. <tr>
  684. <td class="paramkey"></td>
  685. <td></td>
  686. <td class="paramtype">float&#160;</td>
  687. <td class="paramname"><em>c</em>&#160;</td>
  688. </tr>
  689. <tr>
  690. <td></td>
  691. <td>)</td>
  692. <td></td><td></td>
  693. </tr>
  694. </table>
  695. </div><div class="memdoc">
  696. <p>Solve a quadratic equation of form a*x^2 + b*x + c = 0. </p>
  697. <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>
  698. </div>
  699. </div>
  700. <a class="anchor" id="ga1ca6ff16aa75ebcb4273a06909630cec"></a>
  701. <div class="memitem">
  702. <div class="memproto">
  703. <table class="memname">
  704. <tr>
  705. <td class="memname">string mSolveQuartic </td>
  706. <td>(</td>
  707. <td class="paramtype">float&#160;</td>
  708. <td class="paramname"><em>a</em>, </td>
  709. </tr>
  710. <tr>
  711. <td class="paramkey"></td>
  712. <td></td>
  713. <td class="paramtype">float&#160;</td>
  714. <td class="paramname"><em>b</em>, </td>
  715. </tr>
  716. <tr>
  717. <td class="paramkey"></td>
  718. <td></td>
  719. <td class="paramtype">float&#160;</td>
  720. <td class="paramname"><em>c</em>, </td>
  721. </tr>
  722. <tr>
  723. <td class="paramkey"></td>
  724. <td></td>
  725. <td class="paramtype">float&#160;</td>
  726. <td class="paramname"><em>d</em>, </td>
  727. </tr>
  728. <tr>
  729. <td class="paramkey"></td>
  730. <td></td>
  731. <td class="paramtype">float&#160;</td>
  732. <td class="paramname"><em>e</em>&#160;</td>
  733. </tr>
  734. <tr>
  735. <td></td>
  736. <td>)</td>
  737. <td></td><td></td>
  738. </tr>
  739. </table>
  740. </div><div class="memdoc">
  741. <p>Solve a quartic equation of form a*x^4 + b*x^3 + c*x^2 + d*x + e = 0. </p>
  742. <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>
  743. </div>
  744. </div>
  745. <a class="anchor" id="gaf8400080e9157341bd02ccb0d36540f5"></a>
  746. <div class="memitem">
  747. <div class="memproto">
  748. <table class="memname">
  749. <tr>
  750. <td class="memname">float mSqrt </td>
  751. <td>(</td>
  752. <td class="paramtype">val&#160;</td>
  753. <td class="paramname"></td><td>)</td>
  754. <td></td>
  755. </tr>
  756. </table>
  757. </div><div class="memdoc">
  758. <p>Use the mSqrt function to calculated the square root of val. </p>
  759. <dl class="params"><dt>Parameters</dt><dd>
  760. <table class="params">
  761. <tr><td class="paramname">val</td><td>A numeric value. </td></tr>
  762. </table>
  763. </dd>
  764. </dl>
  765. <dl class="section return"><dt>Returns</dt><dd>Returns the the squareroot of val </dd></dl>
  766. </div>
  767. </div>
  768. <a class="anchor" id="gad4c06a2ea2500f717543ac282d9fba99"></a>
  769. <div class="memitem">
  770. <div class="memproto">
  771. <table class="memname">
  772. <tr>
  773. <td class="memname">float mTan </td>
  774. <td>(</td>
  775. <td class="paramtype">val&#160;</td>
  776. <td class="paramname"></td><td>)</td>
  777. <td></td>
  778. </tr>
  779. </table>
  780. </div><div class="memdoc">
  781. <p>Use the mTan function to get the tangent of the radian angle val. </p>
  782. <dl class="params"><dt>Parameters</dt><dd>
  783. <table class="params">
  784. <tr><td class="paramname">val</td><td>A value between -3.14159/2 and 3.14159/2. </td></tr>
  785. </table>
  786. </dd>
  787. </dl>
  788. <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>
  789. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__MathFunctions.html#ga729168c83e87ef33afcacdd06e9db0b6">mAtan</a> </dd></dl>
  790. </div>
  791. </div>
  792. <a class="anchor" id="gadd1a0a9f9451423d99508fe8e4985df0"></a>
  793. <div class="memitem">
  794. <div class="memproto">
  795. <table class="memname">
  796. <tr>
  797. <td class="memname">int removeBitFromMask </td>
  798. <td>(</td>
  799. <td class="paramtype">mask&#160;</td>
  800. <td class="paramname">, </td>
  801. </tr>
  802. <tr>
  803. <td class="paramkey"></td>
  804. <td></td>
  805. <td class="paramtype"><a class="el" href="group__MathFunctions.html#gab41cbb5c202a8e0410bc11004ddb9442">bit</a>&#160;</td>
  806. <td class="paramname">&#160;</td>
  807. </tr>
  808. <tr>
  809. <td></td>
  810. <td>)</td>
  811. <td></td><td></td>
  812. </tr>
  813. </table>
  814. </div><div class="memdoc">
  815. <p>Returns the mask with a bit removed from it </p>
  816. </div>
  817. </div>
  818. </div><!-- contents -->
  819. <!-- start footer part -->
  820. <hr class="footer"/><address class="footer"><small>
  821. Generated by &#160;<a href="http://www.doxygen.org/index.html">
  822. <img class="footer" src="doxygen.png" alt="doxygen"/>
  823. </a> 1.8.3.1
  824. </small></address>
  825. </body>
  826. </html>