_physics_settings_8h.html 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=11"/>
  6. <meta name="generator" content="Doxygen 1.12.0"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>Jolt Physics: Jolt/Physics/PhysicsSettings.h File Reference</title>
  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <script type="text/javascript" src="clipboard.js"></script>
  13. <link href="navtree.css" rel="stylesheet" type="text/css"/>
  14. <script type="text/javascript" src="navtreedata.js"></script>
  15. <script type="text/javascript" src="navtree.js"></script>
  16. <script type="text/javascript" src="resize.js"></script>
  17. <script type="text/javascript" src="cookie.js"></script>
  18. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  19. <script type="text/javascript" src="search/searchdata.js"></script>
  20. <script type="text/javascript" src="search/search.js"></script>
  21. <script type="text/x-mathjax-config">
  22. MathJax.Hub.Config({
  23. extensions: ["tex2jax.js"],
  24. jax: ["input/TeX","output/HTML-CSS"],
  25. });
  26. </script>
  27. <script type="text/javascript" async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js"></script>
  28. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  29. </head>
  30. <body>
  31. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  32. <div id="titlearea">
  33. <table cellspacing="0" cellpadding="0">
  34. <tbody>
  35. <tr id="projectrow">
  36. <td id="projectlogo"><img alt="Logo" src="LogoSmall.png"/></td>
  37. <td id="projectalign">
  38. <div id="projectname">Jolt Physics
  39. </div>
  40. <div id="projectbrief">A multi core friendly Game Physics Engine</div>
  41. </td>
  42. </tr>
  43. </tbody>
  44. </table>
  45. </div>
  46. <!-- end header part -->
  47. <!-- Generated by Doxygen 1.12.0 -->
  48. <script type="text/javascript">
  49. /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  50. var searchBox = new SearchBox("searchBox", "search/",'.html');
  51. /* @license-end */
  52. </script>
  53. <script type="text/javascript">
  54. /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  55. $(function() { codefold.init(0); });
  56. /* @license-end */
  57. </script>
  58. <script type="text/javascript" src="menudata.js"></script>
  59. <script type="text/javascript" src="menu.js"></script>
  60. <script type="text/javascript">
  61. /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  62. $(function() {
  63. initMenu('',true,false,'search.php','Search',true);
  64. $(function() { init_search(); });
  65. });
  66. /* @license-end */
  67. </script>
  68. <div id="main-nav"></div>
  69. </div><!-- top -->
  70. <div id="side-nav" class="ui-resizable side-nav-resizable">
  71. <div id="nav-tree">
  72. <div id="nav-tree-contents">
  73. <div id="nav-sync" class="sync"></div>
  74. </div>
  75. </div>
  76. <div id="splitbar" style="-moz-user-select:none;"
  77. class="ui-resizable-handle">
  78. </div>
  79. </div>
  80. <script type="text/javascript">
  81. /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  82. $(function(){initNavTree('_physics_settings_8h.html',''); initResizable(true); });
  83. /* @license-end */
  84. </script>
  85. <div id="doc-content">
  86. <!-- window showing the filter options -->
  87. <div id="MSearchSelectWindow"
  88. onmouseover="return searchBox.OnSearchSelectShow()"
  89. onmouseout="return searchBox.OnSearchSelectHide()"
  90. onkeydown="return searchBox.OnSearchSelectKey(event)">
  91. </div>
  92. <!-- iframe showing the search results (closed by default) -->
  93. <div id="MSearchResultsWindow">
  94. <div id="MSearchResults">
  95. <div class="SRPage">
  96. <div id="SRIndex">
  97. <div id="SRResults"></div>
  98. <div class="SRStatus" id="Loading">Loading...</div>
  99. <div class="SRStatus" id="Searching">Searching...</div>
  100. <div class="SRStatus" id="NoMatches">No Matches</div>
  101. </div>
  102. </div>
  103. </div>
  104. </div>
  105. <div class="header">
  106. <div class="summary">
  107. <a href="#nested-classes">Classes</a> &#124;
  108. <a href="#var-members">Variables</a> </div>
  109. <div class="headertitle"><div class="title">PhysicsSettings.h File Reference</div></div>
  110. </div><!--header-->
  111. <div class="contents">
  112. <p><a href="_physics_settings_8h_source.html">Go to the source code of this file.</a></p>
  113. <table class="memberdecls">
  114. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
  115. Classes</h2></td></tr>
  116. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_physics_settings.html">PhysicsSettings</a></td></tr>
  117. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  118. </table><table class="memberdecls">
  119. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="var-members" name="var-members"></a>
  120. Variables</h2></td></tr>
  121. <tr class="memitem:a4199156431c225865fda0e5e6bc593fd" id="r_a4199156431c225865fda0e5e6bc593fd"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_core_8h.html#ad14098b68b8c44ea6112601031268405">JPH_NAMESPACE_BEGIN</a> constexpr float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a4199156431c225865fda0e5e6bc593fd">cDefaultCollisionTolerance</a> = 1.0e-4f</td></tr>
  122. <tr class="memdesc:a4199156431c225865fda0e5e6bc593fd"><td class="mdescLeft">&#160;</td><td class="mdescRight">If objects are closer than this distance, they are considered to be colliding (used for GJK) (unit: meter) <br /></td></tr>
  123. <tr class="separator:a4199156431c225865fda0e5e6bc593fd"><td class="memSeparator" colspan="2">&#160;</td></tr>
  124. <tr class="memitem:adeaa0f0b4cc2e2de1021f3669d5d83d9" id="r_adeaa0f0b4cc2e2de1021f3669d5d83d9"><td class="memItemLeft" align="right" valign="top">constexpr float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#adeaa0f0b4cc2e2de1021f3669d5d83d9">cDefaultPenetrationTolerance</a> = 1.0e-4f</td></tr>
  125. <tr class="memdesc:adeaa0f0b4cc2e2de1021f3669d5d83d9"><td class="mdescLeft">&#160;</td><td class="mdescRight">A factor that determines the accuracy of the penetration depth calculation. If the change of the squared distance is less than tolerance * current_penetration_depth^2 the algorithm will terminate. (unit: dimensionless) <br /></td></tr>
  126. <tr class="separator:adeaa0f0b4cc2e2de1021f3669d5d83d9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  127. <tr class="memitem:aeef9aad6ecef0a70378bbe649f08720e" id="r_aeef9aad6ecef0a70378bbe649f08720e"><td class="memItemLeft" align="right" valign="top">constexpr float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aeef9aad6ecef0a70378bbe649f08720e">cDefaultConvexRadius</a> = 0.05f</td></tr>
  128. <tr class="memdesc:aeef9aad6ecef0a70378bbe649f08720e"><td class="mdescLeft">&#160;</td><td class="mdescRight">How much padding to add around objects. <br /></td></tr>
  129. <tr class="separator:aeef9aad6ecef0a70378bbe649f08720e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  130. <tr class="memitem:a0db4388fe9fc48dbc7b8dd7d43f86825" id="r_a0db4388fe9fc48dbc7b8dd7d43f86825"><td class="memItemLeft" align="right" valign="top">constexpr int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a0db4388fe9fc48dbc7b8dd7d43f86825">cMaxPhysicsJobs</a> = 2048</td></tr>
  131. <tr class="memdesc:a0db4388fe9fc48dbc7b8dd7d43f86825"><td class="mdescLeft">&#160;</td><td class="mdescRight">Maximum amount of jobs to allow. <br /></td></tr>
  132. <tr class="separator:a0db4388fe9fc48dbc7b8dd7d43f86825"><td class="memSeparator" colspan="2">&#160;</td></tr>
  133. <tr class="memitem:a559bcb71de078738aede3ed80cd394f8" id="r_a559bcb71de078738aede3ed80cd394f8"><td class="memItemLeft" align="right" valign="top">constexpr int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a559bcb71de078738aede3ed80cd394f8">cMaxPhysicsBarriers</a> = 8</td></tr>
  134. <tr class="memdesc:a559bcb71de078738aede3ed80cd394f8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Maximum amount of barriers to allow. <br /></td></tr>
  135. <tr class="separator:a559bcb71de078738aede3ed80cd394f8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  136. </table>
  137. <h2 class="groupheader">Variable Documentation</h2>
  138. <a id="a4199156431c225865fda0e5e6bc593fd" name="a4199156431c225865fda0e5e6bc593fd"></a>
  139. <h2 class="memtitle"><span class="permalink"><a href="#a4199156431c225865fda0e5e6bc593fd">&#9670;&#160;</a></span>cDefaultCollisionTolerance</h2>
  140. <div class="memitem">
  141. <div class="memproto">
  142. <table class="mlabels">
  143. <tr>
  144. <td class="mlabels-left">
  145. <table class="memname">
  146. <tr>
  147. <td class="memname"><a class="el" href="_core_8h.html#ad14098b68b8c44ea6112601031268405">JPH_NAMESPACE_BEGIN</a> constexpr float cDefaultCollisionTolerance = 1.0e-4f</td>
  148. </tr>
  149. </table>
  150. </td>
  151. <td class="mlabels-right">
  152. <span class="mlabels"><span class="mlabel">constexpr</span></span> </td>
  153. </tr>
  154. </table>
  155. </div><div class="memdoc">
  156. <p>If objects are closer than this distance, they are considered to be colliding (used for GJK) (unit: meter) </p>
  157. </div>
  158. </div>
  159. <a id="aeef9aad6ecef0a70378bbe649f08720e" name="aeef9aad6ecef0a70378bbe649f08720e"></a>
  160. <h2 class="memtitle"><span class="permalink"><a href="#aeef9aad6ecef0a70378bbe649f08720e">&#9670;&#160;</a></span>cDefaultConvexRadius</h2>
  161. <div class="memitem">
  162. <div class="memproto">
  163. <table class="mlabels">
  164. <tr>
  165. <td class="mlabels-left">
  166. <table class="memname">
  167. <tr>
  168. <td class="memname">float cDefaultConvexRadius = 0.05f</td>
  169. </tr>
  170. </table>
  171. </td>
  172. <td class="mlabels-right">
  173. <span class="mlabels"><span class="mlabel">constexpr</span></span> </td>
  174. </tr>
  175. </table>
  176. </div><div class="memdoc">
  177. <p>How much padding to add around objects. </p>
  178. </div>
  179. </div>
  180. <a id="adeaa0f0b4cc2e2de1021f3669d5d83d9" name="adeaa0f0b4cc2e2de1021f3669d5d83d9"></a>
  181. <h2 class="memtitle"><span class="permalink"><a href="#adeaa0f0b4cc2e2de1021f3669d5d83d9">&#9670;&#160;</a></span>cDefaultPenetrationTolerance</h2>
  182. <div class="memitem">
  183. <div class="memproto">
  184. <table class="mlabels">
  185. <tr>
  186. <td class="mlabels-left">
  187. <table class="memname">
  188. <tr>
  189. <td class="memname">float cDefaultPenetrationTolerance = 1.0e-4f</td>
  190. </tr>
  191. </table>
  192. </td>
  193. <td class="mlabels-right">
  194. <span class="mlabels"><span class="mlabel">constexpr</span></span> </td>
  195. </tr>
  196. </table>
  197. </div><div class="memdoc">
  198. <p>A factor that determines the accuracy of the penetration depth calculation. If the change of the squared distance is less than tolerance * current_penetration_depth^2 the algorithm will terminate. (unit: dimensionless) </p>
  199. <p>Stop when there's less than 1% change </p>
  200. </div>
  201. </div>
  202. <a id="a559bcb71de078738aede3ed80cd394f8" name="a559bcb71de078738aede3ed80cd394f8"></a>
  203. <h2 class="memtitle"><span class="permalink"><a href="#a559bcb71de078738aede3ed80cd394f8">&#9670;&#160;</a></span>cMaxPhysicsBarriers</h2>
  204. <div class="memitem">
  205. <div class="memproto">
  206. <table class="mlabels">
  207. <tr>
  208. <td class="mlabels-left">
  209. <table class="memname">
  210. <tr>
  211. <td class="memname">int cMaxPhysicsBarriers = 8</td>
  212. </tr>
  213. </table>
  214. </td>
  215. <td class="mlabels-right">
  216. <span class="mlabels"><span class="mlabel">constexpr</span></span> </td>
  217. </tr>
  218. </table>
  219. </div><div class="memdoc">
  220. <p>Maximum amount of barriers to allow. </p>
  221. </div>
  222. </div>
  223. <a id="a0db4388fe9fc48dbc7b8dd7d43f86825" name="a0db4388fe9fc48dbc7b8dd7d43f86825"></a>
  224. <h2 class="memtitle"><span class="permalink"><a href="#a0db4388fe9fc48dbc7b8dd7d43f86825">&#9670;&#160;</a></span>cMaxPhysicsJobs</h2>
  225. <div class="memitem">
  226. <div class="memproto">
  227. <table class="mlabels">
  228. <tr>
  229. <td class="mlabels-left">
  230. <table class="memname">
  231. <tr>
  232. <td class="memname">int cMaxPhysicsJobs = 2048</td>
  233. </tr>
  234. </table>
  235. </td>
  236. <td class="mlabels-right">
  237. <span class="mlabels"><span class="mlabel">constexpr</span></span> </td>
  238. </tr>
  239. </table>
  240. </div><div class="memdoc">
  241. <p>Maximum amount of jobs to allow. </p>
  242. </div>
  243. </div>
  244. </div><!-- contents -->
  245. </div><!-- doc-content -->
  246. <!-- start footer part -->
  247. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  248. <ul>
  249. <li class="navelem"><a class="el" href="dir_d99289a5d3c46cf26f14ff6c90658d9f.html">Jolt</a></li><li class="navelem"><a class="el" href="dir_a0f33af92addde396fc27b064c5eb8a9.html">Physics</a></li><li class="navelem"><a class="el" href="_physics_settings_8h.html">PhysicsSettings.h</a></li>
  250. <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>
  251. </ul>
  252. </div>
  253. </body>
  254. </html>