class_character_i_d.html 25 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506
  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: CharacterID 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_character_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-methods">Public Member Functions</a> &#124;
  108. <a href="#pub-static-methods">Static Public Member Functions</a> &#124;
  109. <a href="#pub-static-attribs">Static Public Attributes</a> &#124;
  110. <a href="class_character_i_d-members.html">List of all members</a> </div>
  111. <div class="headertitle"><div class="title">CharacterID Class Reference</div></div>
  112. </div><!--header-->
  113. <div class="contents">
  114. <p>ID of a character. Used primarily to identify deleted characters and to sort deterministically.
  115. <a href="#details">More...</a></p>
  116. <p><code>#include &lt;<a class="el" href="_character_i_d_8h_source.html">CharacterID.h</a>&gt;</code></p>
  117. <table class="memberdecls">
  118. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
  119. Public Member Functions</h2></td></tr>
  120. <tr class="memitem:a480f6a5af5a3ca4ec4dd4005e6a44994" id="r_a480f6a5af5a3ca4ec4dd4005e6a44994"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a480f6a5af5a3ca4ec4dd4005e6a44994">CharacterID</a> ()</td></tr>
  121. <tr class="memdesc:a480f6a5af5a3ca4ec4dd4005e6a44994"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct invalid character ID. <br /></td></tr>
  122. <tr class="separator:a480f6a5af5a3ca4ec4dd4005e6a44994"><td class="memSeparator" colspan="2">&#160;</td></tr>
  123. <tr class="memitem:ab97c03cacbe26394f0408e39c71bfb70" id="r_ab97c03cacbe26394f0408e39c71bfb70"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ab97c03cacbe26394f0408e39c71bfb70">CharacterID</a> (<a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a> inID)</td></tr>
  124. <tr class="memdesc:ab97c03cacbe26394f0408e39c71bfb70"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct with specific value, make sure you don't use the same value twice! <br /></td></tr>
  125. <tr class="separator:ab97c03cacbe26394f0408e39c71bfb70"><td class="memSeparator" colspan="2">&#160;</td></tr>
  126. <tr class="memitem:aab242607b7911ae770d6910c53bb06f5" id="r_aab242607b7911ae770d6910c53bb06f5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aab242607b7911ae770d6910c53bb06f5">GetValue</a> () const</td></tr>
  127. <tr class="memdesc:aab242607b7911ae770d6910c53bb06f5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the numeric value of the ID. <br /></td></tr>
  128. <tr class="separator:aab242607b7911ae770d6910c53bb06f5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  129. <tr class="memitem:a9598baffea03417a59844c9ca947da7d" id="r_a9598baffea03417a59844c9ca947da7d"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a9598baffea03417a59844c9ca947da7d">IsInvalid</a> () const</td></tr>
  130. <tr class="memdesc:a9598baffea03417a59844c9ca947da7d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if the ID is valid. <br /></td></tr>
  131. <tr class="separator:a9598baffea03417a59844c9ca947da7d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  132. <tr class="memitem:a29cc644b7b6dc9ae0f33ad09c8de06da" id="r_a29cc644b7b6dc9ae0f33ad09c8de06da"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a29cc644b7b6dc9ae0f33ad09c8de06da">operator==</a> (const <a class="el" href="class_character_i_d.html">CharacterID</a> &amp;inRHS) const</td></tr>
  133. <tr class="memdesc:a29cc644b7b6dc9ae0f33ad09c8de06da"><td class="mdescLeft">&#160;</td><td class="mdescRight">Equals check. <br /></td></tr>
  134. <tr class="separator:a29cc644b7b6dc9ae0f33ad09c8de06da"><td class="memSeparator" colspan="2">&#160;</td></tr>
  135. <tr class="memitem:a13629780bc93e4fead4a0fc3753502fb" id="r_a13629780bc93e4fead4a0fc3753502fb"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a13629780bc93e4fead4a0fc3753502fb">operator!=</a> (const <a class="el" href="class_character_i_d.html">CharacterID</a> &amp;inRHS) const</td></tr>
  136. <tr class="memdesc:a13629780bc93e4fead4a0fc3753502fb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Not equals check. <br /></td></tr>
  137. <tr class="separator:a13629780bc93e4fead4a0fc3753502fb"><td class="memSeparator" colspan="2">&#160;</td></tr>
  138. <tr class="memitem:a967ba92909d381430367bf510a9e0431" id="r_a967ba92909d381430367bf510a9e0431"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a967ba92909d381430367bf510a9e0431">operator&lt;</a> (const <a class="el" href="class_character_i_d.html">CharacterID</a> &amp;inRHS) const</td></tr>
  139. <tr class="memdesc:a967ba92909d381430367bf510a9e0431"><td class="mdescLeft">&#160;</td><td class="mdescRight">Smaller than operator, can be used for sorting characters. <br /></td></tr>
  140. <tr class="separator:a967ba92909d381430367bf510a9e0431"><td class="memSeparator" colspan="2">&#160;</td></tr>
  141. <tr class="memitem:ae3b2f60c91eb99486dc977adb67f5ad1" id="r_ae3b2f60c91eb99486dc977adb67f5ad1"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ae3b2f60c91eb99486dc977adb67f5ad1">operator&gt;</a> (const <a class="el" href="class_character_i_d.html">CharacterID</a> &amp;inRHS) const</td></tr>
  142. <tr class="memdesc:ae3b2f60c91eb99486dc977adb67f5ad1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Greater than operator, can be used for sorting characters. <br /></td></tr>
  143. <tr class="separator:ae3b2f60c91eb99486dc977adb67f5ad1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  144. <tr class="memitem:a5cdcca1b88ba8ab9a57798306282047c" id="r_a5cdcca1b88ba8ab9a57798306282047c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_core_8h.html#a60e8696a4678cd348e991a1f172e53f7">uint64</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a5cdcca1b88ba8ab9a57798306282047c">GetHash</a> () const</td></tr>
  145. <tr class="memdesc:a5cdcca1b88ba8ab9a57798306282047c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the hash for this character ID. <br /></td></tr>
  146. <tr class="separator:a5cdcca1b88ba8ab9a57798306282047c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  147. </table><table class="memberdecls">
  148. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-methods" name="pub-static-methods"></a>
  149. Static Public Member Functions</h2></td></tr>
  150. <tr class="memitem:a8e85050d3a9b1de9e00c78ea5b3de3f5" id="r_a8e85050d3a9b1de9e00c78ea5b3de3f5"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_character_i_d.html">CharacterID</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a8e85050d3a9b1de9e00c78ea5b3de3f5">sNextCharacterID</a> ()</td></tr>
  151. <tr class="memdesc:a8e85050d3a9b1de9e00c78ea5b3de3f5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Generate the next available character ID. <br /></td></tr>
  152. <tr class="separator:a8e85050d3a9b1de9e00c78ea5b3de3f5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  153. <tr class="memitem:a275cb0bb457892e34f17230d88d7eed0" id="r_a275cb0bb457892e34f17230d88d7eed0"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a275cb0bb457892e34f17230d88d7eed0">sSetNextCharacterID</a> (<a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a> inNextValue=1)</td></tr>
  154. <tr class="memdesc:a275cb0bb457892e34f17230d88d7eed0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the next available character ID, can be used after destroying all character to prepare for a second deterministic run. <br /></td></tr>
  155. <tr class="separator:a275cb0bb457892e34f17230d88d7eed0"><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="pub-static-attribs" name="pub-static-attribs"></a>
  158. Static Public Attributes</h2></td></tr>
  159. <tr class="memitem:a108567c1b34f438361149c05336e0db4" id="r_a108567c1b34f438361149c05336e0db4"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="_memory_8h.html#a91074fb218fe28954a0938c099ddd9e0">JPH_OVERRIDE_NEW_DELETE</a> constexpr <a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a108567c1b34f438361149c05336e0db4">cInvalidCharacterID</a> = 0xffffffff</td></tr>
  160. <tr class="memdesc:a108567c1b34f438361149c05336e0db4"><td class="mdescLeft">&#160;</td><td class="mdescRight">The value for an invalid character ID. <br /></td></tr>
  161. <tr class="separator:a108567c1b34f438361149c05336e0db4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  162. </table>
  163. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  164. <div class="textblock"><p>ID of a character. Used primarily to identify deleted characters and to sort deterministically. </p>
  165. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  166. <a id="a480f6a5af5a3ca4ec4dd4005e6a44994" name="a480f6a5af5a3ca4ec4dd4005e6a44994"></a>
  167. <h2 class="memtitle"><span class="permalink"><a href="#a480f6a5af5a3ca4ec4dd4005e6a44994">&#9670;&#160;</a></span>CharacterID() <span class="overload">[1/2]</span></h2>
  168. <div class="memitem">
  169. <div class="memproto">
  170. <table class="mlabels">
  171. <tr>
  172. <td class="mlabels-left">
  173. <table class="memname">
  174. <tr>
  175. <td class="memname">CharacterID::CharacterID </td>
  176. <td>(</td>
  177. <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  178. <td></td>
  179. </tr>
  180. </table>
  181. </td>
  182. <td class="mlabels-right">
  183. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  184. </tr>
  185. </table>
  186. </div><div class="memdoc">
  187. <p>Construct invalid character ID. </p>
  188. </div>
  189. </div>
  190. <a id="ab97c03cacbe26394f0408e39c71bfb70" name="ab97c03cacbe26394f0408e39c71bfb70"></a>
  191. <h2 class="memtitle"><span class="permalink"><a href="#ab97c03cacbe26394f0408e39c71bfb70">&#9670;&#160;</a></span>CharacterID() <span class="overload">[2/2]</span></h2>
  192. <div class="memitem">
  193. <div class="memproto">
  194. <table class="mlabels">
  195. <tr>
  196. <td class="mlabels-left">
  197. <table class="memname">
  198. <tr>
  199. <td class="memname">CharacterID::CharacterID </td>
  200. <td>(</td>
  201. <td class="paramtype"><a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a></td> <td class="paramname"><span class="paramname"><em>inID</em></span></td><td>)</td>
  202. <td></td>
  203. </tr>
  204. </table>
  205. </td>
  206. <td class="mlabels-right">
  207. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">explicit</span></span> </td>
  208. </tr>
  209. </table>
  210. </div><div class="memdoc">
  211. <p>Construct with specific value, make sure you don't use the same value twice! </p>
  212. </div>
  213. </div>
  214. <h2 class="groupheader">Member Function Documentation</h2>
  215. <a id="a5cdcca1b88ba8ab9a57798306282047c" name="a5cdcca1b88ba8ab9a57798306282047c"></a>
  216. <h2 class="memtitle"><span class="permalink"><a href="#a5cdcca1b88ba8ab9a57798306282047c">&#9670;&#160;</a></span>GetHash()</h2>
  217. <div class="memitem">
  218. <div class="memproto">
  219. <table class="mlabels">
  220. <tr>
  221. <td class="mlabels-left">
  222. <table class="memname">
  223. <tr>
  224. <td class="memname"><a class="el" href="_core_8h.html#a60e8696a4678cd348e991a1f172e53f7">uint64</a> CharacterID::GetHash </td>
  225. <td>(</td>
  226. <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  227. <td> const</td>
  228. </tr>
  229. </table>
  230. </td>
  231. <td class="mlabels-right">
  232. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  233. </tr>
  234. </table>
  235. </div><div class="memdoc">
  236. <p>Get the hash for this character ID. </p>
  237. </div>
  238. </div>
  239. <a id="aab242607b7911ae770d6910c53bb06f5" name="aab242607b7911ae770d6910c53bb06f5"></a>
  240. <h2 class="memtitle"><span class="permalink"><a href="#aab242607b7911ae770d6910c53bb06f5">&#9670;&#160;</a></span>GetValue()</h2>
  241. <div class="memitem">
  242. <div class="memproto">
  243. <table class="mlabels">
  244. <tr>
  245. <td class="mlabels-left">
  246. <table class="memname">
  247. <tr>
  248. <td class="memname"><a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a> CharacterID::GetValue </td>
  249. <td>(</td>
  250. <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  251. <td> const</td>
  252. </tr>
  253. </table>
  254. </td>
  255. <td class="mlabels-right">
  256. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  257. </tr>
  258. </table>
  259. </div><div class="memdoc">
  260. <p>Get the numeric value of the ID. </p>
  261. </div>
  262. </div>
  263. <a id="a9598baffea03417a59844c9ca947da7d" name="a9598baffea03417a59844c9ca947da7d"></a>
  264. <h2 class="memtitle"><span class="permalink"><a href="#a9598baffea03417a59844c9ca947da7d">&#9670;&#160;</a></span>IsInvalid()</h2>
  265. <div class="memitem">
  266. <div class="memproto">
  267. <table class="mlabels">
  268. <tr>
  269. <td class="mlabels-left">
  270. <table class="memname">
  271. <tr>
  272. <td class="memname">bool CharacterID::IsInvalid </td>
  273. <td>(</td>
  274. <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  275. <td> const</td>
  276. </tr>
  277. </table>
  278. </td>
  279. <td class="mlabels-right">
  280. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  281. </tr>
  282. </table>
  283. </div><div class="memdoc">
  284. <p>Check if the ID is valid. </p>
  285. </div>
  286. </div>
  287. <a id="a13629780bc93e4fead4a0fc3753502fb" name="a13629780bc93e4fead4a0fc3753502fb"></a>
  288. <h2 class="memtitle"><span class="permalink"><a href="#a13629780bc93e4fead4a0fc3753502fb">&#9670;&#160;</a></span>operator!=()</h2>
  289. <div class="memitem">
  290. <div class="memproto">
  291. <table class="mlabels">
  292. <tr>
  293. <td class="mlabels-left">
  294. <table class="memname">
  295. <tr>
  296. <td class="memname">bool CharacterID::operator!= </td>
  297. <td>(</td>
  298. <td class="paramtype">const <a class="el" href="class_character_i_d.html">CharacterID</a> &amp;</td> <td class="paramname"><span class="paramname"><em>inRHS</em></span></td><td>)</td>
  299. <td> const</td>
  300. </tr>
  301. </table>
  302. </td>
  303. <td class="mlabels-right">
  304. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  305. </tr>
  306. </table>
  307. </div><div class="memdoc">
  308. <p>Not equals check. </p>
  309. </div>
  310. </div>
  311. <a id="a967ba92909d381430367bf510a9e0431" name="a967ba92909d381430367bf510a9e0431"></a>
  312. <h2 class="memtitle"><span class="permalink"><a href="#a967ba92909d381430367bf510a9e0431">&#9670;&#160;</a></span>operator&lt;()</h2>
  313. <div class="memitem">
  314. <div class="memproto">
  315. <table class="mlabels">
  316. <tr>
  317. <td class="mlabels-left">
  318. <table class="memname">
  319. <tr>
  320. <td class="memname">bool CharacterID::operator&lt; </td>
  321. <td>(</td>
  322. <td class="paramtype">const <a class="el" href="class_character_i_d.html">CharacterID</a> &amp;</td> <td class="paramname"><span class="paramname"><em>inRHS</em></span></td><td>)</td>
  323. <td> const</td>
  324. </tr>
  325. </table>
  326. </td>
  327. <td class="mlabels-right">
  328. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  329. </tr>
  330. </table>
  331. </div><div class="memdoc">
  332. <p>Smaller than operator, can be used for sorting characters. </p>
  333. </div>
  334. </div>
  335. <a id="a29cc644b7b6dc9ae0f33ad09c8de06da" name="a29cc644b7b6dc9ae0f33ad09c8de06da"></a>
  336. <h2 class="memtitle"><span class="permalink"><a href="#a29cc644b7b6dc9ae0f33ad09c8de06da">&#9670;&#160;</a></span>operator==()</h2>
  337. <div class="memitem">
  338. <div class="memproto">
  339. <table class="mlabels">
  340. <tr>
  341. <td class="mlabels-left">
  342. <table class="memname">
  343. <tr>
  344. <td class="memname">bool CharacterID::operator== </td>
  345. <td>(</td>
  346. <td class="paramtype">const <a class="el" href="class_character_i_d.html">CharacterID</a> &amp;</td> <td class="paramname"><span class="paramname"><em>inRHS</em></span></td><td>)</td>
  347. <td> const</td>
  348. </tr>
  349. </table>
  350. </td>
  351. <td class="mlabels-right">
  352. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  353. </tr>
  354. </table>
  355. </div><div class="memdoc">
  356. <p>Equals check. </p>
  357. </div>
  358. </div>
  359. <a id="ae3b2f60c91eb99486dc977adb67f5ad1" name="ae3b2f60c91eb99486dc977adb67f5ad1"></a>
  360. <h2 class="memtitle"><span class="permalink"><a href="#ae3b2f60c91eb99486dc977adb67f5ad1">&#9670;&#160;</a></span>operator&gt;()</h2>
  361. <div class="memitem">
  362. <div class="memproto">
  363. <table class="mlabels">
  364. <tr>
  365. <td class="mlabels-left">
  366. <table class="memname">
  367. <tr>
  368. <td class="memname">bool CharacterID::operator&gt; </td>
  369. <td>(</td>
  370. <td class="paramtype">const <a class="el" href="class_character_i_d.html">CharacterID</a> &amp;</td> <td class="paramname"><span class="paramname"><em>inRHS</em></span></td><td>)</td>
  371. <td> const</td>
  372. </tr>
  373. </table>
  374. </td>
  375. <td class="mlabels-right">
  376. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  377. </tr>
  378. </table>
  379. </div><div class="memdoc">
  380. <p>Greater than operator, can be used for sorting characters. </p>
  381. </div>
  382. </div>
  383. <a id="a8e85050d3a9b1de9e00c78ea5b3de3f5" name="a8e85050d3a9b1de9e00c78ea5b3de3f5"></a>
  384. <h2 class="memtitle"><span class="permalink"><a href="#a8e85050d3a9b1de9e00c78ea5b3de3f5">&#9670;&#160;</a></span>sNextCharacterID()</h2>
  385. <div class="memitem">
  386. <div class="memproto">
  387. <table class="mlabels">
  388. <tr>
  389. <td class="mlabels-left">
  390. <table class="memname">
  391. <tr>
  392. <td class="memname">static <a class="el" href="class_character_i_d.html">CharacterID</a> CharacterID::sNextCharacterID </td>
  393. <td>(</td>
  394. <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  395. <td></td>
  396. </tr>
  397. </table>
  398. </td>
  399. <td class="mlabels-right">
  400. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
  401. </tr>
  402. </table>
  403. </div><div class="memdoc">
  404. <p>Generate the next available character ID. </p>
  405. </div>
  406. </div>
  407. <a id="a275cb0bb457892e34f17230d88d7eed0" name="a275cb0bb457892e34f17230d88d7eed0"></a>
  408. <h2 class="memtitle"><span class="permalink"><a href="#a275cb0bb457892e34f17230d88d7eed0">&#9670;&#160;</a></span>sSetNextCharacterID()</h2>
  409. <div class="memitem">
  410. <div class="memproto">
  411. <table class="mlabels">
  412. <tr>
  413. <td class="mlabels-left">
  414. <table class="memname">
  415. <tr>
  416. <td class="memname">static void CharacterID::sSetNextCharacterID </td>
  417. <td>(</td>
  418. <td class="paramtype"><a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a></td> <td class="paramname"><span class="paramname"><em>inNextValue</em></span><span class="paramdefsep"> = </span><span class="paramdefval">1</span></td><td>)</td>
  419. <td></td>
  420. </tr>
  421. </table>
  422. </td>
  423. <td class="mlabels-right">
  424. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
  425. </tr>
  426. </table>
  427. </div><div class="memdoc">
  428. <p>Set the next available character ID, can be used after destroying all character to prepare for a second deterministic run. </p>
  429. </div>
  430. </div>
  431. <h2 class="groupheader">Member Data Documentation</h2>
  432. <a id="a108567c1b34f438361149c05336e0db4" name="a108567c1b34f438361149c05336e0db4"></a>
  433. <h2 class="memtitle"><span class="permalink"><a href="#a108567c1b34f438361149c05336e0db4">&#9670;&#160;</a></span>cInvalidCharacterID</h2>
  434. <div class="memitem">
  435. <div class="memproto">
  436. <table class="mlabels">
  437. <tr>
  438. <td class="mlabels-left">
  439. <table class="memname">
  440. <tr>
  441. <td class="memname"><a class="el" href="_memory_8h.html#a91074fb218fe28954a0938c099ddd9e0">JPH_OVERRIDE_NEW_DELETE</a> constexpr <a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a> CharacterID::cInvalidCharacterID = 0xffffffff</td>
  442. </tr>
  443. </table>
  444. </td>
  445. <td class="mlabels-right">
  446. <span class="mlabels"><span class="mlabel">static</span><span class="mlabel">constexpr</span></span> </td>
  447. </tr>
  448. </table>
  449. </div><div class="memdoc">
  450. <p>The value for an invalid character ID. </p>
  451. </div>
  452. </div>
  453. <hr/>The documentation for this class was generated from the following file:<ul>
  454. <li>Jolt/Physics/Character/<a class="el" href="_character_i_d_8h_source.html">CharacterID.h</a></li>
  455. </ul>
  456. </div><!-- contents -->
  457. </div><!-- doc-content -->
  458. <!-- start footer part -->
  459. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  460. <ul>
  461. <li class="navelem"><a class="el" href="class_character_i_d.html">CharacterID</a></li>
  462. <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>
  463. </ul>
  464. </div>
  465. </body>
  466. </html>