_height_field_shape_8h.html 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167
  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/Collision/Shape/HeightFieldShape.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('_height_field_shape_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="#namespaces">Namespaces</a> &#124;
  109. <a href="#var-members">Variables</a> </div>
  110. <div class="headertitle"><div class="title">HeightFieldShape.h File Reference</div></div>
  111. </div><!--header-->
  112. <div class="contents">
  113. <div class="textblock"><code>#include &lt;<a class="el" href="_shape_8h_source.html">Jolt/Physics/Collision/Shape/Shape.h</a>&gt;</code><br />
  114. <code>#include &lt;<a class="el" href="_physics_material_8h_source.html">Jolt/Physics/Collision/PhysicsMaterial.h</a>&gt;</code><br />
  115. <code>#include &lt;<a class="el" href="_debug_renderer_8h_source.html">Jolt/Renderer/DebugRenderer.h</a>&gt;</code><br />
  116. </div>
  117. <p><a href="_height_field_shape_8h_source.html">Go to the source code of this file.</a></p>
  118. <table class="memberdecls">
  119. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
  120. Classes</h2></td></tr>
  121. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_height_field_shape_settings.html">HeightFieldShapeSettings</a></td></tr>
  122. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Class that constructs a <a class="el" href="class_height_field_shape.html">HeightFieldShape</a>. <a href="class_height_field_shape_settings.html#details">More...</a><br /></td></tr>
  123. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  124. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_height_field_shape.html">HeightFieldShape</a></td></tr>
  125. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  126. </table><table class="memberdecls">
  127. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="namespaces" name="namespaces"></a>
  128. Namespaces</h2></td></tr>
  129. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_height_field_shape_constants.html">HeightFieldShapeConstants</a></td></tr>
  130. <tr class="memdesc:namespace_height_field_shape_constants"><td class="mdescLeft">&#160;</td><td class="mdescRight">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. <br /></td></tr>
  131. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  132. </table><table class="memberdecls">
  133. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="var-members" name="var-members"></a>
  134. Variables</h2></td></tr>
  135. <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="namespace_height_field_shape_constants.html#ab430dbc1ec621a77f590c281791c0922">HeightFieldShapeConstants::cNoCollisionValue</a> = FLT_MAX</td></tr>
  136. <tr class="memdesc:ab430dbc1ec621a77f590c281791c0922"><td class="mdescLeft">&#160;</td><td class="mdescRight">Value used to create gaps in the height field. <br /></td></tr>
  137. <tr class="separator:ab430dbc1ec621a77f590c281791c0922"><td class="memSeparator" colspan="2">&#160;</td></tr>
  138. <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="namespace_height_field_shape_constants.html#a37ca4958b8fd6b37a4982941ca479a85">HeightFieldShapeConstants::cStackSize</a> = 128</td></tr>
  139. <tr class="memdesc:a37ca4958b8fd6b37a4982941ca479a85"><td class="mdescLeft">&#160;</td><td class="mdescRight">Stack size to use during WalkHeightField. <br /></td></tr>
  140. <tr class="separator:a37ca4958b8fd6b37a4982941ca479a85"><td class="memSeparator" colspan="2">&#160;</td></tr>
  141. <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="namespace_height_field_shape_constants.html#a19db7caf3f2b0d72c438471292289306">HeightFieldShapeConstants::cNumBitsXY</a> = 14</td></tr>
  142. <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>
  143. <tr class="separator:a19db7caf3f2b0d72c438471292289306"><td class="memSeparator" colspan="2">&#160;</td></tr>
  144. <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="namespace_height_field_shape_constants.html#a1e58ce4b74ca86c27a71f785d9a2ec35">HeightFieldShapeConstants::cMaskBitsXY</a> = (1 &lt;&lt; <a class="el" href="namespace_height_field_shape_constants.html#a19db7caf3f2b0d72c438471292289306">cNumBitsXY</a>) - 1</td></tr>
  145. <tr class="separator:a1e58ce4b74ca86c27a71f785d9a2ec35"><td class="memSeparator" colspan="2">&#160;</td></tr>
  146. <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="namespace_height_field_shape_constants.html#ae34b30dc951d3c321c88b41bc4ac40e0">HeightFieldShapeConstants::cLevelShift</a> = 2 * <a class="el" href="namespace_height_field_shape_constants.html#a19db7caf3f2b0d72c438471292289306">cNumBitsXY</a></td></tr>
  147. <tr class="separator:ae34b30dc951d3c321c88b41bc4ac40e0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  148. <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="namespace_height_field_shape_constants.html#ac7f85b459fc57cd090cdd118a0072d4b">HeightFieldShapeConstants::cNoCollisionValue16</a> = 0xffff</td></tr>
  149. <tr class="memdesc:ac7f85b459fc57cd090cdd118a0072d4b"><td class="mdescLeft">&#160;</td><td class="mdescRight">When height samples are converted to 16 bit: <br /></td></tr>
  150. <tr class="separator:ac7f85b459fc57cd090cdd118a0072d4b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  151. <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="namespace_height_field_shape_constants.html#aa0b10266b35328efd7344f83bd4d9e8c">HeightFieldShapeConstants::cMaxHeightValue16</a> = 0xfffe</td></tr>
  152. <tr class="memdesc:aa0b10266b35328efd7344f83bd4d9e8c"><td class="mdescLeft">&#160;</td><td class="mdescRight">This is the maximum allowed height value. <br /></td></tr>
  153. <tr class="separator:aa0b10266b35328efd7344f83bd4d9e8c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  154. </table>
  155. </div><!-- contents -->
  156. </div><!-- doc-content -->
  157. <!-- start footer part -->
  158. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  159. <ul>
  160. <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="dir_1a1d05ab9ff27ca8d1ed94cd62670cdf.html">Collision</a></li><li class="navelem"><a class="el" href="dir_4df7c3fdd39bf16e2d4956412667f123.html">Shape</a></li><li class="navelem"><a class="el" href="_height_field_shape_8h.html">HeightFieldShape.h</a></li>
  161. <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>
  162. </ul>
  163. </div>
  164. </body>
  165. </html>