cpp
/
JoltPhysics
mirror of https://github.com/jrouwe/JoltPhysics.git


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612
							<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.12.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Jolt Physics: BodyID Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="cookie.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
  extensions: ["tex2jax.js"],
  jax: ["input/TeX","output/HTML-CSS"],
});
</script>
<script type="text/javascript" async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectlogo"><img alt="Logo" src="LogoSmall.png"/></td>
  <td id="projectalign">
   <div id="projectname">Jolt Physics
   </div>
   <div id="projectbrief">A multi core friendly Game Physics Engine</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.12.0 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search',true);
  $(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){initNavTree('class_body_i_d.html',''); initResizable(true); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-attribs">Static Public Attributes</a> &#124;
<a href="class_body_i_d-members.html">List of all members</a>  </div>
  <div class="headertitle"><div class="title">BodyID Class Reference</div></div>
</div><!--header-->
<div class="contents">

<p>ID of a body. This is a way of reasoning about bodies in a multithreaded simulation while avoiding race conditions.  
 <a href="#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="_body_i_d_8h_source.html">BodyID.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a43c06446ee70f43cb4516600cb6285f4" id="r_a43c06446ee70f43cb4516600cb6285f4"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a43c06446ee70f43cb4516600cb6285f4">BodyID</a> ()</td></tr>
<tr class="memdesc:a43c06446ee70f43cb4516600cb6285f4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct invalid body ID.  <br /></td></tr>
<tr class="separator:a43c06446ee70f43cb4516600cb6285f4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4e601acab1a7ff5d5742673f8bd36530" id="r_a4e601acab1a7ff5d5742673f8bd36530"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a4e601acab1a7ff5d5742673f8bd36530">BodyID</a> (<a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a> inID)</td></tr>
<tr class="memdesc:a4e601acab1a7ff5d5742673f8bd36530"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct from index and sequence number combined in a single uint32 (use with care!)  <br /></td></tr>
<tr class="separator:a4e601acab1a7ff5d5742673f8bd36530"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a702d36c88f9ee8f41b349330e30b46b7" id="r_a702d36c88f9ee8f41b349330e30b46b7"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a702d36c88f9ee8f41b349330e30b46b7">BodyID</a> (<a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a> inID, <a class="el" href="_core_8h.html#a115946cb5fc5879545e9ccea096a6031">uint8</a> inSequenceNumber)</td></tr>
<tr class="memdesc:a702d36c88f9ee8f41b349330e30b46b7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct from index and sequence number.  <br /></td></tr>
<tr class="separator:a702d36c88f9ee8f41b349330e30b46b7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae7455ec3e8eec8ec963fb99ea4176fd6" id="r_ae7455ec3e8eec8ec963fb99ea4176fd6"><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="#ae7455ec3e8eec8ec963fb99ea4176fd6">GetIndex</a> () const</td></tr>
<tr class="memdesc:ae7455ec3e8eec8ec963fb99ea4176fd6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get index in body array.  <br /></td></tr>
<tr class="separator:ae7455ec3e8eec8ec963fb99ea4176fd6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af327d342cd7e2a6be188bc836270ba51" id="r_af327d342cd7e2a6be188bc836270ba51"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_core_8h.html#a115946cb5fc5879545e9ccea096a6031">uint8</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#af327d342cd7e2a6be188bc836270ba51">GetSequenceNumber</a> () const</td></tr>
<tr class="separator:af327d342cd7e2a6be188bc836270ba51"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaff1cc7e76b557c1ce750bea2286290c" id="r_aaff1cc7e76b557c1ce750bea2286290c"><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="#aaff1cc7e76b557c1ce750bea2286290c">GetIndexAndSequenceNumber</a> () const</td></tr>
<tr class="memdesc:aaff1cc7e76b557c1ce750bea2286290c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the index and sequence number combined in an uint32.  <br /></td></tr>
<tr class="separator:aaff1cc7e76b557c1ce750bea2286290c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0967deb4e1f200037bf32e14c4fec9e1" id="r_a0967deb4e1f200037bf32e14c4fec9e1"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a0967deb4e1f200037bf32e14c4fec9e1">IsInvalid</a> () const</td></tr>
<tr class="memdesc:a0967deb4e1f200037bf32e14c4fec9e1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if the ID is valid.  <br /></td></tr>
<tr class="separator:a0967deb4e1f200037bf32e14c4fec9e1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a717e575a515906ef45ab9f152175e6f4" id="r_a717e575a515906ef45ab9f152175e6f4"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a717e575a515906ef45ab9f152175e6f4">operator==</a> (const <a class="el" href="class_body_i_d.html">BodyID</a> &amp;inRHS) const</td></tr>
<tr class="memdesc:a717e575a515906ef45ab9f152175e6f4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Equals check.  <br /></td></tr>
<tr class="separator:a717e575a515906ef45ab9f152175e6f4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7bdbfe3abcab2c0d393187423a40c9a4" id="r_a7bdbfe3abcab2c0d393187423a40c9a4"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a7bdbfe3abcab2c0d393187423a40c9a4">operator!=</a> (const <a class="el" href="class_body_i_d.html">BodyID</a> &amp;inRHS) const</td></tr>
<tr class="memdesc:a7bdbfe3abcab2c0d393187423a40c9a4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Not equals check.  <br /></td></tr>
<tr class="separator:a7bdbfe3abcab2c0d393187423a40c9a4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a198e4c4fe4c671e614e4fa664a004b9d" id="r_a198e4c4fe4c671e614e4fa664a004b9d"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a198e4c4fe4c671e614e4fa664a004b9d">operator&lt;</a> (const <a class="el" href="class_body_i_d.html">BodyID</a> &amp;inRHS) const</td></tr>
<tr class="memdesc:a198e4c4fe4c671e614e4fa664a004b9d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Smaller than operator, can be used for sorting bodies.  <br /></td></tr>
<tr class="separator:a198e4c4fe4c671e614e4fa664a004b9d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a97ad33ad13e398831574a7a5bb97e741" id="r_a97ad33ad13e398831574a7a5bb97e741"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a97ad33ad13e398831574a7a5bb97e741">operator&gt;</a> (const <a class="el" href="class_body_i_d.html">BodyID</a> &amp;inRHS) const</td></tr>
<tr class="memdesc:a97ad33ad13e398831574a7a5bb97e741"><td class="mdescLeft">&#160;</td><td class="mdescRight">Greater than operator, can be used for sorting bodies.  <br /></td></tr>
<tr class="separator:a97ad33ad13e398831574a7a5bb97e741"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-attribs" name="pub-static-attribs"></a>
Static Public Attributes</h2></td></tr>
<tr class="memitem:afdcec75f1be1cceeb20d728bde4d4f83" id="r_afdcec75f1be1cceeb20d728bde4d4f83"><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="#afdcec75f1be1cceeb20d728bde4d4f83">cInvalidBodyID</a> = 0xffffffff</td></tr>
<tr class="memdesc:afdcec75f1be1cceeb20d728bde4d4f83"><td class="mdescLeft">&#160;</td><td class="mdescRight">The value for an invalid body ID.  <br /></td></tr>
<tr class="separator:afdcec75f1be1cceeb20d728bde4d4f83"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a934cd29a300722fea1f36408f934fb9d" id="r_a934cd29a300722fea1f36408f934fb9d"><td class="memItemLeft" align="right" valign="top">static constexpr <a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a934cd29a300722fea1f36408f934fb9d">cBroadPhaseBit</a> = 0x80000000</td></tr>
<tr class="memdesc:a934cd29a300722fea1f36408f934fb9d"><td class="mdescLeft">&#160;</td><td class="mdescRight">This bit is used by the broadphase.  <br /></td></tr>
<tr class="separator:a934cd29a300722fea1f36408f934fb9d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a89af35f2dfe916c6fa348175c3fb131b" id="r_a89af35f2dfe916c6fa348175c3fb131b"><td class="memItemLeft" align="right" valign="top">static constexpr <a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a89af35f2dfe916c6fa348175c3fb131b">cMaxBodyIndex</a> = 0x7fffff</td></tr>
<tr class="memdesc:a89af35f2dfe916c6fa348175c3fb131b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Maximum value for body index (also the maximum amount of bodies supported - 1)  <br /></td></tr>
<tr class="separator:a89af35f2dfe916c6fa348175c3fb131b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab397b404a7a9ab8ea97bfd5e2e70ce11" id="r_ab397b404a7a9ab8ea97bfd5e2e70ce11"><td class="memItemLeft" align="right" valign="top">static constexpr <a class="el" href="_core_8h.html#a115946cb5fc5879545e9ccea096a6031">uint8</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ab397b404a7a9ab8ea97bfd5e2e70ce11">cMaxSequenceNumber</a> = 0xff</td></tr>
<tr class="memdesc:ab397b404a7a9ab8ea97bfd5e2e70ce11"><td class="mdescLeft">&#160;</td><td class="mdescRight">Maximum value for the sequence number.  <br /></td></tr>
<tr class="separator:ab397b404a7a9ab8ea97bfd5e2e70ce11"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad58d0faa0a61d62988c3a0962f4e169d" id="r_ad58d0faa0a61d62988c3a0962f4e169d"><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="#ad58d0faa0a61d62988c3a0962f4e169d">cSequenceNumberShift</a> = 23</td></tr>
<tr class="memdesc:ad58d0faa0a61d62988c3a0962f4e169d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Number of bits to shift to get the sequence number.  <br /></td></tr>
<tr class="separator:ad58d0faa0a61d62988c3a0962f4e169d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>ID of a body. This is a way of reasoning about bodies in a multithreaded simulation while avoiding race conditions. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a43c06446ee70f43cb4516600cb6285f4" name="a43c06446ee70f43cb4516600cb6285f4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a43c06446ee70f43cb4516600cb6285f4">&#9670;&#160;</a></span>BodyID() <span class="overload">[1/3]</span></h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">BodyID::BodyID </td>
          <td>(</td>
          <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Construct invalid body ID. </p>

</div>
</div>
<a id="a4e601acab1a7ff5d5742673f8bd36530" name="a4e601acab1a7ff5d5742673f8bd36530"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4e601acab1a7ff5d5742673f8bd36530">&#9670;&#160;</a></span>BodyID() <span class="overload">[2/3]</span></h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">BodyID::BodyID </td>
          <td>(</td>
          <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>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">explicit</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Construct from index and sequence number combined in a single uint32 (use with care!) </p>

</div>
</div>
<a id="a702d36c88f9ee8f41b349330e30b46b7" name="a702d36c88f9ee8f41b349330e30b46b7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a702d36c88f9ee8f41b349330e30b46b7">&#9670;&#160;</a></span>BodyID() <span class="overload">[3/3]</span></h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">BodyID::BodyID </td>
          <td>(</td>
          <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>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="_core_8h.html#a115946cb5fc5879545e9ccea096a6031">uint8</a></td>          <td class="paramname"><span class="paramname"><em>inSequenceNumber</em></span>&#160;)</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">explicit</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Construct from index and sequence number. </p>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="ae7455ec3e8eec8ec963fb99ea4176fd6" name="ae7455ec3e8eec8ec963fb99ea4176fd6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae7455ec3e8eec8ec963fb99ea4176fd6">&#9670;&#160;</a></span>GetIndex()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a> BodyID::GetIndex </td>
          <td>(</td>
          <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Get index in body array. </p>

</div>
</div>
<a id="aaff1cc7e76b557c1ce750bea2286290c" name="aaff1cc7e76b557c1ce750bea2286290c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaff1cc7e76b557c1ce750bea2286290c">&#9670;&#160;</a></span>GetIndexAndSequenceNumber()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a> BodyID::GetIndexAndSequenceNumber </td>
          <td>(</td>
          <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Returns the index and sequence number combined in an uint32. </p>

</div>
</div>
<a id="af327d342cd7e2a6be188bc836270ba51" name="af327d342cd7e2a6be188bc836270ba51"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af327d342cd7e2a6be188bc836270ba51">&#9670;&#160;</a></span>GetSequenceNumber()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="_core_8h.html#a115946cb5fc5879545e9ccea096a6031">uint8</a> BodyID::GetSequenceNumber </td>
          <td>(</td>
          <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Get sequence number of body. The sequence number can be used to check if a body ID with the same body index has been reused by another body. It is mainly used in multi threaded situations where a body is removed and its body index is immediately reused by a body created from another thread. Functions querying the broadphase can (after acquiring a body lock) detect that the body has been removed (we assume that this won't happen more than 128 times in a row). </p>

</div>
</div>
<a id="a0967deb4e1f200037bf32e14c4fec9e1" name="a0967deb4e1f200037bf32e14c4fec9e1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0967deb4e1f200037bf32e14c4fec9e1">&#9670;&#160;</a></span>IsInvalid()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool BodyID::IsInvalid </td>
          <td>(</td>
          <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Check if the ID is valid. </p>

</div>
</div>
<a id="a7bdbfe3abcab2c0d393187423a40c9a4" name="a7bdbfe3abcab2c0d393187423a40c9a4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7bdbfe3abcab2c0d393187423a40c9a4">&#9670;&#160;</a></span>operator!=()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool BodyID::operator!= </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="class_body_i_d.html">BodyID</a> &amp;</td>          <td class="paramname"><span class="paramname"><em>inRHS</em></span></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Not equals check. </p>

</div>
</div>
<a id="a198e4c4fe4c671e614e4fa664a004b9d" name="a198e4c4fe4c671e614e4fa664a004b9d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a198e4c4fe4c671e614e4fa664a004b9d">&#9670;&#160;</a></span>operator&lt;()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool BodyID::operator&lt; </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="class_body_i_d.html">BodyID</a> &amp;</td>          <td class="paramname"><span class="paramname"><em>inRHS</em></span></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Smaller than operator, can be used for sorting bodies. </p>

</div>
</div>
<a id="a717e575a515906ef45ab9f152175e6f4" name="a717e575a515906ef45ab9f152175e6f4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a717e575a515906ef45ab9f152175e6f4">&#9670;&#160;</a></span>operator==()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool BodyID::operator== </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="class_body_i_d.html">BodyID</a> &amp;</td>          <td class="paramname"><span class="paramname"><em>inRHS</em></span></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Equals check. </p>

</div>
</div>
<a id="a97ad33ad13e398831574a7a5bb97e741" name="a97ad33ad13e398831574a7a5bb97e741"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a97ad33ad13e398831574a7a5bb97e741">&#9670;&#160;</a></span>operator&gt;()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool BodyID::operator&gt; </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="class_body_i_d.html">BodyID</a> &amp;</td>          <td class="paramname"><span class="paramname"><em>inRHS</em></span></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Greater than operator, can be used for sorting bodies. </p>

</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a934cd29a300722fea1f36408f934fb9d" name="a934cd29a300722fea1f36408f934fb9d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a934cd29a300722fea1f36408f934fb9d">&#9670;&#160;</a></span>cBroadPhaseBit</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a> BodyID::cBroadPhaseBit = 0x80000000</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">constexpr</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>This bit is used by the broadphase. </p>

</div>
</div>
<a id="afdcec75f1be1cceeb20d728bde4d4f83" name="afdcec75f1be1cceeb20d728bde4d4f83"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afdcec75f1be1cceeb20d728bde4d4f83">&#9670;&#160;</a></span>cInvalidBodyID</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <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> BodyID::cInvalidBodyID = 0xffffffff</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">constexpr</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>The value for an invalid body ID. </p>

</div>
</div>
<a id="a89af35f2dfe916c6fa348175c3fb131b" name="a89af35f2dfe916c6fa348175c3fb131b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a89af35f2dfe916c6fa348175c3fb131b">&#9670;&#160;</a></span>cMaxBodyIndex</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a> BodyID::cMaxBodyIndex = 0x7fffff</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">constexpr</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Maximum value for body index (also the maximum amount of bodies supported - 1) </p>

</div>
</div>
<a id="ab397b404a7a9ab8ea97bfd5e2e70ce11" name="ab397b404a7a9ab8ea97bfd5e2e70ce11"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab397b404a7a9ab8ea97bfd5e2e70ce11">&#9670;&#160;</a></span>cMaxSequenceNumber</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="_core_8h.html#a115946cb5fc5879545e9ccea096a6031">uint8</a> BodyID::cMaxSequenceNumber = 0xff</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">constexpr</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Maximum value for the sequence number. </p>

</div>
</div>
<a id="ad58d0faa0a61d62988c3a0962f4e169d" name="ad58d0faa0a61d62988c3a0962f4e169d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad58d0faa0a61d62988c3a0962f4e169d">&#9670;&#160;</a></span>cSequenceNumberShift</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a> BodyID::cSequenceNumberShift = 23</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">constexpr</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Number of bits to shift to get the sequence number. </p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>Jolt/Physics/Body/<a class="el" href="_body_i_d_8h_source.html">BodyID.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="class_body_i_d.html">BodyID</a></li>
    <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>
  </ul>
</div>
</body>
</html>