class_reversed_shape_filter.html 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289
  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: ReversedShapeFilter 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_reversed_shape_filter.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_reversed_shape_filter-members.html">List of all members</a> </div>
  109. <div class="headertitle"><div class="title">ReversedShapeFilter Class Reference</div></div>
  110. </div><!--header-->
  111. <div class="contents">
  112. <p>Helper class to reverse the order of the shapes in the ShouldCollide function.
  113. <a href="#details">More...</a></p>
  114. <p><code>#include &lt;<a class="el" href="_shape_filter_8h_source.html">ShapeFilter.h</a>&gt;</code></p>
  115. <div class="dynheader">
  116. Inheritance diagram for ReversedShapeFilter:</div>
  117. <div class="dyncontent">
  118. <div class="center">
  119. <img src="class_reversed_shape_filter.png" usemap="#ReversedShapeFilter_map" alt=""/>
  120. <map id="ReversedShapeFilter_map" name="ReversedShapeFilter_map">
  121. <area href="class_shape_filter.html" title="Filter class." alt="ShapeFilter" shape="rect" coords="0,56,131,80"/>
  122. <area href="class_non_copyable.html" title="Class that makes another class non-copyable. Usage: Inherit from NonCopyable." alt="NonCopyable" shape="rect" coords="0,0,131,24"/>
  123. </map>
  124. </div></div>
  125. <table class="memberdecls">
  126. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
  127. Public Member Functions</h2></td></tr>
  128. <tr class="memitem:aa0287d910b05b97b4cdc4fed9851e0a0" id="r_aa0287d910b05b97b4cdc4fed9851e0a0"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aa0287d910b05b97b4cdc4fed9851e0a0">ReversedShapeFilter</a> (const <a class="el" href="class_shape_filter.html">ShapeFilter</a> &amp;inFilter)</td></tr>
  129. <tr class="memdesc:aa0287d910b05b97b4cdc4fed9851e0a0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor. <br /></td></tr>
  130. <tr class="separator:aa0287d910b05b97b4cdc4fed9851e0a0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  131. <tr class="memitem:a0da8f32256715a06181081750a1d6229" id="r_a0da8f32256715a06181081750a1d6229"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a0da8f32256715a06181081750a1d6229">ShouldCollide</a> (const <a class="el" href="class_shape.html">Shape</a> *inShape2, const <a class="el" href="class_sub_shape_i_d.html">SubShapeID</a> &amp;inSubShapeIDOfShape2) const override</td></tr>
  132. <tr class="separator:a0da8f32256715a06181081750a1d6229"><td class="memSeparator" colspan="2">&#160;</td></tr>
  133. <tr class="memitem:a78f5767dd29b71003df33a9743b3bb73" id="r_a78f5767dd29b71003df33a9743b3bb73"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a78f5767dd29b71003df33a9743b3bb73">ShouldCollide</a> (const <a class="el" href="class_shape.html">Shape</a> *inShape1, const <a class="el" href="class_sub_shape_i_d.html">SubShapeID</a> &amp;inSubShapeIDOfShape1, const <a class="el" href="class_shape.html">Shape</a> *inShape2, const <a class="el" href="class_sub_shape_i_d.html">SubShapeID</a> &amp;inSubShapeIDOfShape2) const override</td></tr>
  134. <tr class="separator:a78f5767dd29b71003df33a9743b3bb73"><td class="memSeparator" colspan="2">&#160;</td></tr>
  135. <tr class="inherit_header pub_methods_class_shape_filter"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pub_methods_class_shape_filter')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="class_shape_filter.html">ShapeFilter</a></td></tr>
  136. <tr class="memitem:acdf737ff32ada90df769acf6b25cc86a inherit pub_methods_class_shape_filter" id="r_acdf737ff32ada90df769acf6b25cc86a"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_shape_filter.html#acdf737ff32ada90df769acf6b25cc86a">~ShapeFilter</a> ()=default</td></tr>
  137. <tr class="memdesc:acdf737ff32ada90df769acf6b25cc86a inherit pub_methods_class_shape_filter"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor. <br /></td></tr>
  138. <tr class="separator:acdf737ff32ada90df769acf6b25cc86a inherit pub_methods_class_shape_filter"><td class="memSeparator" colspan="2">&#160;</td></tr>
  139. <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>
  140. <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>
  141. <tr class="separator:a809b6e4ade7ae32f6d248f2a3b783d45 inherit pub_methods_class_non_copyable"><td class="memSeparator" colspan="2">&#160;</td></tr>
  142. <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>
  143. <tr class="separator:a501d34ffcc34b30de6d541887a901057 inherit pub_methods_class_non_copyable"><td class="memSeparator" colspan="2">&#160;</td></tr>
  144. <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>
  145. <tr class="separator:aaf9b12dcaae80c9d304df7a941d4e21f inherit pub_methods_class_non_copyable"><td class="memSeparator" colspan="2">&#160;</td></tr>
  146. </table><table class="memberdecls">
  147. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="inherited" name="inherited"></a>
  148. Additional Inherited Members</h2></td></tr>
  149. <tr class="inherit_header pub_attribs_class_shape_filter"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pub_attribs_class_shape_filter')"><img src="closed.png" alt="-"/>&#160;Public Attributes inherited from <a class="el" href="class_shape_filter.html">ShapeFilter</a></td></tr>
  150. <tr class="memitem:acfbd3ed4accf1e4e5d74129d203650ed inherit pub_attribs_class_shape_filter" id="r_acfbd3ed4accf1e4e5d74129d203650ed"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_body_i_d.html">BodyID</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_shape_filter.html#acfbd3ed4accf1e4e5d74129d203650ed">mBodyID2</a></td></tr>
  151. <tr class="separator:acfbd3ed4accf1e4e5d74129d203650ed inherit pub_attribs_class_shape_filter"><td class="memSeparator" colspan="2">&#160;</td></tr>
  152. </table>
  153. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  154. <div class="textblock"><p>Helper class to reverse the order of the shapes in the ShouldCollide function. </p>
  155. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  156. <a id="aa0287d910b05b97b4cdc4fed9851e0a0" name="aa0287d910b05b97b4cdc4fed9851e0a0"></a>
  157. <h2 class="memtitle"><span class="permalink"><a href="#aa0287d910b05b97b4cdc4fed9851e0a0">&#9670;&#160;</a></span>ReversedShapeFilter()</h2>
  158. <div class="memitem">
  159. <div class="memproto">
  160. <table class="mlabels">
  161. <tr>
  162. <td class="mlabels-left">
  163. <table class="memname">
  164. <tr>
  165. <td class="memname">ReversedShapeFilter::ReversedShapeFilter </td>
  166. <td>(</td>
  167. <td class="paramtype">const <a class="el" href="class_shape_filter.html">ShapeFilter</a> &amp;</td> <td class="paramname"><span class="paramname"><em>inFilter</em></span></td><td>)</td>
  168. <td></td>
  169. </tr>
  170. </table>
  171. </td>
  172. <td class="mlabels-right">
  173. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">explicit</span></span> </td>
  174. </tr>
  175. </table>
  176. </div><div class="memdoc">
  177. <p>Constructor. </p>
  178. </div>
  179. </div>
  180. <h2 class="groupheader">Member Function Documentation</h2>
  181. <a id="a78f5767dd29b71003df33a9743b3bb73" name="a78f5767dd29b71003df33a9743b3bb73"></a>
  182. <h2 class="memtitle"><span class="permalink"><a href="#a78f5767dd29b71003df33a9743b3bb73">&#9670;&#160;</a></span>ShouldCollide() <span class="overload">[1/2]</span></h2>
  183. <div class="memitem">
  184. <div class="memproto">
  185. <table class="mlabels">
  186. <tr>
  187. <td class="mlabels-left">
  188. <table class="memname">
  189. <tr>
  190. <td class="memname">virtual bool ReversedShapeFilter::ShouldCollide </td>
  191. <td>(</td>
  192. <td class="paramtype">const <a class="el" href="class_shape.html">Shape</a> *</td> <td class="paramname"><span class="paramname"><em>inShape1</em></span>, </td>
  193. </tr>
  194. <tr>
  195. <td class="paramkey"></td>
  196. <td></td>
  197. <td class="paramtype">const <a class="el" href="class_sub_shape_i_d.html">SubShapeID</a> &amp;</td> <td class="paramname"><span class="paramname"><em>inSubShapeIDOfShape1</em></span>, </td>
  198. </tr>
  199. <tr>
  200. <td class="paramkey"></td>
  201. <td></td>
  202. <td class="paramtype">const <a class="el" href="class_shape.html">Shape</a> *</td> <td class="paramname"><span class="paramname"><em>inShape2</em></span>, </td>
  203. </tr>
  204. <tr>
  205. <td class="paramkey"></td>
  206. <td></td>
  207. <td class="paramtype">const <a class="el" href="class_sub_shape_i_d.html">SubShapeID</a> &amp;</td> <td class="paramname"><span class="paramname"><em>inSubShapeIDOfShape2</em></span>&#160;) const</td>
  208. </tr>
  209. </table>
  210. </td>
  211. <td class="mlabels-right">
  212. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
  213. </tr>
  214. </table>
  215. </div><div class="memdoc">
  216. <p>Filter function to determine if two shapes should collide. Returns true if the filter passes. This overload is called when querying a shape vs a shape (e.g. collide object / cast object). It is called at each level of the shape hierarchy, so if you have a compound shape with a box, this function will be called twice. It will not be called on triangles that are part of another shape, i.e a mesh shape will not trigger a callback per triangle. You can filter out individual triangles in the <a class="el" href="class_collision_collector.html#a762c35402676662897e50dd8224e496e" title="This function will be called for every hit found, it&#39;s up to the application to decide how to store t...">CollisionCollector::AddHit</a> function by their sub shape ID. </p><dl class="params"><dt>Parameters</dt><dd>
  217. <table class="params">
  218. <tr><td class="paramname">inShape1</td><td>1st shape that is colliding </td></tr>
  219. <tr><td class="paramname">inSubShapeIDOfShape1</td><td>The sub shape ID that will lead from the root shape to inShape1 (i.e. the shape that is used to collide or cast against shape 2) </td></tr>
  220. <tr><td class="paramname">inShape2</td><td>2nd shape that is colliding </td></tr>
  221. <tr><td class="paramname">inSubShapeIDOfShape2</td><td>The sub shape ID that will lead from the root shape to inShape2 (i.e. the shape of mBodyID2) </td></tr>
  222. </table>
  223. </dd>
  224. </dl>
  225. <p>Reimplemented from <a class="el" href="class_shape_filter.html#a5e0b842fca969a0b6fee6e531273db51">ShapeFilter</a>.</p>
  226. </div>
  227. </div>
  228. <a id="a0da8f32256715a06181081750a1d6229" name="a0da8f32256715a06181081750a1d6229"></a>
  229. <h2 class="memtitle"><span class="permalink"><a href="#a0da8f32256715a06181081750a1d6229">&#9670;&#160;</a></span>ShouldCollide() <span class="overload">[2/2]</span></h2>
  230. <div class="memitem">
  231. <div class="memproto">
  232. <table class="mlabels">
  233. <tr>
  234. <td class="mlabels-left">
  235. <table class="memname">
  236. <tr>
  237. <td class="memname">virtual bool ReversedShapeFilter::ShouldCollide </td>
  238. <td>(</td>
  239. <td class="paramtype">const <a class="el" href="class_shape.html">Shape</a> *</td> <td class="paramname"><span class="paramname"><em>inShape2</em></span>, </td>
  240. </tr>
  241. <tr>
  242. <td class="paramkey"></td>
  243. <td></td>
  244. <td class="paramtype">const <a class="el" href="class_sub_shape_i_d.html">SubShapeID</a> &amp;</td> <td class="paramname"><span class="paramname"><em>inSubShapeIDOfShape2</em></span>&#160;) const</td>
  245. </tr>
  246. </table>
  247. </td>
  248. <td class="mlabels-right">
  249. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
  250. </tr>
  251. </table>
  252. </div><div class="memdoc">
  253. <p>Filter function to determine if we should collide with a shape. Returns true if the filter passes. This overload is called when the query doesn't have a source shape (e.g. ray cast / collide point) </p><dl class="params"><dt>Parameters</dt><dd>
  254. <table class="params">
  255. <tr><td class="paramname">inShape2</td><td><a class="el" href="class_shape.html" title="Base class for all shapes (collision volume of a body). Defines a virtual interface for collision det...">Shape</a> we're colliding against </td></tr>
  256. <tr><td class="paramname">inSubShapeIDOfShape2</td><td>The sub shape ID that will lead from the root shape to inShape2 (i.e. the shape of mBodyID2) </td></tr>
  257. </table>
  258. </dd>
  259. </dl>
  260. <p>Reimplemented from <a class="el" href="class_shape_filter.html#a34e0af56ee8eff11096ed8926e87f2c5">ShapeFilter</a>.</p>
  261. </div>
  262. </div>
  263. <hr/>The documentation for this class was generated from the following file:<ul>
  264. <li>Jolt/Physics/Collision/<a class="el" href="_shape_filter_8h_source.html">ShapeFilter.h</a></li>
  265. </ul>
  266. </div><!-- contents -->
  267. </div><!-- doc-content -->
  268. <!-- start footer part -->
  269. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  270. <ul>
  271. <li class="navelem"><a class="el" href="class_reversed_shape_filter.html">ReversedShapeFilter</a></li>
  272. <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>
  273. </ul>
  274. </div>
  275. </body>
  276. </html>