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


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595
							<!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: BodyLockInterface 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_lock_interface.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-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="class_body_lock_interface-members.html">List of all members</a>  </div>
  <div class="headertitle"><div class="title">BodyLockInterface Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div></div>
</div><!--header-->
<div class="contents">

<p>Base class interface for locking a body. Usually you will use <a class="el" href="class_body_lock_read.html">BodyLockRead</a> / <a class="el" href="class_body_lock_write.html" title="Specialization that locks a body for writing to.">BodyLockWrite</a> / <a class="el" href="class_body_lock_multi_read.html">BodyLockMultiRead</a> / <a class="el" href="class_body_lock_multi_write.html" title="Specialization that locks multiple bodies for writing to.">BodyLockMultiWrite</a> instead.  
 <a href="#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="_body_lock_interface_8h_source.html">BodyLockInterface.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for BodyLockInterface:</div>
<div class="dyncontent">
 <div class="center">
  <img src="class_body_lock_interface.png" usemap="#BodyLockInterface_map" alt=""/>
  <map id="BodyLockInterface_map" name="BodyLockInterface_map">
<area href="class_non_copyable.html" title="Class that makes another class non-copyable. Usage: Inherit from NonCopyable." alt="NonCopyable" shape="rect" coords="86,0,248,24"/>
<area href="class_body_lock_interface_locking.html" title="Implementation that uses the body manager to lock the correct mutex for a body." alt="BodyLockInterfaceLocking" shape="rect" coords="0,112,162,136"/>
<area href="class_body_lock_interface_no_lock.html" title="Implementation that performs no locking (assumes the lock has already been taken)" alt="BodyLockInterfaceNoLock" shape="rect" coords="172,112,334,136"/>
  </map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-types" name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a771acdfb6a269ae145b3b7867b560ebb" id="r_a771acdfb6a269ae145b3b7867b560ebb"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a771acdfb6a269ae145b3b7867b560ebb">MutexMask</a> = <a class="el" href="class_body_manager.html#aee0d75a5176680f7c00728fa33cbe9e2">BodyManager::MutexMask</a></td></tr>
<tr class="memdesc:a771acdfb6a269ae145b3b7867b560ebb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Redefine MutexMask.  <br /></td></tr>
<tr class="separator:a771acdfb6a269ae145b3b7867b560ebb"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><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:a502df83afc4e8e8e77d7a8b2993c1f8e" id="r_a502df83afc4e8e8e77d7a8b2993c1f8e"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a502df83afc4e8e8e77d7a8b2993c1f8e">BodyLockInterface</a> (<a class="el" href="class_body_manager.html">BodyManager</a> &amp;inBodyManager)</td></tr>
<tr class="memdesc:a502df83afc4e8e8e77d7a8b2993c1f8e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <br /></td></tr>
<tr class="separator:a502df83afc4e8e8e77d7a8b2993c1f8e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad019e65f235b7cc04199696fa0ef1fc2" id="r_ad019e65f235b7cc04199696fa0ef1fc2"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ad019e65f235b7cc04199696fa0ef1fc2">~BodyLockInterface</a> ()=default</td></tr>
<tr class="separator:ad019e65f235b7cc04199696fa0ef1fc2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a76bee9cac091824dea84407a94a557f6" id="r_a76bee9cac091824dea84407a94a557f6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#a771acdfb6a269ae145b3b7867b560ebb">MutexMask</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a76bee9cac091824dea84407a94a557f6">GetAllBodiesMutexMask</a> () const</td></tr>
<tr class="memdesc:a76bee9cac091824dea84407a94a557f6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the mask needed to lock all bodies.  <br /></td></tr>
<tr class="separator:a76bee9cac091824dea84407a94a557f6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a69aba1e1549e9bc55c1ccd4b68cc171a" id="r_a69aba1e1549e9bc55c1ccd4b68cc171a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_body.html">Body</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a69aba1e1549e9bc55c1ccd4b68cc171a">TryGetBody</a> (const <a class="el" href="class_body_i_d.html">BodyID</a> &amp;inBodyID) const</td></tr>
<tr class="memdesc:a69aba1e1549e9bc55c1ccd4b68cc171a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Convert body ID to body.  <br /></td></tr>
<tr class="separator:a69aba1e1549e9bc55c1ccd4b68cc171a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr><td colspan="2"><div class="groupHeader">Locking functions</div></td></tr>
<tr class="memitem:a8a771b3c89803fee5e6d1c90f2f96a07" id="r_a8a771b3c89803fee5e6d1c90f2f96a07"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="class_shared_mutex.html">SharedMutex</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a8a771b3c89803fee5e6d1c90f2f96a07">LockRead</a> (const <a class="el" href="class_body_i_d.html">BodyID</a> &amp;inBodyID) const =0</td></tr>
<tr class="separator:a8a771b3c89803fee5e6d1c90f2f96a07"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a01f2a12bf7200265b64aae3effd3a82d" id="r_a01f2a12bf7200265b64aae3effd3a82d"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a01f2a12bf7200265b64aae3effd3a82d">UnlockRead</a> (<a class="el" href="class_shared_mutex.html">SharedMutex</a> *inMutex) const =0</td></tr>
<tr class="separator:a01f2a12bf7200265b64aae3effd3a82d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9d17ddb805293e6495f3569a4ed32969" id="r_a9d17ddb805293e6495f3569a4ed32969"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="class_shared_mutex.html">SharedMutex</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a9d17ddb805293e6495f3569a4ed32969">LockWrite</a> (const <a class="el" href="class_body_i_d.html">BodyID</a> &amp;inBodyID) const =0</td></tr>
<tr class="separator:a9d17ddb805293e6495f3569a4ed32969"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a786e43ce709b4214d7ebda26961d4725" id="r_a786e43ce709b4214d7ebda26961d4725"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a786e43ce709b4214d7ebda26961d4725">UnlockWrite</a> (<a class="el" href="class_shared_mutex.html">SharedMutex</a> *inMutex) const =0</td></tr>
<tr class="separator:a786e43ce709b4214d7ebda26961d4725"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr><td colspan="2"><div class="groupHeader">Batch locking functions</div></td></tr>
<tr class="memitem:a3bfe95981277029552253f953f5e2179" id="r_a3bfe95981277029552253f953f5e2179"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="#a771acdfb6a269ae145b3b7867b560ebb">MutexMask</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a3bfe95981277029552253f953f5e2179">GetMutexMask</a> (const <a class="el" href="class_body_i_d.html">BodyID</a> *inBodies, int inNumber) const =0</td></tr>
<tr class="separator:a3bfe95981277029552253f953f5e2179"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae146eecd6e18c0b9b5e19f72a2696572" id="r_ae146eecd6e18c0b9b5e19f72a2696572"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ae146eecd6e18c0b9b5e19f72a2696572">LockRead</a> (<a class="el" href="#a771acdfb6a269ae145b3b7867b560ebb">MutexMask</a> inMutexMask) const =0</td></tr>
<tr class="separator:ae146eecd6e18c0b9b5e19f72a2696572"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a702e6d9dba53f21d054dc51397bd9c39" id="r_a702e6d9dba53f21d054dc51397bd9c39"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a702e6d9dba53f21d054dc51397bd9c39">UnlockRead</a> (<a class="el" href="#a771acdfb6a269ae145b3b7867b560ebb">MutexMask</a> inMutexMask) const =0</td></tr>
<tr class="separator:a702e6d9dba53f21d054dc51397bd9c39"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8ec7191e60755953798e570d01c0b30b" id="r_a8ec7191e60755953798e570d01c0b30b"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a8ec7191e60755953798e570d01c0b30b">LockWrite</a> (<a class="el" href="#a771acdfb6a269ae145b3b7867b560ebb">MutexMask</a> inMutexMask) const =0</td></tr>
<tr class="separator:a8ec7191e60755953798e570d01c0b30b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae7ab56617d45d42ee2935b0eaf9b57e6" id="r_ae7ab56617d45d42ee2935b0eaf9b57e6"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ae7ab56617d45d42ee2935b0eaf9b57e6">UnlockWrite</a> (<a class="el" href="#a771acdfb6a269ae145b3b7867b560ebb">MutexMask</a> inMutexMask) const =0</td></tr>
<tr class="separator:ae7ab56617d45d42ee2935b0eaf9b57e6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_class_non_copyable"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pub_methods_class_non_copyable')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="class_non_copyable.html">NonCopyable</a></td></tr>
<tr class="memitem:a809b6e4ade7ae32f6d248f2a3b783d45 inherit pub_methods_class_non_copyable" id="r_a809b6e4ade7ae32f6d248f2a3b783d45"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_non_copyable.html#a809b6e4ade7ae32f6d248f2a3b783d45">NonCopyable</a> ()=default</td></tr>
<tr class="separator:a809b6e4ade7ae32f6d248f2a3b783d45 inherit pub_methods_class_non_copyable"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a501d34ffcc34b30de6d541887a901057 inherit pub_methods_class_non_copyable" id="r_a501d34ffcc34b30de6d541887a901057"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_non_copyable.html#a501d34ffcc34b30de6d541887a901057">NonCopyable</a> (const <a class="el" href="class_non_copyable.html">NonCopyable</a> &amp;)=delete</td></tr>
<tr class="separator:a501d34ffcc34b30de6d541887a901057 inherit pub_methods_class_non_copyable"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaf9b12dcaae80c9d304df7a941d4e21f inherit pub_methods_class_non_copyable" id="r_aaf9b12dcaae80c9d304df7a941d4e21f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_non_copyable.html#aaf9b12dcaae80c9d304df7a941d4e21f">operator=</a> (const <a class="el" href="class_non_copyable.html">NonCopyable</a> &amp;)=delete</td></tr>
<tr class="separator:aaf9b12dcaae80c9d304df7a941d4e21f inherit pub_methods_class_non_copyable"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-attribs" name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:a061f3644dbda5115a837f9acbf0d3f6e" id="r_a061f3644dbda5115a837f9acbf0d3f6e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_body_manager.html">BodyManager</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a061f3644dbda5115a837f9acbf0d3f6e">mBodyManager</a></td></tr>
<tr class="separator:a061f3644dbda5115a837f9acbf0d3f6e"><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>Base class interface for locking a body. Usually you will use <a class="el" href="class_body_lock_read.html">BodyLockRead</a> / <a class="el" href="class_body_lock_write.html" title="Specialization that locks a body for writing to.">BodyLockWrite</a> / <a class="el" href="class_body_lock_multi_read.html">BodyLockMultiRead</a> / <a class="el" href="class_body_lock_multi_write.html" title="Specialization that locks multiple bodies for writing to.">BodyLockMultiWrite</a> instead. </p>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a id="a771acdfb6a269ae145b3b7867b560ebb" name="a771acdfb6a269ae145b3b7867b560ebb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a771acdfb6a269ae145b3b7867b560ebb">&#9670;&#160;</a></span>MutexMask</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">using <a class="el" href="#a771acdfb6a269ae145b3b7867b560ebb">BodyLockInterface::MutexMask</a> = <a class="el" href="class_body_manager.html#aee0d75a5176680f7c00728fa33cbe9e2">BodyManager::MutexMask</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Redefine MutexMask. </p>

</div>
</div>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a502df83afc4e8e8e77d7a8b2993c1f8e" name="a502df83afc4e8e8e77d7a8b2993c1f8e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a502df83afc4e8e8e77d7a8b2993c1f8e">&#9670;&#160;</a></span>BodyLockInterface()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">BodyLockInterface::BodyLockInterface </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="class_body_manager.html">BodyManager</a> &amp;</td>          <td class="paramname"><span class="paramname"><em>inBodyManager</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>Constructor. </p>

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

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual BodyLockInterface::~BodyLockInterface </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">virtual</span><span class="mlabel">default</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a76bee9cac091824dea84407a94a557f6" name="a76bee9cac091824dea84407a94a557f6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a76bee9cac091824dea84407a94a557f6">&#9670;&#160;</a></span>GetAllBodiesMutexMask()</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="#a771acdfb6a269ae145b3b7867b560ebb">MutexMask</a> BodyLockInterface::GetAllBodiesMutexMask </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 the mask needed to lock all bodies. </p>

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

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="#a771acdfb6a269ae145b3b7867b560ebb">MutexMask</a> BodyLockInterface::GetMutexMask </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="class_body_i_d.html">BodyID</a> *</td>          <td class="paramname"><span class="paramname"><em>inBodies</em></span>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int</td>          <td class="paramname"><span class="paramname"><em>inNumber</em></span>&#160;) const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Implemented in <a class="el" href="class_body_lock_interface_locking.html#ad5654fb1a33df17e9bc1aada33b5dcab">BodyLockInterfaceLocking</a>, and <a class="el" href="class_body_lock_interface_no_lock.html#a49bd93a0cda1adce88e20921774d94a6">BodyLockInterfaceNoLock</a>.</p>

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

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="class_shared_mutex.html">SharedMutex</a> * BodyLockInterface::LockRead </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>inBodyID</em></span></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Implemented in <a class="el" href="class_body_lock_interface_locking.html#a5324dd788c8358e092527e3c68d9a682">BodyLockInterfaceLocking</a>, and <a class="el" href="class_body_lock_interface_no_lock.html#a53465d00162795f90dd2fba3910723bd">BodyLockInterfaceNoLock</a>.</p>

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

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual void BodyLockInterface::LockRead </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="#a771acdfb6a269ae145b3b7867b560ebb">MutexMask</a></td>          <td class="paramname"><span class="paramname"><em>inMutexMask</em></span></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Implemented in <a class="el" href="class_body_lock_interface_locking.html#adedab6f41d8e601a0780462678235b19">BodyLockInterfaceLocking</a>, and <a class="el" href="class_body_lock_interface_no_lock.html#ae134b2fa9fc485ed7b6db8283d6b2088">BodyLockInterfaceNoLock</a>.</p>

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

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="class_shared_mutex.html">SharedMutex</a> * BodyLockInterface::LockWrite </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>inBodyID</em></span></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Implemented in <a class="el" href="class_body_lock_interface_locking.html#a109d30a7639dde11979c5e1ccb62707c">BodyLockInterfaceLocking</a>, and <a class="el" href="class_body_lock_interface_no_lock.html#a785146858bb1499ca0af9a45aeaeef2f">BodyLockInterfaceNoLock</a>.</p>

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

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual void BodyLockInterface::LockWrite </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="#a771acdfb6a269ae145b3b7867b560ebb">MutexMask</a></td>          <td class="paramname"><span class="paramname"><em>inMutexMask</em></span></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Implemented in <a class="el" href="class_body_lock_interface_locking.html#a518e5c21911dbfd54f7f2c6390dc7d35">BodyLockInterfaceLocking</a>, and <a class="el" href="class_body_lock_interface_no_lock.html#a235037dc08d8880dab6ab247f4066b8a">BodyLockInterfaceNoLock</a>.</p>

</div>
</div>
<a id="a69aba1e1549e9bc55c1ccd4b68cc171a" name="a69aba1e1549e9bc55c1ccd4b68cc171a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a69aba1e1549e9bc55c1ccd4b68cc171a">&#9670;&#160;</a></span>TryGetBody()</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="class_body.html">Body</a> * BodyLockInterface::TryGetBody </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>inBodyID</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>Convert body ID to body. </p>

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

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual void BodyLockInterface::UnlockRead </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="#a771acdfb6a269ae145b3b7867b560ebb">MutexMask</a></td>          <td class="paramname"><span class="paramname"><em>inMutexMask</em></span></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Implemented in <a class="el" href="class_body_lock_interface_locking.html#a23ed101c9ed1d8266dc7742f002f908b">BodyLockInterfaceLocking</a>, and <a class="el" href="class_body_lock_interface_no_lock.html#a4d836b80b0c07e560833952731ccf407">BodyLockInterfaceNoLock</a>.</p>

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

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual void BodyLockInterface::UnlockRead </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="class_shared_mutex.html">SharedMutex</a> *</td>          <td class="paramname"><span class="paramname"><em>inMutex</em></span></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Implemented in <a class="el" href="class_body_lock_interface_locking.html#a523d0b2ec0c63a14964ff67b407cf8dd">BodyLockInterfaceLocking</a>, and <a class="el" href="class_body_lock_interface_no_lock.html#ae073928dc06535a51719369ca70dda2f">BodyLockInterfaceNoLock</a>.</p>

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

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual void BodyLockInterface::UnlockWrite </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="#a771acdfb6a269ae145b3b7867b560ebb">MutexMask</a></td>          <td class="paramname"><span class="paramname"><em>inMutexMask</em></span></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Implemented in <a class="el" href="class_body_lock_interface_locking.html#a25822b34a4987988f2100790c1279eb2">BodyLockInterfaceLocking</a>, and <a class="el" href="class_body_lock_interface_no_lock.html#ab745b6ced33c003efdc5877c6756128d">BodyLockInterfaceNoLock</a>.</p>

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

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual void BodyLockInterface::UnlockWrite </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="class_shared_mutex.html">SharedMutex</a> *</td>          <td class="paramname"><span class="paramname"><em>inMutex</em></span></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Implemented in <a class="el" href="class_body_lock_interface_locking.html#a0651763a01d010609627cf84153b65d9">BodyLockInterfaceLocking</a>, and <a class="el" href="class_body_lock_interface_no_lock.html#a6ecbc0cbe52514464956d3a49b73d79f">BodyLockInterfaceNoLock</a>.</p>

</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a061f3644dbda5115a837f9acbf0d3f6e" name="a061f3644dbda5115a837f9acbf0d3f6e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a061f3644dbda5115a837f9acbf0d3f6e">&#9670;&#160;</a></span>mBodyManager</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="class_body_manager.html">BodyManager</a>&amp; BodyLockInterface::mBodyManager</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>Jolt/Physics/Body/<a class="el" href="_body_lock_interface_8h_source.html">BodyLockInterface.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_lock_interface.html">BodyLockInterface</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>