namespace_height_field_shape_constants.html 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317
  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: HeightFieldShapeConstants Namespace 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('namespace_height_field_shape_constants.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="#var-members">Variables</a> </div>
  108. <div class="headertitle"><div class="title">HeightFieldShapeConstants Namespace Reference</div></div>
  109. </div><!--header-->
  110. <div class="contents">
  111. <p>Constants for <a class="el" href="class_height_field_shape.html">HeightFieldShape</a>, this was moved out of the <a class="el" href="class_height_field_shape.html">HeightFieldShape</a> because of a linker bug.
  112. <a href="#details">More...</a></p>
  113. <table class="memberdecls">
  114. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="var-members" name="var-members"></a>
  115. Variables</h2></td></tr>
  116. <tr class="memitem:ab430dbc1ec621a77f590c281791c0922" id="r_ab430dbc1ec621a77f590c281791c0922"><td class="memItemLeft" align="right" valign="top">constexpr float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ab430dbc1ec621a77f590c281791c0922">cNoCollisionValue</a> = FLT_MAX</td></tr>
  117. <tr class="memdesc:ab430dbc1ec621a77f590c281791c0922"><td class="mdescLeft">&#160;</td><td class="mdescRight">Value used to create gaps in the height field. <br /></td></tr>
  118. <tr class="separator:ab430dbc1ec621a77f590c281791c0922"><td class="memSeparator" colspan="2">&#160;</td></tr>
  119. <tr class="memitem:a37ca4958b8fd6b37a4982941ca479a85" id="r_a37ca4958b8fd6b37a4982941ca479a85"><td class="memItemLeft" align="right" valign="top">constexpr int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a37ca4958b8fd6b37a4982941ca479a85">cStackSize</a> = 128</td></tr>
  120. <tr class="memdesc:a37ca4958b8fd6b37a4982941ca479a85"><td class="mdescLeft">&#160;</td><td class="mdescRight">Stack size to use during WalkHeightField. <br /></td></tr>
  121. <tr class="separator:a37ca4958b8fd6b37a4982941ca479a85"><td class="memSeparator" colspan="2">&#160;</td></tr>
  122. <tr class="memitem:a19db7caf3f2b0d72c438471292289306" id="r_a19db7caf3f2b0d72c438471292289306"><td class="memItemLeft" align="right" valign="top">constexpr <a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a19db7caf3f2b0d72c438471292289306">cNumBitsXY</a> = 14</td></tr>
  123. <tr class="memdesc:a19db7caf3f2b0d72c438471292289306"><td class="mdescLeft">&#160;</td><td class="mdescRight">A position in the hierarchical grid is defined by a level (which grid), x and y position. We encode this in a single uint32 as: level &lt;&lt; 28 | y &lt;&lt; 14 | x. <br /></td></tr>
  124. <tr class="separator:a19db7caf3f2b0d72c438471292289306"><td class="memSeparator" colspan="2">&#160;</td></tr>
  125. <tr class="memitem:a1e58ce4b74ca86c27a71f785d9a2ec35" id="r_a1e58ce4b74ca86c27a71f785d9a2ec35"><td class="memItemLeft" align="right" valign="top">constexpr <a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a1e58ce4b74ca86c27a71f785d9a2ec35">cMaskBitsXY</a> = (1 &lt;&lt; <a class="el" href="#a19db7caf3f2b0d72c438471292289306">cNumBitsXY</a>) - 1</td></tr>
  126. <tr class="separator:a1e58ce4b74ca86c27a71f785d9a2ec35"><td class="memSeparator" colspan="2">&#160;</td></tr>
  127. <tr class="memitem:ae34b30dc951d3c321c88b41bc4ac40e0" id="r_ae34b30dc951d3c321c88b41bc4ac40e0"><td class="memItemLeft" align="right" valign="top">constexpr <a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ae34b30dc951d3c321c88b41bc4ac40e0">cLevelShift</a> = 2 * <a class="el" href="#a19db7caf3f2b0d72c438471292289306">cNumBitsXY</a></td></tr>
  128. <tr class="separator:ae34b30dc951d3c321c88b41bc4ac40e0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  129. <tr class="memitem:ac7f85b459fc57cd090cdd118a0072d4b" id="r_ac7f85b459fc57cd090cdd118a0072d4b"><td class="memItemLeft" align="right" valign="top">constexpr <a class="el" href="_core_8h.html#aea9840dd402bd5d5201bef4633398cb3">uint16</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ac7f85b459fc57cd090cdd118a0072d4b">cNoCollisionValue16</a> = 0xffff</td></tr>
  130. <tr class="memdesc:ac7f85b459fc57cd090cdd118a0072d4b"><td class="mdescLeft">&#160;</td><td class="mdescRight">When height samples are converted to 16 bit: <br /></td></tr>
  131. <tr class="separator:ac7f85b459fc57cd090cdd118a0072d4b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  132. <tr class="memitem:aa0b10266b35328efd7344f83bd4d9e8c" id="r_aa0b10266b35328efd7344f83bd4d9e8c"><td class="memItemLeft" align="right" valign="top">constexpr <a class="el" href="_core_8h.html#aea9840dd402bd5d5201bef4633398cb3">uint16</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aa0b10266b35328efd7344f83bd4d9e8c">cMaxHeightValue16</a> = 0xfffe</td></tr>
  133. <tr class="memdesc:aa0b10266b35328efd7344f83bd4d9e8c"><td class="mdescLeft">&#160;</td><td class="mdescRight">This is the maximum allowed height value. <br /></td></tr>
  134. <tr class="separator:aa0b10266b35328efd7344f83bd4d9e8c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  135. </table>
  136. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  137. <div class="textblock"><p>Constants for <a class="el" href="class_height_field_shape.html">HeightFieldShape</a>, this was moved out of the <a class="el" href="class_height_field_shape.html">HeightFieldShape</a> because of a linker bug. </p>
  138. </div><h2 class="groupheader">Variable Documentation</h2>
  139. <a id="ae34b30dc951d3c321c88b41bc4ac40e0" name="ae34b30dc951d3c321c88b41bc4ac40e0"></a>
  140. <h2 class="memtitle"><span class="permalink"><a href="#ae34b30dc951d3c321c88b41bc4ac40e0">&#9670;&#160;</a></span>cLevelShift</h2>
  141. <div class="memitem">
  142. <div class="memproto">
  143. <table class="mlabels">
  144. <tr>
  145. <td class="mlabels-left">
  146. <table class="memname">
  147. <tr>
  148. <td class="memname"><a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a> HeightFieldShapeConstants::cLevelShift = 2 * <a class="el" href="#a19db7caf3f2b0d72c438471292289306">cNumBitsXY</a></td>
  149. </tr>
  150. </table>
  151. </td>
  152. <td class="mlabels-right">
  153. <span class="mlabels"><span class="mlabel">constexpr</span></span> </td>
  154. </tr>
  155. </table>
  156. </div><div class="memdoc">
  157. </div>
  158. </div>
  159. <a id="a1e58ce4b74ca86c27a71f785d9a2ec35" name="a1e58ce4b74ca86c27a71f785d9a2ec35"></a>
  160. <h2 class="memtitle"><span class="permalink"><a href="#a1e58ce4b74ca86c27a71f785d9a2ec35">&#9670;&#160;</a></span>cMaskBitsXY</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"><a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a> HeightFieldShapeConstants::cMaskBitsXY = (1 &lt;&lt; <a class="el" href="#a19db7caf3f2b0d72c438471292289306">cNumBitsXY</a>) - 1</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. </div>
  178. </div>
  179. <a id="aa0b10266b35328efd7344f83bd4d9e8c" name="aa0b10266b35328efd7344f83bd4d9e8c"></a>
  180. <h2 class="memtitle"><span class="permalink"><a href="#aa0b10266b35328efd7344f83bd4d9e8c">&#9670;&#160;</a></span>cMaxHeightValue16</h2>
  181. <div class="memitem">
  182. <div class="memproto">
  183. <table class="mlabels">
  184. <tr>
  185. <td class="mlabels-left">
  186. <table class="memname">
  187. <tr>
  188. <td class="memname"><a class="el" href="_core_8h.html#aea9840dd402bd5d5201bef4633398cb3">uint16</a> HeightFieldShapeConstants::cMaxHeightValue16 = 0xfffe</td>
  189. </tr>
  190. </table>
  191. </td>
  192. <td class="mlabels-right">
  193. <span class="mlabels"><span class="mlabel">constexpr</span></span> </td>
  194. </tr>
  195. </table>
  196. </div><div class="memdoc">
  197. <p>This is the maximum allowed height value. </p>
  198. </div>
  199. </div>
  200. <a id="ab430dbc1ec621a77f590c281791c0922" name="ab430dbc1ec621a77f590c281791c0922"></a>
  201. <h2 class="memtitle"><span class="permalink"><a href="#ab430dbc1ec621a77f590c281791c0922">&#9670;&#160;</a></span>cNoCollisionValue</h2>
  202. <div class="memitem">
  203. <div class="memproto">
  204. <table class="mlabels">
  205. <tr>
  206. <td class="mlabels-left">
  207. <table class="memname">
  208. <tr>
  209. <td class="memname">float HeightFieldShapeConstants::cNoCollisionValue = FLT_MAX</td>
  210. </tr>
  211. </table>
  212. </td>
  213. <td class="mlabels-right">
  214. <span class="mlabels"><span class="mlabel">constexpr</span></span> </td>
  215. </tr>
  216. </table>
  217. </div><div class="memdoc">
  218. <p>Value used to create gaps in the height field. </p>
  219. </div>
  220. </div>
  221. <a id="ac7f85b459fc57cd090cdd118a0072d4b" name="ac7f85b459fc57cd090cdd118a0072d4b"></a>
  222. <h2 class="memtitle"><span class="permalink"><a href="#ac7f85b459fc57cd090cdd118a0072d4b">&#9670;&#160;</a></span>cNoCollisionValue16</h2>
  223. <div class="memitem">
  224. <div class="memproto">
  225. <table class="mlabels">
  226. <tr>
  227. <td class="mlabels-left">
  228. <table class="memname">
  229. <tr>
  230. <td class="memname"><a class="el" href="_core_8h.html#aea9840dd402bd5d5201bef4633398cb3">uint16</a> HeightFieldShapeConstants::cNoCollisionValue16 = 0xffff</td>
  231. </tr>
  232. </table>
  233. </td>
  234. <td class="mlabels-right">
  235. <span class="mlabels"><span class="mlabel">constexpr</span></span> </td>
  236. </tr>
  237. </table>
  238. </div><div class="memdoc">
  239. <p>When height samples are converted to 16 bit: </p>
  240. <p>This is the magic value for 'no collision' </p>
  241. </div>
  242. </div>
  243. <a id="a19db7caf3f2b0d72c438471292289306" name="a19db7caf3f2b0d72c438471292289306"></a>
  244. <h2 class="memtitle"><span class="permalink"><a href="#a19db7caf3f2b0d72c438471292289306">&#9670;&#160;</a></span>cNumBitsXY</h2>
  245. <div class="memitem">
  246. <div class="memproto">
  247. <table class="mlabels">
  248. <tr>
  249. <td class="mlabels-left">
  250. <table class="memname">
  251. <tr>
  252. <td class="memname"><a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a> HeightFieldShapeConstants::cNumBitsXY = 14</td>
  253. </tr>
  254. </table>
  255. </td>
  256. <td class="mlabels-right">
  257. <span class="mlabels"><span class="mlabel">constexpr</span></span> </td>
  258. </tr>
  259. </table>
  260. </div><div class="memdoc">
  261. <p>A position in the hierarchical grid is defined by a level (which grid), x and y position. We encode this in a single uint32 as: level &lt;&lt; 28 | y &lt;&lt; 14 | x. </p>
  262. </div>
  263. </div>
  264. <a id="a37ca4958b8fd6b37a4982941ca479a85" name="a37ca4958b8fd6b37a4982941ca479a85"></a>
  265. <h2 class="memtitle"><span class="permalink"><a href="#a37ca4958b8fd6b37a4982941ca479a85">&#9670;&#160;</a></span>cStackSize</h2>
  266. <div class="memitem">
  267. <div class="memproto">
  268. <table class="mlabels">
  269. <tr>
  270. <td class="mlabels-left">
  271. <table class="memname">
  272. <tr>
  273. <td class="memname">int HeightFieldShapeConstants::cStackSize = 128</td>
  274. </tr>
  275. </table>
  276. </td>
  277. <td class="mlabels-right">
  278. <span class="mlabels"><span class="mlabel">constexpr</span></span> </td>
  279. </tr>
  280. </table>
  281. </div><div class="memdoc">
  282. <p>Stack size to use during WalkHeightField. </p>
  283. </div>
  284. </div>
  285. </div><!-- contents -->
  286. </div><!-- doc-content -->
  287. <!-- start footer part -->
  288. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  289. <ul>
  290. <li class="navelem"><a class="el" href="namespace_height_field_shape_constants.html">HeightFieldShapeConstants</a></li>
  291. <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>
  292. </ul>
  293. </div>
  294. </body>
  295. </html>