class_collision_group.html 29 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576
  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: CollisionGroup 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_collision_group.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-types">Public Types</a> &#124;
  108. <a href="#pub-methods">Public Member Functions</a> &#124;
  109. <a href="#pub-static-attribs">Static Public Attributes</a> &#124;
  110. <a href="class_collision_group-members.html">List of all members</a> </div>
  111. <div class="headertitle"><div class="title">CollisionGroup Class Reference</div></div>
  112. </div><!--header-->
  113. <div class="contents">
  114. <p><code>#include &lt;<a class="el" href="_collision_group_8h_source.html">CollisionGroup.h</a>&gt;</code></p>
  115. <table class="memberdecls">
  116. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-types" name="pub-types"></a>
  117. Public Types</h2></td></tr>
  118. <tr class="memitem:ab44e31c9fa83c4818b1560d71c15dddd" id="r_ab44e31c9fa83c4818b1560d71c15dddd"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ab44e31c9fa83c4818b1560d71c15dddd">GroupID</a> = <a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a></td></tr>
  119. <tr class="separator:ab44e31c9fa83c4818b1560d71c15dddd"><td class="memSeparator" colspan="2">&#160;</td></tr>
  120. <tr class="memitem:ae26aaf0a13015f02f01c0e128ccebcfd" id="r_ae26aaf0a13015f02f01c0e128ccebcfd"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ae26aaf0a13015f02f01c0e128ccebcfd">SubGroupID</a> = <a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a></td></tr>
  121. <tr class="separator:ae26aaf0a13015f02f01c0e128ccebcfd"><td class="memSeparator" colspan="2">&#160;</td></tr>
  122. </table><table class="memberdecls">
  123. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
  124. Public Member Functions</h2></td></tr>
  125. <tr class="memitem:ad9f6cce170470d571b3927c44d7104ec" id="r_ad9f6cce170470d571b3927c44d7104ec"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ad9f6cce170470d571b3927c44d7104ec">CollisionGroup</a> ()=default</td></tr>
  126. <tr class="memdesc:ad9f6cce170470d571b3927c44d7104ec"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructor. <br /></td></tr>
  127. <tr class="separator:ad9f6cce170470d571b3927c44d7104ec"><td class="memSeparator" colspan="2">&#160;</td></tr>
  128. <tr class="memitem:a5428cf2e49b467026e833c0955d35b30" id="r_a5428cf2e49b467026e833c0955d35b30"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a5428cf2e49b467026e833c0955d35b30">CollisionGroup</a> (const <a class="el" href="class_group_filter.html">GroupFilter</a> *inFilter, <a class="el" href="#ab44e31c9fa83c4818b1560d71c15dddd">GroupID</a> inGroupID, <a class="el" href="#ae26aaf0a13015f02f01c0e128ccebcfd">SubGroupID</a> inSubGroupID)</td></tr>
  129. <tr class="memdesc:a5428cf2e49b467026e833c0955d35b30"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct with all properties. <br /></td></tr>
  130. <tr class="separator:a5428cf2e49b467026e833c0955d35b30"><td class="memSeparator" colspan="2">&#160;</td></tr>
  131. <tr class="memitem:a24632cad19f63669929509eceb904290" id="r_a24632cad19f63669929509eceb904290"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a24632cad19f63669929509eceb904290">SetGroupFilter</a> (const <a class="el" href="class_group_filter.html">GroupFilter</a> *inFilter)</td></tr>
  132. <tr class="memdesc:a24632cad19f63669929509eceb904290"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the collision group filter. <br /></td></tr>
  133. <tr class="separator:a24632cad19f63669929509eceb904290"><td class="memSeparator" colspan="2">&#160;</td></tr>
  134. <tr class="memitem:abcda9f0cd8d5d8b2ee42bee0a19430a7" id="r_abcda9f0cd8d5d8b2ee42bee0a19430a7"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="class_group_filter.html">GroupFilter</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#abcda9f0cd8d5d8b2ee42bee0a19430a7">GetGroupFilter</a> () const</td></tr>
  135. <tr class="memdesc:abcda9f0cd8d5d8b2ee42bee0a19430a7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the collision group filter. <br /></td></tr>
  136. <tr class="separator:abcda9f0cd8d5d8b2ee42bee0a19430a7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  137. <tr class="memitem:ab49afbb0cbf8526e2b1ee89d8f2a34dd" id="r_ab49afbb0cbf8526e2b1ee89d8f2a34dd"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ab49afbb0cbf8526e2b1ee89d8f2a34dd">SetGroupID</a> (<a class="el" href="#ab44e31c9fa83c4818b1560d71c15dddd">GroupID</a> inID)</td></tr>
  138. <tr class="memdesc:ab49afbb0cbf8526e2b1ee89d8f2a34dd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the main group id for this object. <br /></td></tr>
  139. <tr class="separator:ab49afbb0cbf8526e2b1ee89d8f2a34dd"><td class="memSeparator" colspan="2">&#160;</td></tr>
  140. <tr class="memitem:a1521cec7d03c83265aecca64ec684433" id="r_a1521cec7d03c83265aecca64ec684433"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#ab44e31c9fa83c4818b1560d71c15dddd">GroupID</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a1521cec7d03c83265aecca64ec684433">GetGroupID</a> () const</td></tr>
  141. <tr class="separator:a1521cec7d03c83265aecca64ec684433"><td class="memSeparator" colspan="2">&#160;</td></tr>
  142. <tr class="memitem:a9ac2eb88530e8281a130bd73539d127b" id="r_a9ac2eb88530e8281a130bd73539d127b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a9ac2eb88530e8281a130bd73539d127b">SetSubGroupID</a> (<a class="el" href="#ae26aaf0a13015f02f01c0e128ccebcfd">SubGroupID</a> inID)</td></tr>
  143. <tr class="memdesc:a9ac2eb88530e8281a130bd73539d127b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add this object to a sub group. <br /></td></tr>
  144. <tr class="separator:a9ac2eb88530e8281a130bd73539d127b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  145. <tr class="memitem:a156fd729674403783be12fe41ee5b288" id="r_a156fd729674403783be12fe41ee5b288"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#ae26aaf0a13015f02f01c0e128ccebcfd">SubGroupID</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a156fd729674403783be12fe41ee5b288">GetSubGroupID</a> () const</td></tr>
  146. <tr class="separator:a156fd729674403783be12fe41ee5b288"><td class="memSeparator" colspan="2">&#160;</td></tr>
  147. <tr class="memitem:aa7e60aa0b9f6e5563ab4ca690c8e2b56" id="r_aa7e60aa0b9f6e5563ab4ca690c8e2b56"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aa7e60aa0b9f6e5563ab4ca690c8e2b56">CanCollide</a> (const <a class="el" href="class_collision_group.html">CollisionGroup</a> &amp;inOther) const</td></tr>
  148. <tr class="memdesc:aa7e60aa0b9f6e5563ab4ca690c8e2b56"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if this object collides with another object. <br /></td></tr>
  149. <tr class="separator:aa7e60aa0b9f6e5563ab4ca690c8e2b56"><td class="memSeparator" colspan="2">&#160;</td></tr>
  150. <tr class="memitem:a687bdb750277759925f00c5fb55b6835" id="r_a687bdb750277759925f00c5fb55b6835"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a687bdb750277759925f00c5fb55b6835">SaveBinaryState</a> (<a class="el" href="class_stream_out.html">StreamOut</a> &amp;inStream) const</td></tr>
  151. <tr class="memdesc:a687bdb750277759925f00c5fb55b6835"><td class="mdescLeft">&#160;</td><td class="mdescRight">Saves the state of this object in binary form to inStream. Does not save group filter. <br /></td></tr>
  152. <tr class="separator:a687bdb750277759925f00c5fb55b6835"><td class="memSeparator" colspan="2">&#160;</td></tr>
  153. <tr class="memitem:abff4339a09c8ad38cc7aee4449d5ecaf" id="r_abff4339a09c8ad38cc7aee4449d5ecaf"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#abff4339a09c8ad38cc7aee4449d5ecaf">RestoreBinaryState</a> (<a class="el" href="class_stream_in.html">StreamIn</a> &amp;inStream)</td></tr>
  154. <tr class="memdesc:abff4339a09c8ad38cc7aee4449d5ecaf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Restore the state of this object from inStream. Does not save group filter. <br /></td></tr>
  155. <tr class="separator:abff4339a09c8ad38cc7aee4449d5ecaf"><td class="memSeparator" colspan="2">&#160;</td></tr>
  156. </table><table class="memberdecls">
  157. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-attribs" name="pub-static-attribs"></a>
  158. Static Public Attributes</h2></td></tr>
  159. <tr class="memitem:a5d5f66e30eaab92fc7dd332b0fa768ad" id="r_a5d5f66e30eaab92fc7dd332b0fa768ad"><td class="memItemLeft" align="right" valign="top">static const <a class="el" href="#ab44e31c9fa83c4818b1560d71c15dddd">GroupID</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a5d5f66e30eaab92fc7dd332b0fa768ad">cInvalidGroup</a> = ~<a class="el" href="#ab44e31c9fa83c4818b1560d71c15dddd">GroupID</a>(0)</td></tr>
  160. <tr class="separator:a5d5f66e30eaab92fc7dd332b0fa768ad"><td class="memSeparator" colspan="2">&#160;</td></tr>
  161. <tr class="memitem:a8c7bb47aa601f240989362da21f116e8" id="r_a8c7bb47aa601f240989362da21f116e8"><td class="memItemLeft" align="right" valign="top">static const <a class="el" href="#ae26aaf0a13015f02f01c0e128ccebcfd">SubGroupID</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a8c7bb47aa601f240989362da21f116e8">cInvalidSubGroup</a> = ~<a class="el" href="#ae26aaf0a13015f02f01c0e128ccebcfd">SubGroupID</a>(0)</td></tr>
  162. <tr class="separator:a8c7bb47aa601f240989362da21f116e8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  163. <tr class="memitem:a5665521b5413681e474fe00d364ff6de" id="r_a5665521b5413681e474fe00d364ff6de"><td class="memItemLeft" align="right" valign="top">static const <a class="el" href="class_collision_group.html">CollisionGroup</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a5665521b5413681e474fe00d364ff6de">sInvalid</a></td></tr>
  164. <tr class="memdesc:a5665521b5413681e474fe00d364ff6de"><td class="mdescLeft">&#160;</td><td class="mdescRight">An invalid collision group. <br /></td></tr>
  165. <tr class="separator:a5665521b5413681e474fe00d364ff6de"><td class="memSeparator" colspan="2">&#160;</td></tr>
  166. </table>
  167. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  168. <div class="textblock"><p>Two objects collide with each other if:</p><ul>
  169. <li>Both don't have a group filter</li>
  170. <li>The first group filter says that the objects can collide</li>
  171. <li>Or if there's no filter for the first object, the second group filter says the objects can collide </li>
  172. </ul>
  173. </div><h2 class="groupheader">Member Typedef Documentation</h2>
  174. <a id="ab44e31c9fa83c4818b1560d71c15dddd" name="ab44e31c9fa83c4818b1560d71c15dddd"></a>
  175. <h2 class="memtitle"><span class="permalink"><a href="#ab44e31c9fa83c4818b1560d71c15dddd">&#9670;&#160;</a></span>GroupID</h2>
  176. <div class="memitem">
  177. <div class="memproto">
  178. <table class="memname">
  179. <tr>
  180. <td class="memname">using <a class="el" href="#ab44e31c9fa83c4818b1560d71c15dddd">CollisionGroup::GroupID</a> = <a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a></td>
  181. </tr>
  182. </table>
  183. </div><div class="memdoc">
  184. </div>
  185. </div>
  186. <a id="ae26aaf0a13015f02f01c0e128ccebcfd" name="ae26aaf0a13015f02f01c0e128ccebcfd"></a>
  187. <h2 class="memtitle"><span class="permalink"><a href="#ae26aaf0a13015f02f01c0e128ccebcfd">&#9670;&#160;</a></span>SubGroupID</h2>
  188. <div class="memitem">
  189. <div class="memproto">
  190. <table class="memname">
  191. <tr>
  192. <td class="memname">using <a class="el" href="#ae26aaf0a13015f02f01c0e128ccebcfd">CollisionGroup::SubGroupID</a> = <a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a></td>
  193. </tr>
  194. </table>
  195. </div><div class="memdoc">
  196. </div>
  197. </div>
  198. <h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  199. <a id="ad9f6cce170470d571b3927c44d7104ec" name="ad9f6cce170470d571b3927c44d7104ec"></a>
  200. <h2 class="memtitle"><span class="permalink"><a href="#ad9f6cce170470d571b3927c44d7104ec">&#9670;&#160;</a></span>CollisionGroup() <span class="overload">[1/2]</span></h2>
  201. <div class="memitem">
  202. <div class="memproto">
  203. <table class="mlabels">
  204. <tr>
  205. <td class="mlabels-left">
  206. <table class="memname">
  207. <tr>
  208. <td class="memname">CollisionGroup::CollisionGroup </td>
  209. <td>(</td>
  210. <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  211. <td></td>
  212. </tr>
  213. </table>
  214. </td>
  215. <td class="mlabels-right">
  216. <span class="mlabels"><span class="mlabel">default</span></span> </td>
  217. </tr>
  218. </table>
  219. </div><div class="memdoc">
  220. <p>Default constructor. </p>
  221. </div>
  222. </div>
  223. <a id="a5428cf2e49b467026e833c0955d35b30" name="a5428cf2e49b467026e833c0955d35b30"></a>
  224. <h2 class="memtitle"><span class="permalink"><a href="#a5428cf2e49b467026e833c0955d35b30">&#9670;&#160;</a></span>CollisionGroup() <span class="overload">[2/2]</span></h2>
  225. <div class="memitem">
  226. <div class="memproto">
  227. <table class="mlabels">
  228. <tr>
  229. <td class="mlabels-left">
  230. <table class="memname">
  231. <tr>
  232. <td class="memname">CollisionGroup::CollisionGroup </td>
  233. <td>(</td>
  234. <td class="paramtype">const <a class="el" href="class_group_filter.html">GroupFilter</a> *</td> <td class="paramname"><span class="paramname"><em>inFilter</em></span>, </td>
  235. </tr>
  236. <tr>
  237. <td class="paramkey"></td>
  238. <td></td>
  239. <td class="paramtype"><a class="el" href="#ab44e31c9fa83c4818b1560d71c15dddd">GroupID</a></td> <td class="paramname"><span class="paramname"><em>inGroupID</em></span>, </td>
  240. </tr>
  241. <tr>
  242. <td class="paramkey"></td>
  243. <td></td>
  244. <td class="paramtype"><a class="el" href="#ae26aaf0a13015f02f01c0e128ccebcfd">SubGroupID</a></td> <td class="paramname"><span class="paramname"><em>inSubGroupID</em></span>&#160;)</td>
  245. </tr>
  246. </table>
  247. </td>
  248. <td class="mlabels-right">
  249. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  250. </tr>
  251. </table>
  252. </div><div class="memdoc">
  253. <p>Construct with all properties. </p>
  254. </div>
  255. </div>
  256. <h2 class="groupheader">Member Function Documentation</h2>
  257. <a id="aa7e60aa0b9f6e5563ab4ca690c8e2b56" name="aa7e60aa0b9f6e5563ab4ca690c8e2b56"></a>
  258. <h2 class="memtitle"><span class="permalink"><a href="#aa7e60aa0b9f6e5563ab4ca690c8e2b56">&#9670;&#160;</a></span>CanCollide()</h2>
  259. <div class="memitem">
  260. <div class="memproto">
  261. <table class="mlabels">
  262. <tr>
  263. <td class="mlabels-left">
  264. <table class="memname">
  265. <tr>
  266. <td class="memname">bool CollisionGroup::CanCollide </td>
  267. <td>(</td>
  268. <td class="paramtype">const <a class="el" href="class_collision_group.html">CollisionGroup</a> &amp;</td> <td class="paramname"><span class="paramname"><em>inOther</em></span></td><td>)</td>
  269. <td> const</td>
  270. </tr>
  271. </table>
  272. </td>
  273. <td class="mlabels-right">
  274. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  275. </tr>
  276. </table>
  277. </div><div class="memdoc">
  278. <p>Check if this object collides with another object. </p>
  279. </div>
  280. </div>
  281. <a id="abcda9f0cd8d5d8b2ee42bee0a19430a7" name="abcda9f0cd8d5d8b2ee42bee0a19430a7"></a>
  282. <h2 class="memtitle"><span class="permalink"><a href="#abcda9f0cd8d5d8b2ee42bee0a19430a7">&#9670;&#160;</a></span>GetGroupFilter()</h2>
  283. <div class="memitem">
  284. <div class="memproto">
  285. <table class="mlabels">
  286. <tr>
  287. <td class="mlabels-left">
  288. <table class="memname">
  289. <tr>
  290. <td class="memname">const <a class="el" href="class_group_filter.html">GroupFilter</a> * CollisionGroup::GetGroupFilter </td>
  291. <td>(</td>
  292. <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  293. <td> const</td>
  294. </tr>
  295. </table>
  296. </td>
  297. <td class="mlabels-right">
  298. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  299. </tr>
  300. </table>
  301. </div><div class="memdoc">
  302. <p>Get the collision group filter. </p>
  303. </div>
  304. </div>
  305. <a id="a1521cec7d03c83265aecca64ec684433" name="a1521cec7d03c83265aecca64ec684433"></a>
  306. <h2 class="memtitle"><span class="permalink"><a href="#a1521cec7d03c83265aecca64ec684433">&#9670;&#160;</a></span>GetGroupID()</h2>
  307. <div class="memitem">
  308. <div class="memproto">
  309. <table class="mlabels">
  310. <tr>
  311. <td class="mlabels-left">
  312. <table class="memname">
  313. <tr>
  314. <td class="memname"><a class="el" href="#ab44e31c9fa83c4818b1560d71c15dddd">GroupID</a> CollisionGroup::GetGroupID </td>
  315. <td>(</td>
  316. <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  317. <td> const</td>
  318. </tr>
  319. </table>
  320. </td>
  321. <td class="mlabels-right">
  322. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  323. </tr>
  324. </table>
  325. </div><div class="memdoc">
  326. </div>
  327. </div>
  328. <a id="a156fd729674403783be12fe41ee5b288" name="a156fd729674403783be12fe41ee5b288"></a>
  329. <h2 class="memtitle"><span class="permalink"><a href="#a156fd729674403783be12fe41ee5b288">&#9670;&#160;</a></span>GetSubGroupID()</h2>
  330. <div class="memitem">
  331. <div class="memproto">
  332. <table class="mlabels">
  333. <tr>
  334. <td class="mlabels-left">
  335. <table class="memname">
  336. <tr>
  337. <td class="memname"><a class="el" href="#ae26aaf0a13015f02f01c0e128ccebcfd">SubGroupID</a> CollisionGroup::GetSubGroupID </td>
  338. <td>(</td>
  339. <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  340. <td> const</td>
  341. </tr>
  342. </table>
  343. </td>
  344. <td class="mlabels-right">
  345. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  346. </tr>
  347. </table>
  348. </div><div class="memdoc">
  349. </div>
  350. </div>
  351. <a id="abff4339a09c8ad38cc7aee4449d5ecaf" name="abff4339a09c8ad38cc7aee4449d5ecaf"></a>
  352. <h2 class="memtitle"><span class="permalink"><a href="#abff4339a09c8ad38cc7aee4449d5ecaf">&#9670;&#160;</a></span>RestoreBinaryState()</h2>
  353. <div class="memitem">
  354. <div class="memproto">
  355. <table class="memname">
  356. <tr>
  357. <td class="memname">void CollisionGroup::RestoreBinaryState </td>
  358. <td>(</td>
  359. <td class="paramtype"><a class="el" href="class_stream_in.html">StreamIn</a> &amp;</td> <td class="paramname"><span class="paramname"><em>inStream</em></span></td><td>)</td>
  360. <td></td>
  361. </tr>
  362. </table>
  363. </div><div class="memdoc">
  364. <p>Restore the state of this object from inStream. Does not save group filter. </p>
  365. </div>
  366. </div>
  367. <a id="a687bdb750277759925f00c5fb55b6835" name="a687bdb750277759925f00c5fb55b6835"></a>
  368. <h2 class="memtitle"><span class="permalink"><a href="#a687bdb750277759925f00c5fb55b6835">&#9670;&#160;</a></span>SaveBinaryState()</h2>
  369. <div class="memitem">
  370. <div class="memproto">
  371. <table class="memname">
  372. <tr>
  373. <td class="memname">void CollisionGroup::SaveBinaryState </td>
  374. <td>(</td>
  375. <td class="paramtype"><a class="el" href="class_stream_out.html">StreamOut</a> &amp;</td> <td class="paramname"><span class="paramname"><em>inStream</em></span></td><td>)</td>
  376. <td> const</td>
  377. </tr>
  378. </table>
  379. </div><div class="memdoc">
  380. <p>Saves the state of this object in binary form to inStream. Does not save group filter. </p>
  381. </div>
  382. </div>
  383. <a id="a24632cad19f63669929509eceb904290" name="a24632cad19f63669929509eceb904290"></a>
  384. <h2 class="memtitle"><span class="permalink"><a href="#a24632cad19f63669929509eceb904290">&#9670;&#160;</a></span>SetGroupFilter()</h2>
  385. <div class="memitem">
  386. <div class="memproto">
  387. <table class="mlabels">
  388. <tr>
  389. <td class="mlabels-left">
  390. <table class="memname">
  391. <tr>
  392. <td class="memname">void CollisionGroup::SetGroupFilter </td>
  393. <td>(</td>
  394. <td class="paramtype">const <a class="el" href="class_group_filter.html">GroupFilter</a> *</td> <td class="paramname"><span class="paramname"><em>inFilter</em></span></td><td>)</td>
  395. <td></td>
  396. </tr>
  397. </table>
  398. </td>
  399. <td class="mlabels-right">
  400. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  401. </tr>
  402. </table>
  403. </div><div class="memdoc">
  404. <p>Set the collision group filter. </p>
  405. </div>
  406. </div>
  407. <a id="ab49afbb0cbf8526e2b1ee89d8f2a34dd" name="ab49afbb0cbf8526e2b1ee89d8f2a34dd"></a>
  408. <h2 class="memtitle"><span class="permalink"><a href="#ab49afbb0cbf8526e2b1ee89d8f2a34dd">&#9670;&#160;</a></span>SetGroupID()</h2>
  409. <div class="memitem">
  410. <div class="memproto">
  411. <table class="mlabels">
  412. <tr>
  413. <td class="mlabels-left">
  414. <table class="memname">
  415. <tr>
  416. <td class="memname">void CollisionGroup::SetGroupID </td>
  417. <td>(</td>
  418. <td class="paramtype"><a class="el" href="#ab44e31c9fa83c4818b1560d71c15dddd">GroupID</a></td> <td class="paramname"><span class="paramname"><em>inID</em></span></td><td>)</td>
  419. <td></td>
  420. </tr>
  421. </table>
  422. </td>
  423. <td class="mlabels-right">
  424. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  425. </tr>
  426. </table>
  427. </div><div class="memdoc">
  428. <p>Set the main group id for this object. </p>
  429. </div>
  430. </div>
  431. <a id="a9ac2eb88530e8281a130bd73539d127b" name="a9ac2eb88530e8281a130bd73539d127b"></a>
  432. <h2 class="memtitle"><span class="permalink"><a href="#a9ac2eb88530e8281a130bd73539d127b">&#9670;&#160;</a></span>SetSubGroupID()</h2>
  433. <div class="memitem">
  434. <div class="memproto">
  435. <table class="mlabels">
  436. <tr>
  437. <td class="mlabels-left">
  438. <table class="memname">
  439. <tr>
  440. <td class="memname">void CollisionGroup::SetSubGroupID </td>
  441. <td>(</td>
  442. <td class="paramtype"><a class="el" href="#ae26aaf0a13015f02f01c0e128ccebcfd">SubGroupID</a></td> <td class="paramname"><span class="paramname"><em>inID</em></span></td><td>)</td>
  443. <td></td>
  444. </tr>
  445. </table>
  446. </td>
  447. <td class="mlabels-right">
  448. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  449. </tr>
  450. </table>
  451. </div><div class="memdoc">
  452. <p>Add this object to a sub group. </p>
  453. </div>
  454. </div>
  455. <h2 class="groupheader">Member Data Documentation</h2>
  456. <a id="a5d5f66e30eaab92fc7dd332b0fa768ad" name="a5d5f66e30eaab92fc7dd332b0fa768ad"></a>
  457. <h2 class="memtitle"><span class="permalink"><a href="#a5d5f66e30eaab92fc7dd332b0fa768ad">&#9670;&#160;</a></span>cInvalidGroup</h2>
  458. <div class="memitem">
  459. <div class="memproto">
  460. <table class="mlabels">
  461. <tr>
  462. <td class="mlabels-left">
  463. <table class="memname">
  464. <tr>
  465. <td class="memname">const <a class="el" href="#ab44e31c9fa83c4818b1560d71c15dddd">GroupID</a> CollisionGroup::cInvalidGroup = ~<a class="el" href="#ab44e31c9fa83c4818b1560d71c15dddd">GroupID</a>(0)</td>
  466. </tr>
  467. </table>
  468. </td>
  469. <td class="mlabels-right">
  470. <span class="mlabels"><span class="mlabel">static</span></span> </td>
  471. </tr>
  472. </table>
  473. </div><div class="memdoc">
  474. </div>
  475. </div>
  476. <a id="a8c7bb47aa601f240989362da21f116e8" name="a8c7bb47aa601f240989362da21f116e8"></a>
  477. <h2 class="memtitle"><span class="permalink"><a href="#a8c7bb47aa601f240989362da21f116e8">&#9670;&#160;</a></span>cInvalidSubGroup</h2>
  478. <div class="memitem">
  479. <div class="memproto">
  480. <table class="mlabels">
  481. <tr>
  482. <td class="mlabels-left">
  483. <table class="memname">
  484. <tr>
  485. <td class="memname">const <a class="el" href="#ae26aaf0a13015f02f01c0e128ccebcfd">SubGroupID</a> CollisionGroup::cInvalidSubGroup = ~<a class="el" href="#ae26aaf0a13015f02f01c0e128ccebcfd">SubGroupID</a>(0)</td>
  486. </tr>
  487. </table>
  488. </td>
  489. <td class="mlabels-right">
  490. <span class="mlabels"><span class="mlabel">static</span></span> </td>
  491. </tr>
  492. </table>
  493. </div><div class="memdoc">
  494. </div>
  495. </div>
  496. <a id="a5665521b5413681e474fe00d364ff6de" name="a5665521b5413681e474fe00d364ff6de"></a>
  497. <h2 class="memtitle"><span class="permalink"><a href="#a5665521b5413681e474fe00d364ff6de">&#9670;&#160;</a></span>sInvalid</h2>
  498. <div class="memitem">
  499. <div class="memproto">
  500. <table class="mlabels">
  501. <tr>
  502. <td class="mlabels-left">
  503. <table class="memname">
  504. <tr>
  505. <td class="memname">const <a class="el" href="class_collision_group.html">CollisionGroup</a> CollisionGroup::sInvalid</td>
  506. </tr>
  507. </table>
  508. </td>
  509. <td class="mlabels-right">
  510. <span class="mlabels"><span class="mlabel">static</span></span> </td>
  511. </tr>
  512. </table>
  513. </div><div class="memdoc">
  514. <p>An invalid collision group. </p>
  515. </div>
  516. </div>
  517. <hr/>The documentation for this class was generated from the following files:<ul>
  518. <li>Jolt/Physics/Collision/<a class="el" href="_collision_group_8h_source.html">CollisionGroup.h</a></li>
  519. <li>Jolt/Physics/Collision/<a class="el" href="_collision_group_8cpp.html">CollisionGroup.cpp</a></li>
  520. </ul>
  521. </div><!-- contents -->
  522. </div><!-- doc-content -->
  523. <!-- start footer part -->
  524. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  525. <ul>
  526. <li class="navelem"><a class="el" href="class_collision_group.html">CollisionGroup</a></li>
  527. <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>
  528. </ul>
  529. </div>
  530. </body>
  531. </html>