class_body_lock_interface_locking.html 31 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475
  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: BodyLockInterfaceLocking 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_body_lock_interface_locking.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="class_body_lock_interface_locking-members.html">List of all members</a> </div>
  109. <div class="headertitle"><div class="title">BodyLockInterfaceLocking Class Reference<span class="mlabels"><span class="mlabel">final</span></span></div></div>
  110. </div><!--header-->
  111. <div class="contents">
  112. <p>Implementation that uses the body manager to lock the correct mutex for a body.
  113. <a href="#details">More...</a></p>
  114. <p><code>#include &lt;<a class="el" href="_body_lock_interface_8h_source.html">BodyLockInterface.h</a>&gt;</code></p>
  115. <div class="dynheader">
  116. Inheritance diagram for BodyLockInterfaceLocking:</div>
  117. <div class="dyncontent">
  118. <div class="center">
  119. <img src="class_body_lock_interface_locking.png" usemap="#BodyLockInterfaceLocking_map" alt=""/>
  120. <map id="BodyLockInterfaceLocking_map" name="BodyLockInterfaceLocking_map">
  121. <area href="class_body_lock_interface.html" title="Base class interface for locking a body. Usually you will use BodyLockRead / BodyLockWrite / BodyLock..." alt="BodyLockInterface" shape="rect" coords="0,56,162,80"/>
  122. <area href="class_non_copyable.html" title="Class that makes another class non-copyable. Usage: Inherit from NonCopyable." alt="NonCopyable" shape="rect" coords="0,0,162,24"/>
  123. </map>
  124. </div></div>
  125. <table class="memberdecls">
  126. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
  127. Public Member Functions</h2></td></tr>
  128. <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>
  129. <tr class="memdesc:a502df83afc4e8e8e77d7a8b2993c1f8e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor. <br /></td></tr>
  130. <tr class="separator:a502df83afc4e8e8e77d7a8b2993c1f8e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  131. <tr><td colspan="2"><div class="groupHeader">Locking functions</div></td></tr>
  132. <tr class="memitem:a5324dd788c8358e092527e3c68d9a682" id="r_a5324dd788c8358e092527e3c68d9a682"><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="#a5324dd788c8358e092527e3c68d9a682">LockRead</a> (const <a class="el" href="class_body_i_d.html">BodyID</a> &amp;inBodyID) const override</td></tr>
  133. <tr class="separator:a5324dd788c8358e092527e3c68d9a682"><td class="memSeparator" colspan="2">&#160;</td></tr>
  134. <tr class="memitem:a523d0b2ec0c63a14964ff67b407cf8dd" id="r_a523d0b2ec0c63a14964ff67b407cf8dd"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a523d0b2ec0c63a14964ff67b407cf8dd">UnlockRead</a> (<a class="el" href="class_shared_mutex.html">SharedMutex</a> *inMutex) const override</td></tr>
  135. <tr class="separator:a523d0b2ec0c63a14964ff67b407cf8dd"><td class="memSeparator" colspan="2">&#160;</td></tr>
  136. <tr class="memitem:a109d30a7639dde11979c5e1ccb62707c" id="r_a109d30a7639dde11979c5e1ccb62707c"><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="#a109d30a7639dde11979c5e1ccb62707c">LockWrite</a> (const <a class="el" href="class_body_i_d.html">BodyID</a> &amp;inBodyID) const override</td></tr>
  137. <tr class="separator:a109d30a7639dde11979c5e1ccb62707c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  138. <tr class="memitem:a0651763a01d010609627cf84153b65d9" id="r_a0651763a01d010609627cf84153b65d9"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a0651763a01d010609627cf84153b65d9">UnlockWrite</a> (<a class="el" href="class_shared_mutex.html">SharedMutex</a> *inMutex) const override</td></tr>
  139. <tr class="separator:a0651763a01d010609627cf84153b65d9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  140. <tr><td colspan="2"><div class="groupHeader">Batch locking functions</div></td></tr>
  141. <tr class="memitem:ad5654fb1a33df17e9bc1aada33b5dcab" id="r_ad5654fb1a33df17e9bc1aada33b5dcab"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="class_body_lock_interface.html#a771acdfb6a269ae145b3b7867b560ebb">MutexMask</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ad5654fb1a33df17e9bc1aada33b5dcab">GetMutexMask</a> (const <a class="el" href="class_body_i_d.html">BodyID</a> *inBodies, int inNumber) const override</td></tr>
  142. <tr class="separator:ad5654fb1a33df17e9bc1aada33b5dcab"><td class="memSeparator" colspan="2">&#160;</td></tr>
  143. <tr class="memitem:adedab6f41d8e601a0780462678235b19" id="r_adedab6f41d8e601a0780462678235b19"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#adedab6f41d8e601a0780462678235b19">LockRead</a> (<a class="el" href="class_body_lock_interface.html#a771acdfb6a269ae145b3b7867b560ebb">MutexMask</a> inMutexMask) const override</td></tr>
  144. <tr class="separator:adedab6f41d8e601a0780462678235b19"><td class="memSeparator" colspan="2">&#160;</td></tr>
  145. <tr class="memitem:a23ed101c9ed1d8266dc7742f002f908b" id="r_a23ed101c9ed1d8266dc7742f002f908b"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a23ed101c9ed1d8266dc7742f002f908b">UnlockRead</a> (<a class="el" href="class_body_lock_interface.html#a771acdfb6a269ae145b3b7867b560ebb">MutexMask</a> inMutexMask) const override</td></tr>
  146. <tr class="separator:a23ed101c9ed1d8266dc7742f002f908b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  147. <tr class="memitem:a518e5c21911dbfd54f7f2c6390dc7d35" id="r_a518e5c21911dbfd54f7f2c6390dc7d35"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a518e5c21911dbfd54f7f2c6390dc7d35">LockWrite</a> (<a class="el" href="class_body_lock_interface.html#a771acdfb6a269ae145b3b7867b560ebb">MutexMask</a> inMutexMask) const override</td></tr>
  148. <tr class="separator:a518e5c21911dbfd54f7f2c6390dc7d35"><td class="memSeparator" colspan="2">&#160;</td></tr>
  149. <tr class="memitem:a25822b34a4987988f2100790c1279eb2" id="r_a25822b34a4987988f2100790c1279eb2"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a25822b34a4987988f2100790c1279eb2">UnlockWrite</a> (<a class="el" href="class_body_lock_interface.html#a771acdfb6a269ae145b3b7867b560ebb">MutexMask</a> inMutexMask) const override</td></tr>
  150. <tr class="separator:a25822b34a4987988f2100790c1279eb2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  151. <tr class="inherit_header pub_methods_class_body_lock_interface"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pub_methods_class_body_lock_interface')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="class_body_lock_interface.html">BodyLockInterface</a></td></tr>
  152. <tr class="memitem:a502df83afc4e8e8e77d7a8b2993c1f8e inherit pub_methods_class_body_lock_interface" id="r_a502df83afc4e8e8e77d7a8b2993c1f8e"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_body_lock_interface.html#a502df83afc4e8e8e77d7a8b2993c1f8e">BodyLockInterface</a> (<a class="el" href="class_body_manager.html">BodyManager</a> &amp;inBodyManager)</td></tr>
  153. <tr class="memdesc:a502df83afc4e8e8e77d7a8b2993c1f8e inherit pub_methods_class_body_lock_interface"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor. <br /></td></tr>
  154. <tr class="separator:a502df83afc4e8e8e77d7a8b2993c1f8e inherit pub_methods_class_body_lock_interface"><td class="memSeparator" colspan="2">&#160;</td></tr>
  155. <tr class="memitem:ad019e65f235b7cc04199696fa0ef1fc2 inherit pub_methods_class_body_lock_interface" id="r_ad019e65f235b7cc04199696fa0ef1fc2"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_body_lock_interface.html#ad019e65f235b7cc04199696fa0ef1fc2">~BodyLockInterface</a> ()=default</td></tr>
  156. <tr class="separator:ad019e65f235b7cc04199696fa0ef1fc2 inherit pub_methods_class_body_lock_interface"><td class="memSeparator" colspan="2">&#160;</td></tr>
  157. <tr class="memitem:a76bee9cac091824dea84407a94a557f6 inherit pub_methods_class_body_lock_interface" id="r_a76bee9cac091824dea84407a94a557f6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_body_lock_interface.html#a771acdfb6a269ae145b3b7867b560ebb">MutexMask</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_body_lock_interface.html#a76bee9cac091824dea84407a94a557f6">GetAllBodiesMutexMask</a> () const</td></tr>
  158. <tr class="memdesc:a76bee9cac091824dea84407a94a557f6 inherit pub_methods_class_body_lock_interface"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the mask needed to lock all bodies. <br /></td></tr>
  159. <tr class="separator:a76bee9cac091824dea84407a94a557f6 inherit pub_methods_class_body_lock_interface"><td class="memSeparator" colspan="2">&#160;</td></tr>
  160. <tr class="memitem:a69aba1e1549e9bc55c1ccd4b68cc171a inherit pub_methods_class_body_lock_interface" 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="class_body_lock_interface.html#a69aba1e1549e9bc55c1ccd4b68cc171a">TryGetBody</a> (const <a class="el" href="class_body_i_d.html">BodyID</a> &amp;inBodyID) const</td></tr>
  161. <tr class="memdesc:a69aba1e1549e9bc55c1ccd4b68cc171a inherit pub_methods_class_body_lock_interface"><td class="mdescLeft">&#160;</td><td class="mdescRight">Convert body ID to body. <br /></td></tr>
  162. <tr class="separator:a69aba1e1549e9bc55c1ccd4b68cc171a inherit pub_methods_class_body_lock_interface"><td class="memSeparator" colspan="2">&#160;</td></tr>
  163. <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>
  164. <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>
  165. <tr class="separator:a809b6e4ade7ae32f6d248f2a3b783d45 inherit pub_methods_class_non_copyable"><td class="memSeparator" colspan="2">&#160;</td></tr>
  166. <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>
  167. <tr class="separator:a501d34ffcc34b30de6d541887a901057 inherit pub_methods_class_non_copyable"><td class="memSeparator" colspan="2">&#160;</td></tr>
  168. <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>
  169. <tr class="separator:aaf9b12dcaae80c9d304df7a941d4e21f inherit pub_methods_class_non_copyable"><td class="memSeparator" colspan="2">&#160;</td></tr>
  170. </table><table class="memberdecls">
  171. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="inherited" name="inherited"></a>
  172. Additional Inherited Members</h2></td></tr>
  173. <tr class="inherit_header pub_types_class_body_lock_interface"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pub_types_class_body_lock_interface')"><img src="closed.png" alt="-"/>&#160;Public Types inherited from <a class="el" href="class_body_lock_interface.html">BodyLockInterface</a></td></tr>
  174. <tr class="memitem:a771acdfb6a269ae145b3b7867b560ebb inherit pub_types_class_body_lock_interface" id="r_a771acdfb6a269ae145b3b7867b560ebb"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_body_lock_interface.html#a771acdfb6a269ae145b3b7867b560ebb">MutexMask</a> = <a class="el" href="class_body_manager.html#aee0d75a5176680f7c00728fa33cbe9e2">BodyManager::MutexMask</a></td></tr>
  175. <tr class="memdesc:a771acdfb6a269ae145b3b7867b560ebb inherit pub_types_class_body_lock_interface"><td class="mdescLeft">&#160;</td><td class="mdescRight">Redefine MutexMask. <br /></td></tr>
  176. <tr class="separator:a771acdfb6a269ae145b3b7867b560ebb inherit pub_types_class_body_lock_interface"><td class="memSeparator" colspan="2">&#160;</td></tr>
  177. <tr class="inherit_header pro_attribs_class_body_lock_interface"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pro_attribs_class_body_lock_interface')"><img src="closed.png" alt="-"/>&#160;Protected Attributes inherited from <a class="el" href="class_body_lock_interface.html">BodyLockInterface</a></td></tr>
  178. <tr class="memitem:a061f3644dbda5115a837f9acbf0d3f6e inherit pro_attribs_class_body_lock_interface" 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="class_body_lock_interface.html#a061f3644dbda5115a837f9acbf0d3f6e">mBodyManager</a></td></tr>
  179. <tr class="separator:a061f3644dbda5115a837f9acbf0d3f6e inherit pro_attribs_class_body_lock_interface"><td class="memSeparator" colspan="2">&#160;</td></tr>
  180. </table>
  181. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  182. <div class="textblock"><p>Implementation that uses the body manager to lock the correct mutex for a body. </p>
  183. </div><h2 class="groupheader">Member Function Documentation</h2>
  184. <a id="a502df83afc4e8e8e77d7a8b2993c1f8e" name="a502df83afc4e8e8e77d7a8b2993c1f8e"></a>
  185. <h2 class="memtitle"><span class="permalink"><a href="#a502df83afc4e8e8e77d7a8b2993c1f8e">&#9670;&#160;</a></span>BodyLockInterface()</h2>
  186. <div class="memitem">
  187. <div class="memproto">
  188. <table class="mlabels">
  189. <tr>
  190. <td class="mlabels-left">
  191. <table class="memname">
  192. <tr>
  193. <td class="memname">BodyLockInterface::BodyLockInterface </td>
  194. <td>(</td>
  195. <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>
  196. <td></td>
  197. </tr>
  198. </table>
  199. </td>
  200. <td class="mlabels-right">
  201. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">explicit</span></span> </td>
  202. </tr>
  203. </table>
  204. </div><div class="memdoc">
  205. <p>Constructor. </p>
  206. </div>
  207. </div>
  208. <a id="ad5654fb1a33df17e9bc1aada33b5dcab" name="ad5654fb1a33df17e9bc1aada33b5dcab"></a>
  209. <h2 class="memtitle"><span class="permalink"><a href="#ad5654fb1a33df17e9bc1aada33b5dcab">&#9670;&#160;</a></span>GetMutexMask()</h2>
  210. <div class="memitem">
  211. <div class="memproto">
  212. <table class="mlabels">
  213. <tr>
  214. <td class="mlabels-left">
  215. <table class="memname">
  216. <tr>
  217. <td class="memname">virtual <a class="el" href="class_body_lock_interface.html#a771acdfb6a269ae145b3b7867b560ebb">MutexMask</a> BodyLockInterfaceLocking::GetMutexMask </td>
  218. <td>(</td>
  219. <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>
  220. </tr>
  221. <tr>
  222. <td class="paramkey"></td>
  223. <td></td>
  224. <td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>inNumber</em></span>&#160;) const</td>
  225. </tr>
  226. </table>
  227. </td>
  228. <td class="mlabels-right">
  229. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
  230. </tr>
  231. </table>
  232. </div><div class="memdoc">
  233. <p>Implements <a class="el" href="class_body_lock_interface.html#a3bfe95981277029552253f953f5e2179">BodyLockInterface</a>.</p>
  234. </div>
  235. </div>
  236. <a id="a5324dd788c8358e092527e3c68d9a682" name="a5324dd788c8358e092527e3c68d9a682"></a>
  237. <h2 class="memtitle"><span class="permalink"><a href="#a5324dd788c8358e092527e3c68d9a682">&#9670;&#160;</a></span>LockRead() <span class="overload">[1/2]</span></h2>
  238. <div class="memitem">
  239. <div class="memproto">
  240. <table class="mlabels">
  241. <tr>
  242. <td class="mlabels-left">
  243. <table class="memname">
  244. <tr>
  245. <td class="memname">virtual <a class="el" href="class_shared_mutex.html">SharedMutex</a> * BodyLockInterfaceLocking::LockRead </td>
  246. <td>(</td>
  247. <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>
  248. <td> const</td>
  249. </tr>
  250. </table>
  251. </td>
  252. <td class="mlabels-right">
  253. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
  254. </tr>
  255. </table>
  256. </div><div class="memdoc">
  257. <p>Implements <a class="el" href="class_body_lock_interface.html#a8a771b3c89803fee5e6d1c90f2f96a07">BodyLockInterface</a>.</p>
  258. </div>
  259. </div>
  260. <a id="adedab6f41d8e601a0780462678235b19" name="adedab6f41d8e601a0780462678235b19"></a>
  261. <h2 class="memtitle"><span class="permalink"><a href="#adedab6f41d8e601a0780462678235b19">&#9670;&#160;</a></span>LockRead() <span class="overload">[2/2]</span></h2>
  262. <div class="memitem">
  263. <div class="memproto">
  264. <table class="mlabels">
  265. <tr>
  266. <td class="mlabels-left">
  267. <table class="memname">
  268. <tr>
  269. <td class="memname">virtual void BodyLockInterfaceLocking::LockRead </td>
  270. <td>(</td>
  271. <td class="paramtype"><a class="el" href="class_body_lock_interface.html#a771acdfb6a269ae145b3b7867b560ebb">MutexMask</a></td> <td class="paramname"><span class="paramname"><em>inMutexMask</em></span></td><td>)</td>
  272. <td> const</td>
  273. </tr>
  274. </table>
  275. </td>
  276. <td class="mlabels-right">
  277. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
  278. </tr>
  279. </table>
  280. </div><div class="memdoc">
  281. <p>Implements <a class="el" href="class_body_lock_interface.html#ae146eecd6e18c0b9b5e19f72a2696572">BodyLockInterface</a>.</p>
  282. </div>
  283. </div>
  284. <a id="a109d30a7639dde11979c5e1ccb62707c" name="a109d30a7639dde11979c5e1ccb62707c"></a>
  285. <h2 class="memtitle"><span class="permalink"><a href="#a109d30a7639dde11979c5e1ccb62707c">&#9670;&#160;</a></span>LockWrite() <span class="overload">[1/2]</span></h2>
  286. <div class="memitem">
  287. <div class="memproto">
  288. <table class="mlabels">
  289. <tr>
  290. <td class="mlabels-left">
  291. <table class="memname">
  292. <tr>
  293. <td class="memname">virtual <a class="el" href="class_shared_mutex.html">SharedMutex</a> * BodyLockInterfaceLocking::LockWrite </td>
  294. <td>(</td>
  295. <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>
  296. <td> const</td>
  297. </tr>
  298. </table>
  299. </td>
  300. <td class="mlabels-right">
  301. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
  302. </tr>
  303. </table>
  304. </div><div class="memdoc">
  305. <p>Implements <a class="el" href="class_body_lock_interface.html#a9d17ddb805293e6495f3569a4ed32969">BodyLockInterface</a>.</p>
  306. </div>
  307. </div>
  308. <a id="a518e5c21911dbfd54f7f2c6390dc7d35" name="a518e5c21911dbfd54f7f2c6390dc7d35"></a>
  309. <h2 class="memtitle"><span class="permalink"><a href="#a518e5c21911dbfd54f7f2c6390dc7d35">&#9670;&#160;</a></span>LockWrite() <span class="overload">[2/2]</span></h2>
  310. <div class="memitem">
  311. <div class="memproto">
  312. <table class="mlabels">
  313. <tr>
  314. <td class="mlabels-left">
  315. <table class="memname">
  316. <tr>
  317. <td class="memname">virtual void BodyLockInterfaceLocking::LockWrite </td>
  318. <td>(</td>
  319. <td class="paramtype"><a class="el" href="class_body_lock_interface.html#a771acdfb6a269ae145b3b7867b560ebb">MutexMask</a></td> <td class="paramname"><span class="paramname"><em>inMutexMask</em></span></td><td>)</td>
  320. <td> const</td>
  321. </tr>
  322. </table>
  323. </td>
  324. <td class="mlabels-right">
  325. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
  326. </tr>
  327. </table>
  328. </div><div class="memdoc">
  329. <p>Implements <a class="el" href="class_body_lock_interface.html#a8ec7191e60755953798e570d01c0b30b">BodyLockInterface</a>.</p>
  330. </div>
  331. </div>
  332. <a id="a23ed101c9ed1d8266dc7742f002f908b" name="a23ed101c9ed1d8266dc7742f002f908b"></a>
  333. <h2 class="memtitle"><span class="permalink"><a href="#a23ed101c9ed1d8266dc7742f002f908b">&#9670;&#160;</a></span>UnlockRead() <span class="overload">[1/2]</span></h2>
  334. <div class="memitem">
  335. <div class="memproto">
  336. <table class="mlabels">
  337. <tr>
  338. <td class="mlabels-left">
  339. <table class="memname">
  340. <tr>
  341. <td class="memname">virtual void BodyLockInterfaceLocking::UnlockRead </td>
  342. <td>(</td>
  343. <td class="paramtype"><a class="el" href="class_body_lock_interface.html#a771acdfb6a269ae145b3b7867b560ebb">MutexMask</a></td> <td class="paramname"><span class="paramname"><em>inMutexMask</em></span></td><td>)</td>
  344. <td> const</td>
  345. </tr>
  346. </table>
  347. </td>
  348. <td class="mlabels-right">
  349. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
  350. </tr>
  351. </table>
  352. </div><div class="memdoc">
  353. <p>Implements <a class="el" href="class_body_lock_interface.html#a702e6d9dba53f21d054dc51397bd9c39">BodyLockInterface</a>.</p>
  354. </div>
  355. </div>
  356. <a id="a523d0b2ec0c63a14964ff67b407cf8dd" name="a523d0b2ec0c63a14964ff67b407cf8dd"></a>
  357. <h2 class="memtitle"><span class="permalink"><a href="#a523d0b2ec0c63a14964ff67b407cf8dd">&#9670;&#160;</a></span>UnlockRead() <span class="overload">[2/2]</span></h2>
  358. <div class="memitem">
  359. <div class="memproto">
  360. <table class="mlabels">
  361. <tr>
  362. <td class="mlabels-left">
  363. <table class="memname">
  364. <tr>
  365. <td class="memname">virtual void BodyLockInterfaceLocking::UnlockRead </td>
  366. <td>(</td>
  367. <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>
  368. <td> const</td>
  369. </tr>
  370. </table>
  371. </td>
  372. <td class="mlabels-right">
  373. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
  374. </tr>
  375. </table>
  376. </div><div class="memdoc">
  377. <p>Implements <a class="el" href="class_body_lock_interface.html#a01f2a12bf7200265b64aae3effd3a82d">BodyLockInterface</a>.</p>
  378. </div>
  379. </div>
  380. <a id="a25822b34a4987988f2100790c1279eb2" name="a25822b34a4987988f2100790c1279eb2"></a>
  381. <h2 class="memtitle"><span class="permalink"><a href="#a25822b34a4987988f2100790c1279eb2">&#9670;&#160;</a></span>UnlockWrite() <span class="overload">[1/2]</span></h2>
  382. <div class="memitem">
  383. <div class="memproto">
  384. <table class="mlabels">
  385. <tr>
  386. <td class="mlabels-left">
  387. <table class="memname">
  388. <tr>
  389. <td class="memname">virtual void BodyLockInterfaceLocking::UnlockWrite </td>
  390. <td>(</td>
  391. <td class="paramtype"><a class="el" href="class_body_lock_interface.html#a771acdfb6a269ae145b3b7867b560ebb">MutexMask</a></td> <td class="paramname"><span class="paramname"><em>inMutexMask</em></span></td><td>)</td>
  392. <td> const</td>
  393. </tr>
  394. </table>
  395. </td>
  396. <td class="mlabels-right">
  397. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
  398. </tr>
  399. </table>
  400. </div><div class="memdoc">
  401. <p>Implements <a class="el" href="class_body_lock_interface.html#ae7ab56617d45d42ee2935b0eaf9b57e6">BodyLockInterface</a>.</p>
  402. </div>
  403. </div>
  404. <a id="a0651763a01d010609627cf84153b65d9" name="a0651763a01d010609627cf84153b65d9"></a>
  405. <h2 class="memtitle"><span class="permalink"><a href="#a0651763a01d010609627cf84153b65d9">&#9670;&#160;</a></span>UnlockWrite() <span class="overload">[2/2]</span></h2>
  406. <div class="memitem">
  407. <div class="memproto">
  408. <table class="mlabels">
  409. <tr>
  410. <td class="mlabels-left">
  411. <table class="memname">
  412. <tr>
  413. <td class="memname">virtual void BodyLockInterfaceLocking::UnlockWrite </td>
  414. <td>(</td>
  415. <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>
  416. <td> const</td>
  417. </tr>
  418. </table>
  419. </td>
  420. <td class="mlabels-right">
  421. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
  422. </tr>
  423. </table>
  424. </div><div class="memdoc">
  425. <p>Implements <a class="el" href="class_body_lock_interface.html#a786e43ce709b4214d7ebda26961d4725">BodyLockInterface</a>.</p>
  426. </div>
  427. </div>
  428. <hr/>The documentation for this class was generated from the following file:<ul>
  429. <li>Jolt/Physics/Body/<a class="el" href="_body_lock_interface_8h_source.html">BodyLockInterface.h</a></li>
  430. </ul>
  431. </div><!-- contents -->
  432. </div><!-- doc-content -->
  433. <!-- start footer part -->
  434. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  435. <ul>
  436. <li class="navelem"><a class="el" href="class_body_lock_interface_locking.html">BodyLockInterfaceLocking</a></li>
  437. <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>
  438. </ul>
  439. </div>
  440. </body>
  441. </html>