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


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401
							<!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: BroadPhaseLayer 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_broad_phase_layer.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="class_broad_phase_layer-members.html">List of all members</a>  </div>
  <div class="headertitle"><div class="title">BroadPhaseLayer Class Reference</div></div>
</div><!--header-->
<div class="contents">

<p><code>#include &lt;<a class="el" href="_broad_phase_layer_8h_source.html">BroadPhaseLayer.h</a>&gt;</code></p>
<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:a9b1092d1684a4570ec8a44b853b668b0" id="r_a9b1092d1684a4570ec8a44b853b668b0"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a9b1092d1684a4570ec8a44b853b668b0">Type</a> = <a class="el" href="_core_8h.html#a115946cb5fc5879545e9ccea096a6031">uint8</a></td></tr>
<tr class="separator:a9b1092d1684a4570ec8a44b853b668b0"><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:a5a745cab41c36b5acda7ba4332abd068" id="r_a5a745cab41c36b5acda7ba4332abd068"><td class="memItemLeft" align="right" valign="top">JPH_INLINE&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a5a745cab41c36b5acda7ba4332abd068">BroadPhaseLayer</a> ()=default</td></tr>
<tr class="separator:a5a745cab41c36b5acda7ba4332abd068"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a731f26e18a30c3bbb274df1296e78a9e" id="r_a731f26e18a30c3bbb274df1296e78a9e"><td class="memItemLeft" align="right" valign="top">JPH_INLINE constexpr&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a731f26e18a30c3bbb274df1296e78a9e">BroadPhaseLayer</a> (<a class="el" href="#a9b1092d1684a4570ec8a44b853b668b0">Type</a> inValue)</td></tr>
<tr class="separator:a731f26e18a30c3bbb274df1296e78a9e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab22a0985d4594f952096da14ab4560d8" id="r_ab22a0985d4594f952096da14ab4560d8"><td class="memItemLeft" align="right" valign="top">JPH_INLINE constexpr&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ab22a0985d4594f952096da14ab4560d8">BroadPhaseLayer</a> (const <a class="el" href="class_broad_phase_layer.html">BroadPhaseLayer</a> &amp;)=default</td></tr>
<tr class="separator:ab22a0985d4594f952096da14ab4560d8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab0344f5719acb04f80e27ca65e48e81e" id="r_ab0344f5719acb04f80e27ca65e48e81e"><td class="memItemLeft" align="right" valign="top">JPH_INLINE <a class="el" href="class_broad_phase_layer.html">BroadPhaseLayer</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ab0344f5719acb04f80e27ca65e48e81e">operator=</a> (const <a class="el" href="class_broad_phase_layer.html">BroadPhaseLayer</a> &amp;)=default</td></tr>
<tr class="separator:ab0344f5719acb04f80e27ca65e48e81e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adfb985183ea3a872650b100859883a6e" id="r_adfb985183ea3a872650b100859883a6e"><td class="memItemLeft" align="right" valign="top">JPH_INLINE constexpr bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#adfb985183ea3a872650b100859883a6e">operator==</a> (const <a class="el" href="class_broad_phase_layer.html">BroadPhaseLayer</a> &amp;inRHS) const</td></tr>
<tr class="separator:adfb985183ea3a872650b100859883a6e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab0429cbf863c7c513553a36ea154b849" id="r_ab0429cbf863c7c513553a36ea154b849"><td class="memItemLeft" align="right" valign="top">JPH_INLINE constexpr bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ab0429cbf863c7c513553a36ea154b849">operator!=</a> (const <a class="el" href="class_broad_phase_layer.html">BroadPhaseLayer</a> &amp;inRHS) const</td></tr>
<tr class="separator:ab0429cbf863c7c513553a36ea154b849"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5408ee98531f1a48e1931c71ea2955e9" id="r_a5408ee98531f1a48e1931c71ea2955e9"><td class="memItemLeft" align="right" valign="top">JPH_INLINE constexpr bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a5408ee98531f1a48e1931c71ea2955e9">operator&lt;</a> (const <a class="el" href="class_broad_phase_layer.html">BroadPhaseLayer</a> &amp;inRHS) const</td></tr>
<tr class="separator:a5408ee98531f1a48e1931c71ea2955e9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae0cc32e470894d6c842ace0ab9054360" id="r_ae0cc32e470894d6c842ace0ab9054360"><td class="memItemLeft" align="right" valign="top">JPH_INLINE constexpr&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ae0cc32e470894d6c842ace0ab9054360">operator Type</a> () const</td></tr>
<tr class="separator:ae0cc32e470894d6c842ace0ab9054360"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a88ef7f609071bbf53e1c018966e65c36" id="r_a88ef7f609071bbf53e1c018966e65c36"><td class="memItemLeft" align="right" valign="top">JPH_INLINE <a class="el" href="#a9b1092d1684a4570ec8a44b853b668b0">Type</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a88ef7f609071bbf53e1c018966e65c36">GetValue</a> () const</td></tr>
<tr class="separator:a88ef7f609071bbf53e1c018966e65c36"><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>An object layer can be mapped to a broadphase layer. Objects with the same broadphase layer will end up in the same sub structure (usually a tree) of the broadphase. When there are many layers, this reduces the total amount of sub structures the broad phase needs to manage. Usually you want objects that don't collide with each other in different broad phase layers, but there could be exceptions if objects layers only contain a minor amount of objects so it is not beneficial to give each layer its own sub structure in the broadphase. Note: This class requires explicit casting from and to Type to avoid confusion with ObjectLayer </p>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a id="a9b1092d1684a4570ec8a44b853b668b0" name="a9b1092d1684a4570ec8a44b853b668b0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9b1092d1684a4570ec8a44b853b668b0">&#9670;&#160;</a></span>Type</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">using <a class="el" href="#a9b1092d1684a4570ec8a44b853b668b0">BroadPhaseLayer::Type</a> = <a class="el" href="_core_8h.html#a115946cb5fc5879545e9ccea096a6031">uint8</a></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a5a745cab41c36b5acda7ba4332abd068" name="a5a745cab41c36b5acda7ba4332abd068"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5a745cab41c36b5acda7ba4332abd068">&#9670;&#160;</a></span>BroadPhaseLayer() <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">JPH_INLINE BroadPhaseLayer::BroadPhaseLayer </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">default</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<a id="a731f26e18a30c3bbb274df1296e78a9e" name="a731f26e18a30c3bbb274df1296e78a9e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a731f26e18a30c3bbb274df1296e78a9e">&#9670;&#160;</a></span>BroadPhaseLayer() <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">JPH_INLINE constexpr BroadPhaseLayer::BroadPhaseLayer </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="#a9b1092d1684a4570ec8a44b853b668b0">Type</a></td>          <td class="paramname"><span class="paramname"><em>inValue</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 class="mlabel">constexpr</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<a id="ab22a0985d4594f952096da14ab4560d8" name="ab22a0985d4594f952096da14ab4560d8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab22a0985d4594f952096da14ab4560d8">&#9670;&#160;</a></span>BroadPhaseLayer() <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">JPH_INLINE constexpr BroadPhaseLayer::BroadPhaseLayer </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="class_broad_phase_layer.html">BroadPhaseLayer</a> &amp;</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">constexpr</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="a88ef7f609071bbf53e1c018966e65c36" name="a88ef7f609071bbf53e1c018966e65c36"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a88ef7f609071bbf53e1c018966e65c36">&#9670;&#160;</a></span>GetValue()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">JPH_INLINE <a class="el" href="#a9b1092d1684a4570ec8a44b853b668b0">Type</a> BroadPhaseLayer::GetValue </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">

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

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">JPH_INLINE constexpr BroadPhaseLayer::operator <a class="el" href="#a9b1092d1684a4570ec8a44b853b668b0">Type</a> </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 class="mlabel">explicit</span><span class="mlabel">constexpr</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<a id="ab0429cbf863c7c513553a36ea154b849" name="ab0429cbf863c7c513553a36ea154b849"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab0429cbf863c7c513553a36ea154b849">&#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">JPH_INLINE constexpr bool BroadPhaseLayer::operator!= </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="class_broad_phase_layer.html">BroadPhaseLayer</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 class="mlabel">constexpr</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<a id="a5408ee98531f1a48e1931c71ea2955e9" name="a5408ee98531f1a48e1931c71ea2955e9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5408ee98531f1a48e1931c71ea2955e9">&#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">JPH_INLINE constexpr bool BroadPhaseLayer::operator&lt; </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="class_broad_phase_layer.html">BroadPhaseLayer</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 class="mlabel">constexpr</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<a id="ab0344f5719acb04f80e27ca65e48e81e" name="ab0344f5719acb04f80e27ca65e48e81e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab0344f5719acb04f80e27ca65e48e81e">&#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">JPH_INLINE <a class="el" href="class_broad_phase_layer.html">BroadPhaseLayer</a> &amp; BroadPhaseLayer::operator= </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="class_broad_phase_layer.html">BroadPhaseLayer</a> &amp;</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">default</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<a id="adfb985183ea3a872650b100859883a6e" name="adfb985183ea3a872650b100859883a6e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adfb985183ea3a872650b100859883a6e">&#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">JPH_INLINE constexpr bool BroadPhaseLayer::operator== </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="class_broad_phase_layer.html">BroadPhaseLayer</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 class="mlabel">constexpr</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/Collision/BroadPhase/<a class="el" href="_broad_phase_layer_8h_source.html">BroadPhaseLayer.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_broad_phase_layer.html">BroadPhaseLayer</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>