cpp
/
JoltPhysics
mirror of https://github.com/jrouwe/JoltPhysics.git


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306
							<!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.12.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Jolt Physics: Jolt/Math/Trigonometry.h File Reference</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>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="cookie.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
  extensions: ["tex2jax.js"],
  jax: ["input/TeX","output/HTML-CSS"],
});
</script>
<script type="text/javascript" async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js"></script>
<link href="doxygen.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="projectlogo"><img alt="Logo" src="LogoSmall.png"/></td>
  <td id="projectalign">
   <div id="projectname">Jolt Physics
   </div>
   <div id="projectbrief">A multi core friendly Game Physics Engine</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.12.0 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @license-end */
</script>
<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&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search',true);
  $(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){initNavTree('_trigonometry_8h.html',''); initResizable(true); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle"><div class="title">Trigonometry.h File Reference</div></div>
</div><!--header-->
<div class="contents">

<p><a href="_trigonometry_8h_source.html">Go to the source code of this file.</a></p>
<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:a89091907eb3da97f690e324849d773cb" id="r_a89091907eb3da97f690e324849d773cb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_core_8h.html#ad14098b68b8c44ea6112601031268405">JPH_NAMESPACE_BEGIN</a> JPH_INLINE float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a89091907eb3da97f690e324849d773cb">Sin</a> (float inX)</td></tr>
<tr class="memdesc:a89091907eb3da97f690e324849d773cb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sine of x (input in radians)  <br /></td></tr>
<tr class="separator:a89091907eb3da97f690e324849d773cb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a40fafb1c427199b6855d704fc79cd1cf" id="r_a40fafb1c427199b6855d704fc79cd1cf"><td class="memItemLeft" align="right" valign="top">JPH_INLINE float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a40fafb1c427199b6855d704fc79cd1cf">Cos</a> (float inX)</td></tr>
<tr class="memdesc:a40fafb1c427199b6855d704fc79cd1cf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Cosine of x (input in radians)  <br /></td></tr>
<tr class="separator:a40fafb1c427199b6855d704fc79cd1cf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a138c843d7c7c5f89c1757b159a86eb00" id="r_a138c843d7c7c5f89c1757b159a86eb00"><td class="memItemLeft" align="right" valign="top">JPH_INLINE float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a138c843d7c7c5f89c1757b159a86eb00">Tan</a> (float inX)</td></tr>
<tr class="memdesc:a138c843d7c7c5f89c1757b159a86eb00"><td class="mdescLeft">&#160;</td><td class="mdescRight">Tangent of x (input in radians)  <br /></td></tr>
<tr class="separator:a138c843d7c7c5f89c1757b159a86eb00"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8d14d3276803ebb781ac40821491c959" id="r_a8d14d3276803ebb781ac40821491c959"><td class="memItemLeft" align="right" valign="top">JPH_INLINE float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a8d14d3276803ebb781ac40821491c959">ASin</a> (float inX)</td></tr>
<tr class="separator:a8d14d3276803ebb781ac40821491c959"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4d69678f84c03b333e32ca716998db39" id="r_a4d69678f84c03b333e32ca716998db39"><td class="memItemLeft" align="right" valign="top">JPH_INLINE float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a4d69678f84c03b333e32ca716998db39">ACos</a> (float inX)</td></tr>
<tr class="separator:a4d69678f84c03b333e32ca716998db39"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1dec7e1e2e84f4362a0a65d390a51ee0" id="r_a1dec7e1e2e84f4362a0a65d390a51ee0"><td class="memItemLeft" align="right" valign="top">JPH_INLINE float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a1dec7e1e2e84f4362a0a65d390a51ee0">ACosApproximate</a> (float inX)</td></tr>
<tr class="memdesc:a1dec7e1e2e84f4362a0a65d390a51ee0"><td class="mdescLeft">&#160;</td><td class="mdescRight">An approximation of ACos, max error is 4.2e-3 over the entire range [-1, 1], is approximately 2.5x faster than ACos.  <br /></td></tr>
<tr class="separator:a1dec7e1e2e84f4362a0a65d390a51ee0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8d7d50cdb10f600d1493bd8a36c4029e" id="r_a8d7d50cdb10f600d1493bd8a36c4029e"><td class="memItemLeft" align="right" valign="top">JPH_INLINE float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a8d7d50cdb10f600d1493bd8a36c4029e">ATan</a> (float inX)</td></tr>
<tr class="memdesc:a8d7d50cdb10f600d1493bd8a36c4029e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Arc tangent of x (returns value in the range [-PI / 2, PI / 2])  <br /></td></tr>
<tr class="separator:a8d7d50cdb10f600d1493bd8a36c4029e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a64f4ce00d99917535c674ec5172ccf78" id="r_a64f4ce00d99917535c674ec5172ccf78"><td class="memItemLeft" align="right" valign="top">JPH_INLINE float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a64f4ce00d99917535c674ec5172ccf78">ATan2</a> (float inY, float inX)</td></tr>
<tr class="memdesc:a64f4ce00d99917535c674ec5172ccf78"><td class="mdescLeft">&#160;</td><td class="mdescRight">Arc tangent of y / x using the signs of the arguments to determine the correct quadrant (returns value in the range [-PI, PI])  <br /></td></tr>
<tr class="separator:a64f4ce00d99917535c674ec5172ccf78"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a id="a4d69678f84c03b333e32ca716998db39" name="a4d69678f84c03b333e32ca716998db39"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4d69678f84c03b333e32ca716998db39">&#9670;&#160;</a></span>ACos()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">JPH_INLINE float ACos </td>
          <td>(</td>
          <td class="paramtype">float</td>          <td class="paramname"><span class="paramname"><em>inX</em></span></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Arc cosine of x (returns value in the range [0, PI]) Note that all input values will be clamped to the range [-1, 1] and this function will not return NaNs like std::acos </p>

</div>
</div>
<a id="a1dec7e1e2e84f4362a0a65d390a51ee0" name="a1dec7e1e2e84f4362a0a65d390a51ee0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1dec7e1e2e84f4362a0a65d390a51ee0">&#9670;&#160;</a></span>ACosApproximate()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">JPH_INLINE float ACosApproximate </td>
          <td>(</td>
          <td class="paramtype">float</td>          <td class="paramname"><span class="paramname"><em>inX</em></span></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>An approximation of ACos, max error is 4.2e-3 over the entire range [-1, 1], is approximately 2.5x faster than ACos. </p>

</div>
</div>
<a id="a8d14d3276803ebb781ac40821491c959" name="a8d14d3276803ebb781ac40821491c959"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8d14d3276803ebb781ac40821491c959">&#9670;&#160;</a></span>ASin()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">JPH_INLINE float ASin </td>
          <td>(</td>
          <td class="paramtype">float</td>          <td class="paramname"><span class="paramname"><em>inX</em></span></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Arc sine of x (returns value in the range [-PI / 2, PI / 2]) Note that all input values will be clamped to the range [-1, 1] and this function will not return NaNs like std::asin </p>

</div>
</div>
<a id="a8d7d50cdb10f600d1493bd8a36c4029e" name="a8d7d50cdb10f600d1493bd8a36c4029e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8d7d50cdb10f600d1493bd8a36c4029e">&#9670;&#160;</a></span>ATan()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">JPH_INLINE float ATan </td>
          <td>(</td>
          <td class="paramtype">float</td>          <td class="paramname"><span class="paramname"><em>inX</em></span></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Arc tangent of x (returns value in the range [-PI / 2, PI / 2]) </p>

</div>
</div>
<a id="a64f4ce00d99917535c674ec5172ccf78" name="a64f4ce00d99917535c674ec5172ccf78"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a64f4ce00d99917535c674ec5172ccf78">&#9670;&#160;</a></span>ATan2()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">JPH_INLINE float ATan2 </td>
          <td>(</td>
          <td class="paramtype">float</td>          <td class="paramname"><span class="paramname"><em>inY</em></span>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">float</td>          <td class="paramname"><span class="paramname"><em>inX</em></span>&#160;)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Arc tangent of y / x using the signs of the arguments to determine the correct quadrant (returns value in the range [-PI, PI]) </p>

</div>
</div>
<a id="a40fafb1c427199b6855d704fc79cd1cf" name="a40fafb1c427199b6855d704fc79cd1cf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a40fafb1c427199b6855d704fc79cd1cf">&#9670;&#160;</a></span>Cos()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">JPH_INLINE float Cos </td>
          <td>(</td>
          <td class="paramtype">float</td>          <td class="paramname"><span class="paramname"><em>inX</em></span></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Cosine of x (input in radians) </p>

</div>
</div>
<a id="a89091907eb3da97f690e324849d773cb" name="a89091907eb3da97f690e324849d773cb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a89091907eb3da97f690e324849d773cb">&#9670;&#160;</a></span>Sin()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="_core_8h.html#ad14098b68b8c44ea6112601031268405">JPH_NAMESPACE_BEGIN</a> JPH_INLINE float Sin </td>
          <td>(</td>
          <td class="paramtype">float</td>          <td class="paramname"><span class="paramname"><em>inX</em></span></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Sine of x (input in radians) </p>

</div>
</div>
<a id="a138c843d7c7c5f89c1757b159a86eb00" name="a138c843d7c7c5f89c1757b159a86eb00"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a138c843d7c7c5f89c1757b159a86eb00">&#9670;&#160;</a></span>Tan()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">JPH_INLINE float Tan </td>
          <td>(</td>
          <td class="paramtype">float</td>          <td class="paramname"><span class="paramname"><em>inX</em></span></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Tangent of x (input in radians) </p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="dir_d99289a5d3c46cf26f14ff6c90658d9f.html">Jolt</a></li><li class="navelem"><a class="el" href="dir_aa37033c5611f3a5cff668cf59181100.html">Math</a></li><li class="navelem"><a class="el" href="_trigonometry_8h.html">Trigonometry.h</a></li>
    <li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.12.0 </li>
  </ul>
</div>
</body>
</html>