class_broad_phase_layer_interface_mask.html 23 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382
  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: BroadPhaseLayerInterfaceMask 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_broad_phase_layer_interface_mask.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_broad_phase_layer_interface_mask-members.html">List of all members</a> </div>
  109. <div class="headertitle"><div class="title">BroadPhaseLayerInterfaceMask Class Reference</div></div>
  110. </div><!--header-->
  111. <div class="contents">
  112. <p><code>#include &lt;<a class="el" href="_broad_phase_layer_interface_mask_8h_source.html">BroadPhaseLayerInterfaceMask.h</a>&gt;</code></p>
  113. <div class="dynheader">
  114. Inheritance diagram for BroadPhaseLayerInterfaceMask:</div>
  115. <div class="dyncontent">
  116. <div class="center">
  117. <img src="class_broad_phase_layer_interface_mask.png" usemap="#BroadPhaseLayerInterfaceMask_map" alt=""/>
  118. <map id="BroadPhaseLayerInterfaceMask_map" name="BroadPhaseLayerInterfaceMask_map">
  119. <area href="class_broad_phase_layer_interface.html" title="Interface that the application should implement to allow mapping object layers to broadphase layers." alt="BroadPhaseLayerInterface" shape="rect" coords="0,56,194,80"/>
  120. <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,194,24"/>
  121. </map>
  122. </div></div>
  123. <table class="memberdecls">
  124. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
  125. Public Member Functions</h2></td></tr>
  126. <tr class="memitem:a91a0c2af42acacfefdb8901fc1bc9696" id="r_a91a0c2af42acacfefdb8901fc1bc9696"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_memory_8h.html#a91074fb218fe28954a0938c099ddd9e0">JPH_OVERRIDE_NEW_DELETE</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a91a0c2af42acacfefdb8901fc1bc9696">BroadPhaseLayerInterfaceMask</a> (<a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a> inNumBroadPhaseLayers)</td></tr>
  127. <tr class="separator:a91a0c2af42acacfefdb8901fc1bc9696"><td class="memSeparator" colspan="2">&#160;</td></tr>
  128. <tr class="memitem:a01a9ec0c57462e3cda401b73edbf3573" id="r_a01a9ec0c57462e3cda401b73edbf3573"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a01a9ec0c57462e3cda401b73edbf3573">ConfigureLayer</a> (<a class="el" href="class_broad_phase_layer.html">BroadPhaseLayer</a> inBroadPhaseLayer, <a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a> inGroupsToInclude, <a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a> inGroupsToExclude)</td></tr>
  129. <tr class="separator:a01a9ec0c57462e3cda401b73edbf3573"><td class="memSeparator" colspan="2">&#160;</td></tr>
  130. <tr class="memitem:a5c4d1d6ac5321a8bd30ddd54be36f24d" id="r_a5c4d1d6ac5321a8bd30ddd54be36f24d"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a5c4d1d6ac5321a8bd30ddd54be36f24d">GetNumBroadPhaseLayers</a> () const override</td></tr>
  131. <tr class="memdesc:a5c4d1d6ac5321a8bd30ddd54be36f24d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the number of broadphase layers there are. <br /></td></tr>
  132. <tr class="separator:a5c4d1d6ac5321a8bd30ddd54be36f24d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  133. <tr class="memitem:a75300021e8d32e840ec8eb0d4a292b5a" id="r_a75300021e8d32e840ec8eb0d4a292b5a"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="class_broad_phase_layer.html">BroadPhaseLayer</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a75300021e8d32e840ec8eb0d4a292b5a">GetBroadPhaseLayer</a> (<a class="el" href="_object_layer_8h.html#a960eb396e2803ddad87bf25e0dcb4470">ObjectLayer</a> inLayer) const override</td></tr>
  134. <tr class="memdesc:a75300021e8d32e840ec8eb0d4a292b5a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Convert an object layer to the corresponding broadphase layer. <br /></td></tr>
  135. <tr class="separator:a75300021e8d32e840ec8eb0d4a292b5a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  136. <tr class="memitem:ae96ef540e10bbd5d1dbed4260d8d179a" id="r_ae96ef540e10bbd5d1dbed4260d8d179a"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ae96ef540e10bbd5d1dbed4260d8d179a">ShouldCollide</a> (<a class="el" href="_object_layer_8h.html#a960eb396e2803ddad87bf25e0dcb4470">ObjectLayer</a> inLayer1, <a class="el" href="class_broad_phase_layer.html">BroadPhaseLayer</a> inLayer2) const</td></tr>
  137. <tr class="memdesc:ae96ef540e10bbd5d1dbed4260d8d179a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns true if an object layer should collide with a broadphase layer, this function is being called from <a class="el" href="class_object_vs_broad_phase_layer_filter_mask.html">ObjectVsBroadPhaseLayerFilterMask</a>. <br /></td></tr>
  138. <tr class="separator:ae96ef540e10bbd5d1dbed4260d8d179a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  139. <tr class="memitem:a28a251385bdfff0681491b5bdabcb22a" id="r_a28a251385bdfff0681491b5bdabcb22a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a28a251385bdfff0681491b5bdabcb22a">SetBroadPhaseLayerName</a> (<a class="el" href="class_broad_phase_layer.html">BroadPhaseLayer</a> inLayer, const char *inName)</td></tr>
  140. <tr class="separator:a28a251385bdfff0681491b5bdabcb22a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  141. <tr class="memitem:aaf3574120e2a6941af759af7feec9746" id="r_aaf3574120e2a6941af759af7feec9746"><td class="memItemLeft" align="right" valign="top">virtual const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aaf3574120e2a6941af759af7feec9746">GetBroadPhaseLayerName</a> (<a class="el" href="class_broad_phase_layer.html">BroadPhaseLayer</a> inLayer) const override</td></tr>
  142. <tr class="memdesc:aaf3574120e2a6941af759af7feec9746"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the user readable name of a broadphase layer (debugging purposes) <br /></td></tr>
  143. <tr class="separator:aaf3574120e2a6941af759af7feec9746"><td class="memSeparator" colspan="2">&#160;</td></tr>
  144. <tr class="inherit_header pub_methods_class_broad_phase_layer_interface"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pub_methods_class_broad_phase_layer_interface')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="class_broad_phase_layer_interface.html">BroadPhaseLayerInterface</a></td></tr>
  145. <tr class="memitem:aefc74492347f08d653121e2f4af91e59 inherit pub_methods_class_broad_phase_layer_interface" id="r_aefc74492347f08d653121e2f4af91e59"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_broad_phase_layer_interface.html#aefc74492347f08d653121e2f4af91e59">~BroadPhaseLayerInterface</a> ()=default</td></tr>
  146. <tr class="memdesc:aefc74492347f08d653121e2f4af91e59 inherit pub_methods_class_broad_phase_layer_interface"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor. <br /></td></tr>
  147. <tr class="separator:aefc74492347f08d653121e2f4af91e59 inherit pub_methods_class_broad_phase_layer_interface"><td class="memSeparator" colspan="2">&#160;</td></tr>
  148. <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>
  149. <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>
  150. <tr class="separator:a809b6e4ade7ae32f6d248f2a3b783d45 inherit pub_methods_class_non_copyable"><td class="memSeparator" colspan="2">&#160;</td></tr>
  151. <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>
  152. <tr class="separator:a501d34ffcc34b30de6d541887a901057 inherit pub_methods_class_non_copyable"><td class="memSeparator" colspan="2">&#160;</td></tr>
  153. <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>
  154. <tr class="separator:aaf9b12dcaae80c9d304df7a941d4e21f inherit pub_methods_class_non_copyable"><td class="memSeparator" colspan="2">&#160;</td></tr>
  155. </table>
  156. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  157. <div class="textblock"><p><a class="el" href="class_broad_phase_layer_interface.html" title="Interface that the application should implement to allow mapping object layers to broadphase layers.">BroadPhaseLayerInterface</a> implementation. This defines a mapping between object and broadphase layers. This implementation works together with <a class="el" href="class_object_layer_pair_filter_mask.html">ObjectLayerPairFilterMask</a> and <a class="el" href="class_object_vs_broad_phase_layer_filter_mask.html">ObjectVsBroadPhaseLayerFilterMask</a>. A broadphase layer is suitable for an object if its group &amp; inGroupsToInclude is not zero and its group &amp; inGroupsToExclude is zero. The broadphase layers are iterated from lowest to highest value and the first one that matches is taken. If none match then it takes the last layer. </p>
  158. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  159. <a id="a91a0c2af42acacfefdb8901fc1bc9696" name="a91a0c2af42acacfefdb8901fc1bc9696"></a>
  160. <h2 class="memtitle"><span class="permalink"><a href="#a91a0c2af42acacfefdb8901fc1bc9696">&#9670;&#160;</a></span>BroadPhaseLayerInterfaceMask()</h2>
  161. <div class="memitem">
  162. <div class="memproto">
  163. <table class="mlabels">
  164. <tr>
  165. <td class="mlabels-left">
  166. <table class="memname">
  167. <tr>
  168. <td class="memname"><a class="el" href="_memory_8h.html#a91074fb218fe28954a0938c099ddd9e0">JPH_OVERRIDE_NEW_DELETE</a> BroadPhaseLayerInterfaceMask::BroadPhaseLayerInterfaceMask </td>
  169. <td>(</td>
  170. <td class="paramtype"><a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a></td> <td class="paramname"><span class="paramname"><em>inNumBroadPhaseLayers</em></span></td><td>)</td>
  171. <td></td>
  172. </tr>
  173. </table>
  174. </td>
  175. <td class="mlabels-right">
  176. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">explicit</span></span> </td>
  177. </tr>
  178. </table>
  179. </div><div class="memdoc">
  180. </div>
  181. </div>
  182. <h2 class="groupheader">Member Function Documentation</h2>
  183. <a id="a01a9ec0c57462e3cda401b73edbf3573" name="a01a9ec0c57462e3cda401b73edbf3573"></a>
  184. <h2 class="memtitle"><span class="permalink"><a href="#a01a9ec0c57462e3cda401b73edbf3573">&#9670;&#160;</a></span>ConfigureLayer()</h2>
  185. <div class="memitem">
  186. <div class="memproto">
  187. <table class="mlabels">
  188. <tr>
  189. <td class="mlabels-left">
  190. <table class="memname">
  191. <tr>
  192. <td class="memname">void BroadPhaseLayerInterfaceMask::ConfigureLayer </td>
  193. <td>(</td>
  194. <td class="paramtype"><a class="el" href="class_broad_phase_layer.html">BroadPhaseLayer</a></td> <td class="paramname"><span class="paramname"><em>inBroadPhaseLayer</em></span>, </td>
  195. </tr>
  196. <tr>
  197. <td class="paramkey"></td>
  198. <td></td>
  199. <td class="paramtype"><a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a></td> <td class="paramname"><span class="paramname"><em>inGroupsToInclude</em></span>, </td>
  200. </tr>
  201. <tr>
  202. <td class="paramkey"></td>
  203. <td></td>
  204. <td class="paramtype"><a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a></td> <td class="paramname"><span class="paramname"><em>inGroupsToExclude</em></span>&#160;)</td>
  205. </tr>
  206. </table>
  207. </td>
  208. <td class="mlabels-right">
  209. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  210. </tr>
  211. </table>
  212. </div><div class="memdoc">
  213. </div>
  214. </div>
  215. <a id="a75300021e8d32e840ec8eb0d4a292b5a" name="a75300021e8d32e840ec8eb0d4a292b5a"></a>
  216. <h2 class="memtitle"><span class="permalink"><a href="#a75300021e8d32e840ec8eb0d4a292b5a">&#9670;&#160;</a></span>GetBroadPhaseLayer()</h2>
  217. <div class="memitem">
  218. <div class="memproto">
  219. <table class="mlabels">
  220. <tr>
  221. <td class="mlabels-left">
  222. <table class="memname">
  223. <tr>
  224. <td class="memname">virtual <a class="el" href="class_broad_phase_layer.html">BroadPhaseLayer</a> BroadPhaseLayerInterfaceMask::GetBroadPhaseLayer </td>
  225. <td>(</td>
  226. <td class="paramtype"><a class="el" href="_object_layer_8h.html#a960eb396e2803ddad87bf25e0dcb4470">ObjectLayer</a></td> <td class="paramname"><span class="paramname"><em>inLayer</em></span></td><td>)</td>
  227. <td> const</td>
  228. </tr>
  229. </table>
  230. </td>
  231. <td class="mlabels-right">
  232. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
  233. </tr>
  234. </table>
  235. </div><div class="memdoc">
  236. <p>Convert an object layer to the corresponding broadphase layer. </p>
  237. <p>Implements <a class="el" href="class_broad_phase_layer_interface.html#a5007c9b9beab5c16af36e89b48cd06cb">BroadPhaseLayerInterface</a>.</p>
  238. </div>
  239. </div>
  240. <a id="aaf3574120e2a6941af759af7feec9746" name="aaf3574120e2a6941af759af7feec9746"></a>
  241. <h2 class="memtitle"><span class="permalink"><a href="#aaf3574120e2a6941af759af7feec9746">&#9670;&#160;</a></span>GetBroadPhaseLayerName()</h2>
  242. <div class="memitem">
  243. <div class="memproto">
  244. <table class="mlabels">
  245. <tr>
  246. <td class="mlabels-left">
  247. <table class="memname">
  248. <tr>
  249. <td class="memname">virtual const char * BroadPhaseLayerInterfaceMask::GetBroadPhaseLayerName </td>
  250. <td>(</td>
  251. <td class="paramtype"><a class="el" href="class_broad_phase_layer.html">BroadPhaseLayer</a></td> <td class="paramname"><span class="paramname"><em>inLayer</em></span></td><td>)</td>
  252. <td> const</td>
  253. </tr>
  254. </table>
  255. </td>
  256. <td class="mlabels-right">
  257. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
  258. </tr>
  259. </table>
  260. </div><div class="memdoc">
  261. <p>Get the user readable name of a broadphase layer (debugging purposes) </p>
  262. <p>Implements <a class="el" href="class_broad_phase_layer_interface.html#af599bec360da5437bfc74cb0fd749225">BroadPhaseLayerInterface</a>.</p>
  263. </div>
  264. </div>
  265. <a id="a5c4d1d6ac5321a8bd30ddd54be36f24d" name="a5c4d1d6ac5321a8bd30ddd54be36f24d"></a>
  266. <h2 class="memtitle"><span class="permalink"><a href="#a5c4d1d6ac5321a8bd30ddd54be36f24d">&#9670;&#160;</a></span>GetNumBroadPhaseLayers()</h2>
  267. <div class="memitem">
  268. <div class="memproto">
  269. <table class="mlabels">
  270. <tr>
  271. <td class="mlabels-left">
  272. <table class="memname">
  273. <tr>
  274. <td class="memname">virtual <a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a> BroadPhaseLayerInterfaceMask::GetNumBroadPhaseLayers </td>
  275. <td>(</td>
  276. <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  277. <td> const</td>
  278. </tr>
  279. </table>
  280. </td>
  281. <td class="mlabels-right">
  282. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
  283. </tr>
  284. </table>
  285. </div><div class="memdoc">
  286. <p>Return the number of broadphase layers there are. </p>
  287. <p>Implements <a class="el" href="class_broad_phase_layer_interface.html#a3eeb469199592955036a5b24633b8f53">BroadPhaseLayerInterface</a>.</p>
  288. </div>
  289. </div>
  290. <a id="a28a251385bdfff0681491b5bdabcb22a" name="a28a251385bdfff0681491b5bdabcb22a"></a>
  291. <h2 class="memtitle"><span class="permalink"><a href="#a28a251385bdfff0681491b5bdabcb22a">&#9670;&#160;</a></span>SetBroadPhaseLayerName()</h2>
  292. <div class="memitem">
  293. <div class="memproto">
  294. <table class="mlabels">
  295. <tr>
  296. <td class="mlabels-left">
  297. <table class="memname">
  298. <tr>
  299. <td class="memname">void BroadPhaseLayerInterfaceMask::SetBroadPhaseLayerName </td>
  300. <td>(</td>
  301. <td class="paramtype"><a class="el" href="class_broad_phase_layer.html">BroadPhaseLayer</a></td> <td class="paramname"><span class="paramname"><em>inLayer</em></span>, </td>
  302. </tr>
  303. <tr>
  304. <td class="paramkey"></td>
  305. <td></td>
  306. <td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>inName</em></span>&#160;)</td>
  307. </tr>
  308. </table>
  309. </td>
  310. <td class="mlabels-right">
  311. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  312. </tr>
  313. </table>
  314. </div><div class="memdoc">
  315. </div>
  316. </div>
  317. <a id="ae96ef540e10bbd5d1dbed4260d8d179a" name="ae96ef540e10bbd5d1dbed4260d8d179a"></a>
  318. <h2 class="memtitle"><span class="permalink"><a href="#ae96ef540e10bbd5d1dbed4260d8d179a">&#9670;&#160;</a></span>ShouldCollide()</h2>
  319. <div class="memitem">
  320. <div class="memproto">
  321. <table class="mlabels">
  322. <tr>
  323. <td class="mlabels-left">
  324. <table class="memname">
  325. <tr>
  326. <td class="memname">bool BroadPhaseLayerInterfaceMask::ShouldCollide </td>
  327. <td>(</td>
  328. <td class="paramtype"><a class="el" href="_object_layer_8h.html#a960eb396e2803ddad87bf25e0dcb4470">ObjectLayer</a></td> <td class="paramname"><span class="paramname"><em>inLayer1</em></span>, </td>
  329. </tr>
  330. <tr>
  331. <td class="paramkey"></td>
  332. <td></td>
  333. <td class="paramtype"><a class="el" href="class_broad_phase_layer.html">BroadPhaseLayer</a></td> <td class="paramname"><span class="paramname"><em>inLayer2</em></span>&#160;) const</td>
  334. </tr>
  335. </table>
  336. </td>
  337. <td class="mlabels-right">
  338. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  339. </tr>
  340. </table>
  341. </div><div class="memdoc">
  342. <p>Returns true if an object layer should collide with a broadphase layer, this function is being called from <a class="el" href="class_object_vs_broad_phase_layer_filter_mask.html">ObjectVsBroadPhaseLayerFilterMask</a>. </p>
  343. </div>
  344. </div>
  345. <hr/>The documentation for this class was generated from the following file:<ul>
  346. <li>Jolt/Physics/Collision/BroadPhase/<a class="el" href="_broad_phase_layer_interface_mask_8h_source.html">BroadPhaseLayerInterfaceMask.h</a></li>
  347. </ul>
  348. </div><!-- contents -->
  349. </div><!-- doc-content -->
  350. <!-- start footer part -->
  351. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  352. <ul>
  353. <li class="navelem"><a class="el" href="class_broad_phase_layer_interface_mask.html">BroadPhaseLayerInterfaceMask</a></li>
  354. <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>
  355. </ul>
  356. </div>
  357. </body>
  358. </html>