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


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353
							<!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: BodyLockBase&lt; Write, BodyType &gt; Class Template 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_base.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="class_body_lock_base-members.html">List of all members</a>  </div>
  <div class="headertitle"><div class="title">BodyLockBase&lt; Write, BodyType &gt; Class Template Reference</div></div>
</div><!--header-->
<div class="contents">

<p>Base class for locking bodies for the duration of the scope of this class (do not use directly)  
 <a href="#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="_body_lock_8h_source.html">BodyLock.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for BodyLockBase&lt; Write, BodyType &gt;:</div>
<div class="dyncontent">
 <div class="center">
  <img src="class_body_lock_base.png" usemap="#BodyLockBase_3C_20Write_2C_20BodyType_20_3E_map" alt=""/>
  <map id="BodyLockBase_3C_20Write_2C_20BodyType_20_3E_map" name="BodyLockBase_3C_20Write_2C_20BodyType_20_3E_map">
<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,215,24"/>
  </map>
</div></div>
<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:a6567f612e029f57f4a49aebcf54334a9" id="r_a6567f612e029f57f4a49aebcf54334a9"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a6567f612e029f57f4a49aebcf54334a9">BodyLockBase</a> (const <a class="el" href="class_body_lock_interface.html">BodyLockInterface</a> &amp;inBodyLockInterface, const <a class="el" href="class_body_i_d.html">BodyID</a> &amp;inBodyID)</td></tr>
<tr class="memdesc:a6567f612e029f57f4a49aebcf54334a9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor will lock the body.  <br /></td></tr>
<tr class="separator:a6567f612e029f57f4a49aebcf54334a9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad55e418ae5441d32196be0d6433e4cec" id="r_ad55e418ae5441d32196be0d6433e4cec"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ad55e418ae5441d32196be0d6433e4cec">ReleaseLock</a> ()</td></tr>
<tr class="memdesc:ad55e418ae5441d32196be0d6433e4cec"><td class="mdescLeft">&#160;</td><td class="mdescRight">Explicitly release the lock (normally this is done in the destructor)  <br /></td></tr>
<tr class="separator:ad55e418ae5441d32196be0d6433e4cec"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a30194dac9c9d2ca469894dd7c5719d40" id="r_a30194dac9c9d2ca469894dd7c5719d40"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a30194dac9c9d2ca469894dd7c5719d40">~BodyLockBase</a> ()</td></tr>
<tr class="memdesc:a30194dac9c9d2ca469894dd7c5719d40"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor will unlock the body.  <br /></td></tr>
<tr class="separator:a30194dac9c9d2ca469894dd7c5719d40"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8ee09ef1fb31697b4f965c8e5ee09e5f" id="r_a8ee09ef1fb31697b4f965c8e5ee09e5f"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a8ee09ef1fb31697b4f965c8e5ee09e5f">Succeeded</a> () const</td></tr>
<tr class="memdesc:a8ee09ef1fb31697b4f965c8e5ee09e5f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Test if the lock was successful (if the body ID was valid)  <br /></td></tr>
<tr class="separator:a8ee09ef1fb31697b4f965c8e5ee09e5f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9ed231a8aea3cfa9e1e721707dcd08fb" id="r_a9ed231a8aea3cfa9e1e721707dcd08fb"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a9ed231a8aea3cfa9e1e721707dcd08fb">SucceededAndIsInBroadPhase</a> () const</td></tr>
<tr class="memdesc:a9ed231a8aea3cfa9e1e721707dcd08fb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Test if the lock was successful (if the body ID was valid) and the body is still in the broad phase.  <br /></td></tr>
<tr class="separator:a9ed231a8aea3cfa9e1e721707dcd08fb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa79bd3d8f64b4f92a2744737eddc6e59" id="r_aa79bd3d8f64b4f92a2744737eddc6e59"><td class="memItemLeft" align="right" valign="top">BodyType &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aa79bd3d8f64b4f92a2744737eddc6e59">GetBody</a> () const</td></tr>
<tr class="memdesc:aa79bd3d8f64b4f92a2744737eddc6e59"><td class="mdescLeft">&#160;</td><td class="mdescRight">Access the body.  <br /></td></tr>
<tr class="separator:aa79bd3d8f64b4f92a2744737eddc6e59"><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>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><div class="compoundTemplParams">template&lt;bool Write, class BodyType&gt;<br />
class BodyLockBase&lt; Write, BodyType &gt;</div><p>Base class for locking bodies for the duration of the scope of this class (do not use directly) </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a6567f612e029f57f4a49aebcf54334a9" name="a6567f612e029f57f4a49aebcf54334a9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6567f612e029f57f4a49aebcf54334a9">&#9670;&#160;</a></span>BodyLockBase()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;bool Write, class BodyType &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_body_lock_base.html">BodyLockBase</a>&lt; Write, BodyType &gt;<a class="el" href="class_body_lock_base.html">::BodyLockBase</a> </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="class_body_lock_interface.html">BodyLockInterface</a> &amp;</td>          <td class="paramname"><span class="paramname"><em>inBodyLockInterface</em></span>, </td>
        </tr>
        <tr>
          <td class="paramkey"></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>&#160;)</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>Constructor will lock the body. </p>

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

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;bool Write, class BodyType &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_body_lock_base.html">BodyLockBase</a>&lt; Write, BodyType &gt;::~<a class="el" href="class_body_lock_base.html">BodyLockBase</a> </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>Destructor will unlock the body. </p>

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

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;bool Write, class BodyType &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">BodyType &amp; <a class="el" href="class_body_lock_base.html">BodyLockBase</a>&lt; Write, BodyType &gt;::GetBody </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>Access the body. </p>

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

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;bool Write, class BodyType &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="class_body_lock_base.html">BodyLockBase</a>&lt; Write, BodyType &gt;::ReleaseLock </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>Explicitly release the lock (normally this is done in the destructor) </p>

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

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;bool Write, class BodyType &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool <a class="el" href="class_body_lock_base.html">BodyLockBase</a>&lt; Write, BodyType &gt;::Succeeded </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>Test if the lock was successful (if the body ID was valid) </p>

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

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;bool Write, class BodyType &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool <a class="el" href="class_body_lock_base.html">BodyLockBase</a>&lt; Write, BodyType &gt;::SucceededAndIsInBroadPhase </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>Test if the lock was successful (if the body ID was valid) and the body is still in the broad phase. </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_lock_8h_source.html">BodyLock.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_base.html">BodyLockBase</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>