class_sub_shape_i_d.html 24 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464
  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: SubShapeID Class 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('class_sub_shape_i_d.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="#pub-types">Public Types</a> &#124;
  108. <a href="#pub-methods">Public Member Functions</a> &#124;
  109. <a href="#pub-static-attribs">Static Public Attributes</a> &#124;
  110. <a href="#friends">Friends</a> &#124;
  111. <a href="class_sub_shape_i_d-members.html">List of all members</a> </div>
  112. <div class="headertitle"><div class="title">SubShapeID Class Reference</div></div>
  113. </div><!--header-->
  114. <div class="contents">
  115. <p>A sub shape id contains a path to an element (usually a triangle or other primitive type) of a compound shape.
  116. <a href="#details">More...</a></p>
  117. <p><code>#include &lt;<a class="el" href="_sub_shape_i_d_8h_source.html">SubShapeID.h</a>&gt;</code></p>
  118. <table class="memberdecls">
  119. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-types" name="pub-types"></a>
  120. Public Types</h2></td></tr>
  121. <tr class="memitem:a242b350b7f76646203b8f71879e260b3" id="r_a242b350b7f76646203b8f71879e260b3"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a242b350b7f76646203b8f71879e260b3">Type</a> = <a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a></td></tr>
  122. <tr class="memdesc:a242b350b7f76646203b8f71879e260b3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Underlying storage type. <br /></td></tr>
  123. <tr class="separator:a242b350b7f76646203b8f71879e260b3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  124. <tr class="memitem:af668479f6a45736649f0881db72637a7" id="r_af668479f6a45736649f0881db72637a7"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#af668479f6a45736649f0881db72637a7">BiggerType</a> = <a class="el" href="_core_8h.html#a60e8696a4678cd348e991a1f172e53f7">uint64</a></td></tr>
  125. <tr class="memdesc:af668479f6a45736649f0881db72637a7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Type that is bigger than the underlying storage type for operations that would otherwise overflow. <br /></td></tr>
  126. <tr class="separator:af668479f6a45736649f0881db72637a7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  127. </table><table class="memberdecls">
  128. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
  129. Public Member Functions</h2></td></tr>
  130. <tr class="memitem:af367dd3acaba3f507a19ba0d27abd299" id="r_af367dd3acaba3f507a19ba0d27abd299"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#af367dd3acaba3f507a19ba0d27abd299">SubShapeID</a> ()=default</td></tr>
  131. <tr class="memdesc:af367dd3acaba3f507a19ba0d27abd299"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor. <br /></td></tr>
  132. <tr class="separator:af367dd3acaba3f507a19ba0d27abd299"><td class="memSeparator" colspan="2">&#160;</td></tr>
  133. <tr class="memitem:a8f78ff809c7af2dfbd2e61ba2314ca9d" id="r_a8f78ff809c7af2dfbd2e61ba2314ca9d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#a242b350b7f76646203b8f71879e260b3">Type</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a8f78ff809c7af2dfbd2e61ba2314ca9d">PopID</a> (<a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a> inBits, <a class="el" href="class_sub_shape_i_d.html">SubShapeID</a> &amp;outRemainder) const</td></tr>
  134. <tr class="memdesc:a8f78ff809c7af2dfbd2e61ba2314ca9d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the next id in the chain of ids (pops parents before children) <br /></td></tr>
  135. <tr class="separator:a8f78ff809c7af2dfbd2e61ba2314ca9d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  136. <tr class="memitem:a93de7475867625a7b2dc053d2af57c2b" id="r_a93de7475867625a7b2dc053d2af57c2b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#a242b350b7f76646203b8f71879e260b3">Type</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a93de7475867625a7b2dc053d2af57c2b">GetValue</a> () const</td></tr>
  137. <tr class="memdesc:a93de7475867625a7b2dc053d2af57c2b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the value of the path to the sub shape ID. <br /></td></tr>
  138. <tr class="separator:a93de7475867625a7b2dc053d2af57c2b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  139. <tr class="memitem:a1a908b7e19b2d792793830b751a66a27" id="r_a1a908b7e19b2d792793830b751a66a27"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a1a908b7e19b2d792793830b751a66a27">SetValue</a> (<a class="el" href="#a242b350b7f76646203b8f71879e260b3">Type</a> inValue)</td></tr>
  140. <tr class="memdesc:a1a908b7e19b2d792793830b751a66a27"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the value of the sub shape ID (use with care!) <br /></td></tr>
  141. <tr class="separator:a1a908b7e19b2d792793830b751a66a27"><td class="memSeparator" colspan="2">&#160;</td></tr>
  142. <tr class="memitem:a353cb40946046c09d50b31d73c122729" id="r_a353cb40946046c09d50b31d73c122729"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a353cb40946046c09d50b31d73c122729">IsEmpty</a> () const</td></tr>
  143. <tr class="separator:a353cb40946046c09d50b31d73c122729"><td class="memSeparator" colspan="2">&#160;</td></tr>
  144. <tr class="memitem:a08bb5c298b21da17f8ff31502f5f90d7" id="r_a08bb5c298b21da17f8ff31502f5f90d7"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a08bb5c298b21da17f8ff31502f5f90d7">operator==</a> (const <a class="el" href="class_sub_shape_i_d.html">SubShapeID</a> &amp;inRHS) const</td></tr>
  145. <tr class="memdesc:a08bb5c298b21da17f8ff31502f5f90d7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check equal. <br /></td></tr>
  146. <tr class="separator:a08bb5c298b21da17f8ff31502f5f90d7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  147. <tr class="memitem:a139169c43883bdc72791c61a4c40f30d" id="r_a139169c43883bdc72791c61a4c40f30d"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a139169c43883bdc72791c61a4c40f30d">operator!=</a> (const <a class="el" href="class_sub_shape_i_d.html">SubShapeID</a> &amp;inRHS) const</td></tr>
  148. <tr class="memdesc:a139169c43883bdc72791c61a4c40f30d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check not-equal. <br /></td></tr>
  149. <tr class="separator:a139169c43883bdc72791c61a4c40f30d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  150. </table><table class="memberdecls">
  151. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-attribs" name="pub-static-attribs"></a>
  152. Static Public Attributes</h2></td></tr>
  153. <tr class="memitem:a74d6785fe41b99c0d783fb6e66c39f4d" id="r_a74d6785fe41b99c0d783fb6e66c39f4d"><td class="memItemLeft" align="right" valign="top">static constexpr <a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a74d6785fe41b99c0d783fb6e66c39f4d">MaxBits</a> = 8 * sizeof(<a class="el" href="#a242b350b7f76646203b8f71879e260b3">Type</a>)</td></tr>
  154. <tr class="memdesc:a74d6785fe41b99c0d783fb6e66c39f4d"><td class="mdescLeft">&#160;</td><td class="mdescRight">How many bits we can store in this ID. <br /></td></tr>
  155. <tr class="separator:a74d6785fe41b99c0d783fb6e66c39f4d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  156. </table><table class="memberdecls">
  157. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="friends" name="friends"></a>
  158. Friends</h2></td></tr>
  159. <tr class="memitem:a2ce5af4bbd248b1e44de16419d09beee" id="r_a2ce5af4bbd248b1e44de16419d09beee"><td class="memItemLeft" align="right" valign="top">class&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a2ce5af4bbd248b1e44de16419d09beee">SubShapeIDCreator</a></td></tr>
  160. <tr class="separator:a2ce5af4bbd248b1e44de16419d09beee"><td class="memSeparator" colspan="2">&#160;</td></tr>
  161. </table>
  162. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  163. <div class="textblock"><p>A sub shape id contains a path to an element (usually a triangle or other primitive type) of a compound shape. </p>
  164. <p>Each sub shape knows how many bits it needs to encode its ID, so knows how many bits to take from the sub shape ID.</p>
  165. <p>For example:</p><ul>
  166. <li>We have a <a class="el" href="class_compound_shape.html" title="Base class for a compound shape.">CompoundShape</a> A with 5 child shapes (identify sub shape using 3 bits AAA)</li>
  167. <li>One of its child shapes is <a class="el" href="class_compound_shape.html" title="Base class for a compound shape.">CompoundShape</a> B which has 3 child shapes (identify sub shape using 2 bits BB)</li>
  168. <li>One of its child shapes is <a class="el" href="class_mesh_shape.html">MeshShape</a> C which contains enough triangles to need 7 bits to identify a triangle (identify sub shape using 7 bits CCCCCCC, note that <a class="el" href="class_mesh_shape.html">MeshShape</a> is block based and sorts triangles spatially, you can't assume that the first triangle will have bit pattern 0000000).</li>
  169. </ul>
  170. <p>The bit pattern of the sub shape ID to identify a triangle in <a class="el" href="class_mesh_shape.html">MeshShape</a> C will then be CCCCCCCBBAAA.</p>
  171. <p>A sub shape ID will become invalid when the structure of the shape changes. For example, if a child shape is removed from a compound shape, the sub shape ID will no longer be valid. This can be a problem when caching sub shape IDs from one frame to the next. See comments at <a class="el" href="class_contact_listener.html#aa11e4d0107c2764e1c7e04eef72cb404">ContactListener::OnContactPersisted</a> / OnContactRemoved. </p>
  172. </div><h2 class="groupheader">Member Typedef Documentation</h2>
  173. <a id="af668479f6a45736649f0881db72637a7" name="af668479f6a45736649f0881db72637a7"></a>
  174. <h2 class="memtitle"><span class="permalink"><a href="#af668479f6a45736649f0881db72637a7">&#9670;&#160;</a></span>BiggerType</h2>
  175. <div class="memitem">
  176. <div class="memproto">
  177. <table class="memname">
  178. <tr>
  179. <td class="memname">using <a class="el" href="#af668479f6a45736649f0881db72637a7">SubShapeID::BiggerType</a> = <a class="el" href="_core_8h.html#a60e8696a4678cd348e991a1f172e53f7">uint64</a></td>
  180. </tr>
  181. </table>
  182. </div><div class="memdoc">
  183. <p>Type that is bigger than the underlying storage type for operations that would otherwise overflow. </p>
  184. </div>
  185. </div>
  186. <a id="a242b350b7f76646203b8f71879e260b3" name="a242b350b7f76646203b8f71879e260b3"></a>
  187. <h2 class="memtitle"><span class="permalink"><a href="#a242b350b7f76646203b8f71879e260b3">&#9670;&#160;</a></span>Type</h2>
  188. <div class="memitem">
  189. <div class="memproto">
  190. <table class="memname">
  191. <tr>
  192. <td class="memname">using <a class="el" href="#a242b350b7f76646203b8f71879e260b3">SubShapeID::Type</a> = <a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a></td>
  193. </tr>
  194. </table>
  195. </div><div class="memdoc">
  196. <p>Underlying storage type. </p>
  197. </div>
  198. </div>
  199. <h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  200. <a id="af367dd3acaba3f507a19ba0d27abd299" name="af367dd3acaba3f507a19ba0d27abd299"></a>
  201. <h2 class="memtitle"><span class="permalink"><a href="#af367dd3acaba3f507a19ba0d27abd299">&#9670;&#160;</a></span>SubShapeID()</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">SubShapeID::SubShapeID </td>
  210. <td>(</td>
  211. <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  212. <td></td>
  213. </tr>
  214. </table>
  215. </td>
  216. <td class="mlabels-right">
  217. <span class="mlabels"><span class="mlabel">default</span></span> </td>
  218. </tr>
  219. </table>
  220. </div><div class="memdoc">
  221. <p>Constructor. </p>
  222. </div>
  223. </div>
  224. <h2 class="groupheader">Member Function Documentation</h2>
  225. <a id="a93de7475867625a7b2dc053d2af57c2b" name="a93de7475867625a7b2dc053d2af57c2b"></a>
  226. <h2 class="memtitle"><span class="permalink"><a href="#a93de7475867625a7b2dc053d2af57c2b">&#9670;&#160;</a></span>GetValue()</h2>
  227. <div class="memitem">
  228. <div class="memproto">
  229. <table class="mlabels">
  230. <tr>
  231. <td class="mlabels-left">
  232. <table class="memname">
  233. <tr>
  234. <td class="memname"><a class="el" href="#a242b350b7f76646203b8f71879e260b3">Type</a> SubShapeID::GetValue </td>
  235. <td>(</td>
  236. <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  237. <td> const</td>
  238. </tr>
  239. </table>
  240. </td>
  241. <td class="mlabels-right">
  242. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  243. </tr>
  244. </table>
  245. </div><div class="memdoc">
  246. <p>Get the value of the path to the sub shape ID. </p>
  247. </div>
  248. </div>
  249. <a id="a353cb40946046c09d50b31d73c122729" name="a353cb40946046c09d50b31d73c122729"></a>
  250. <h2 class="memtitle"><span class="permalink"><a href="#a353cb40946046c09d50b31d73c122729">&#9670;&#160;</a></span>IsEmpty()</h2>
  251. <div class="memitem">
  252. <div class="memproto">
  253. <table class="mlabels">
  254. <tr>
  255. <td class="mlabels-left">
  256. <table class="memname">
  257. <tr>
  258. <td class="memname">bool SubShapeID::IsEmpty </td>
  259. <td>(</td>
  260. <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  261. <td> const</td>
  262. </tr>
  263. </table>
  264. </td>
  265. <td class="mlabels-right">
  266. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  267. </tr>
  268. </table>
  269. </div><div class="memdoc">
  270. <p>Check if there is any bits of subshape ID left. Note that this is not a 100% guarantee as the subshape ID could consist of all 1 bits. Use for asserts only. </p>
  271. </div>
  272. </div>
  273. <a id="a139169c43883bdc72791c61a4c40f30d" name="a139169c43883bdc72791c61a4c40f30d"></a>
  274. <h2 class="memtitle"><span class="permalink"><a href="#a139169c43883bdc72791c61a4c40f30d">&#9670;&#160;</a></span>operator!=()</h2>
  275. <div class="memitem">
  276. <div class="memproto">
  277. <table class="mlabels">
  278. <tr>
  279. <td class="mlabels-left">
  280. <table class="memname">
  281. <tr>
  282. <td class="memname">bool SubShapeID::operator!= </td>
  283. <td>(</td>
  284. <td class="paramtype">const <a class="el" href="class_sub_shape_i_d.html">SubShapeID</a> &amp;</td> <td class="paramname"><span class="paramname"><em>inRHS</em></span></td><td>)</td>
  285. <td> const</td>
  286. </tr>
  287. </table>
  288. </td>
  289. <td class="mlabels-right">
  290. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  291. </tr>
  292. </table>
  293. </div><div class="memdoc">
  294. <p>Check not-equal. </p>
  295. </div>
  296. </div>
  297. <a id="a08bb5c298b21da17f8ff31502f5f90d7" name="a08bb5c298b21da17f8ff31502f5f90d7"></a>
  298. <h2 class="memtitle"><span class="permalink"><a href="#a08bb5c298b21da17f8ff31502f5f90d7">&#9670;&#160;</a></span>operator==()</h2>
  299. <div class="memitem">
  300. <div class="memproto">
  301. <table class="mlabels">
  302. <tr>
  303. <td class="mlabels-left">
  304. <table class="memname">
  305. <tr>
  306. <td class="memname">bool SubShapeID::operator== </td>
  307. <td>(</td>
  308. <td class="paramtype">const <a class="el" href="class_sub_shape_i_d.html">SubShapeID</a> &amp;</td> <td class="paramname"><span class="paramname"><em>inRHS</em></span></td><td>)</td>
  309. <td> const</td>
  310. </tr>
  311. </table>
  312. </td>
  313. <td class="mlabels-right">
  314. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  315. </tr>
  316. </table>
  317. </div><div class="memdoc">
  318. <p>Check equal. </p>
  319. </div>
  320. </div>
  321. <a id="a8f78ff809c7af2dfbd2e61ba2314ca9d" name="a8f78ff809c7af2dfbd2e61ba2314ca9d"></a>
  322. <h2 class="memtitle"><span class="permalink"><a href="#a8f78ff809c7af2dfbd2e61ba2314ca9d">&#9670;&#160;</a></span>PopID()</h2>
  323. <div class="memitem">
  324. <div class="memproto">
  325. <table class="mlabels">
  326. <tr>
  327. <td class="mlabels-left">
  328. <table class="memname">
  329. <tr>
  330. <td class="memname"><a class="el" href="#a242b350b7f76646203b8f71879e260b3">Type</a> SubShapeID::PopID </td>
  331. <td>(</td>
  332. <td class="paramtype"><a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a></td> <td class="paramname"><span class="paramname"><em>inBits</em></span>, </td>
  333. </tr>
  334. <tr>
  335. <td class="paramkey"></td>
  336. <td></td>
  337. <td class="paramtype"><a class="el" href="class_sub_shape_i_d.html">SubShapeID</a> &amp;</td> <td class="paramname"><span class="paramname"><em>outRemainder</em></span>&#160;) const</td>
  338. </tr>
  339. </table>
  340. </td>
  341. <td class="mlabels-right">
  342. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  343. </tr>
  344. </table>
  345. </div><div class="memdoc">
  346. <p>Get the next id in the chain of ids (pops parents before children) </p>
  347. </div>
  348. </div>
  349. <a id="a1a908b7e19b2d792793830b751a66a27" name="a1a908b7e19b2d792793830b751a66a27"></a>
  350. <h2 class="memtitle"><span class="permalink"><a href="#a1a908b7e19b2d792793830b751a66a27">&#9670;&#160;</a></span>SetValue()</h2>
  351. <div class="memitem">
  352. <div class="memproto">
  353. <table class="mlabels">
  354. <tr>
  355. <td class="mlabels-left">
  356. <table class="memname">
  357. <tr>
  358. <td class="memname">void SubShapeID::SetValue </td>
  359. <td>(</td>
  360. <td class="paramtype"><a class="el" href="#a242b350b7f76646203b8f71879e260b3">Type</a></td> <td class="paramname"><span class="paramname"><em>inValue</em></span></td><td>)</td>
  361. <td></td>
  362. </tr>
  363. </table>
  364. </td>
  365. <td class="mlabels-right">
  366. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  367. </tr>
  368. </table>
  369. </div><div class="memdoc">
  370. <p>Set the value of the sub shape ID (use with care!) </p>
  371. </div>
  372. </div>
  373. <h2 class="groupheader">Friends And Related Symbol Documentation</h2>
  374. <a id="a2ce5af4bbd248b1e44de16419d09beee" name="a2ce5af4bbd248b1e44de16419d09beee"></a>
  375. <h2 class="memtitle"><span class="permalink"><a href="#a2ce5af4bbd248b1e44de16419d09beee">&#9670;&#160;</a></span>SubShapeIDCreator</h2>
  376. <div class="memitem">
  377. <div class="memproto">
  378. <table class="mlabels">
  379. <tr>
  380. <td class="mlabels-left">
  381. <table class="memname">
  382. <tr>
  383. <td class="memname">friend class <a class="el" href="class_sub_shape_i_d_creator.html">SubShapeIDCreator</a></td>
  384. </tr>
  385. </table>
  386. </td>
  387. <td class="mlabels-right">
  388. <span class="mlabels"><span class="mlabel">friend</span></span> </td>
  389. </tr>
  390. </table>
  391. </div><div class="memdoc">
  392. </div>
  393. </div>
  394. <h2 class="groupheader">Member Data Documentation</h2>
  395. <a id="a74d6785fe41b99c0d783fb6e66c39f4d" name="a74d6785fe41b99c0d783fb6e66c39f4d"></a>
  396. <h2 class="memtitle"><span class="permalink"><a href="#a74d6785fe41b99c0d783fb6e66c39f4d">&#9670;&#160;</a></span>MaxBits</h2>
  397. <div class="memitem">
  398. <div class="memproto">
  399. <table class="mlabels">
  400. <tr>
  401. <td class="mlabels-left">
  402. <table class="memname">
  403. <tr>
  404. <td class="memname"><a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a> SubShapeID::MaxBits = 8 * sizeof(<a class="el" href="#a242b350b7f76646203b8f71879e260b3">Type</a>)</td>
  405. </tr>
  406. </table>
  407. </td>
  408. <td class="mlabels-right">
  409. <span class="mlabels"><span class="mlabel">static</span><span class="mlabel">constexpr</span></span> </td>
  410. </tr>
  411. </table>
  412. </div><div class="memdoc">
  413. <p>How many bits we can store in this ID. </p>
  414. </div>
  415. </div>
  416. <hr/>The documentation for this class was generated from the following file:<ul>
  417. <li>Jolt/Physics/Collision/Shape/<a class="el" href="_sub_shape_i_d_8h_source.html">SubShapeID.h</a></li>
  418. </ul>
  419. </div><!-- contents -->
  420. </div><!-- doc-content -->
  421. <!-- start footer part -->
  422. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  423. <ul>
  424. <li class="navelem"><a class="el" href="class_sub_shape_i_d.html">SubShapeID</a></li>
  425. <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>
  426. </ul>
  427. </div>
  428. </body>
  429. </html>