class_closest_hit_collision_collector.html 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285
  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: ClosestHitCollisionCollector&lt; CollectorType &gt; Class Template 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_closest_hit_collision_collector.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-attribs">Public Attributes</a> &#124;
  110. <a href="class_closest_hit_collision_collector-members.html">List of all members</a> </div>
  111. <div class="headertitle"><div class="title">ClosestHitCollisionCollector&lt; CollectorType &gt; Class Template Reference</div></div>
  112. </div><!--header-->
  113. <div class="contents">
  114. <p>Simple implementation that collects the closest / deepest hit.
  115. <a href="#details">More...</a></p>
  116. <p><code>#include &lt;<a class="el" href="_collision_collector_impl_8h_source.html">CollisionCollectorImpl.h</a>&gt;</code></p>
  117. <div class="dynheader">
  118. Inheritance diagram for ClosestHitCollisionCollector&lt; CollectorType &gt;:</div>
  119. <div class="dyncontent">
  120. <div class="center">
  121. <img src="class_closest_hit_collision_collector.png" alt=""/>
  122. </div></div>
  123. <table class="memberdecls">
  124. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-types" name="pub-types"></a>
  125. Public Types</h2></td></tr>
  126. <tr class="memitem:afe58b3f7279a8934bb7faca08f68bdf7" id="r_afe58b3f7279a8934bb7faca08f68bdf7"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#afe58b3f7279a8934bb7faca08f68bdf7">ResultType</a> = typename CollectorType::ResultType</td></tr>
  127. <tr class="memdesc:afe58b3f7279a8934bb7faca08f68bdf7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Redeclare ResultType. <br /></td></tr>
  128. <tr class="separator:afe58b3f7279a8934bb7faca08f68bdf7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  129. </table><table class="memberdecls">
  130. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
  131. Public Member Functions</h2></td></tr>
  132. <tr class="memitem:a14955035534ef11baa2d3785ba004eee" id="r_a14955035534ef11baa2d3785ba004eee"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a14955035534ef11baa2d3785ba004eee">Reset</a> () override</td></tr>
  133. <tr class="separator:a14955035534ef11baa2d3785ba004eee"><td class="memSeparator" colspan="2">&#160;</td></tr>
  134. <tr class="memitem:a59e5b29507bc2aa633fe55c0bb08ff3e" id="r_a59e5b29507bc2aa633fe55c0bb08ff3e"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a59e5b29507bc2aa633fe55c0bb08ff3e">AddHit</a> (const <a class="el" href="#afe58b3f7279a8934bb7faca08f68bdf7">ResultType</a> &amp;inResult) override</td></tr>
  135. <tr class="separator:a59e5b29507bc2aa633fe55c0bb08ff3e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  136. <tr class="memitem:aa9679e95456d67c8f813e6f13de6e65c" id="r_aa9679e95456d67c8f813e6f13de6e65c"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aa9679e95456d67c8f813e6f13de6e65c">HadHit</a> () const</td></tr>
  137. <tr class="memdesc:aa9679e95456d67c8f813e6f13de6e65c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if this collector has had a hit. <br /></td></tr>
  138. <tr class="separator:aa9679e95456d67c8f813e6f13de6e65c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  139. </table><table class="memberdecls">
  140. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
  141. Public Attributes</h2></td></tr>
  142. <tr class="memitem:a770bdcdb6dc04ab4070aad443395e642" id="r_a770bdcdb6dc04ab4070aad443395e642"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#afe58b3f7279a8934bb7faca08f68bdf7">ResultType</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a770bdcdb6dc04ab4070aad443395e642">mHit</a></td></tr>
  143. <tr class="separator:a770bdcdb6dc04ab4070aad443395e642"><td class="memSeparator" colspan="2">&#160;</td></tr>
  144. </table>
  145. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  146. <div class="textblock"><div class="compoundTemplParams">template&lt;class CollectorType&gt;<br />
  147. class ClosestHitCollisionCollector&lt; CollectorType &gt;</div><p>Simple implementation that collects the closest / deepest hit. </p>
  148. </div><h2 class="groupheader">Member Typedef Documentation</h2>
  149. <a id="afe58b3f7279a8934bb7faca08f68bdf7" name="afe58b3f7279a8934bb7faca08f68bdf7"></a>
  150. <h2 class="memtitle"><span class="permalink"><a href="#afe58b3f7279a8934bb7faca08f68bdf7">&#9670;&#160;</a></span>ResultType</h2>
  151. <div class="memitem">
  152. <div class="memproto">
  153. <div class="memtemplate">
  154. template&lt;class CollectorType &gt; </div>
  155. <table class="memname">
  156. <tr>
  157. <td class="memname">using <a class="el" href="class_closest_hit_collision_collector.html">ClosestHitCollisionCollector</a>&lt; CollectorType &gt;::ResultType = typename CollectorType::ResultType</td>
  158. </tr>
  159. </table>
  160. </div><div class="memdoc">
  161. <p>Redeclare ResultType. </p>
  162. </div>
  163. </div>
  164. <h2 class="groupheader">Member Function Documentation</h2>
  165. <a id="a59e5b29507bc2aa633fe55c0bb08ff3e" name="a59e5b29507bc2aa633fe55c0bb08ff3e"></a>
  166. <h2 class="memtitle"><span class="permalink"><a href="#a59e5b29507bc2aa633fe55c0bb08ff3e">&#9670;&#160;</a></span>AddHit()</h2>
  167. <div class="memitem">
  168. <div class="memproto">
  169. <div class="memtemplate">
  170. template&lt;class CollectorType &gt; </div>
  171. <table class="mlabels">
  172. <tr>
  173. <td class="mlabels-left">
  174. <table class="memname">
  175. <tr>
  176. <td class="memname">virtual void <a class="el" href="class_closest_hit_collision_collector.html">ClosestHitCollisionCollector</a>&lt; CollectorType &gt;::AddHit </td>
  177. <td>(</td>
  178. <td class="paramtype">const <a class="el" href="#afe58b3f7279a8934bb7faca08f68bdf7">ResultType</a> &amp;</td> <td class="paramname"><span class="paramname"><em>inResult</em></span></td><td>)</td>
  179. <td></td>
  180. </tr>
  181. </table>
  182. </td>
  183. <td class="mlabels-right">
  184. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
  185. </tr>
  186. </table>
  187. </div><div class="memdoc">
  188. </div>
  189. </div>
  190. <a id="aa9679e95456d67c8f813e6f13de6e65c" name="aa9679e95456d67c8f813e6f13de6e65c"></a>
  191. <h2 class="memtitle"><span class="permalink"><a href="#aa9679e95456d67c8f813e6f13de6e65c">&#9670;&#160;</a></span>HadHit()</h2>
  192. <div class="memitem">
  193. <div class="memproto">
  194. <div class="memtemplate">
  195. template&lt;class CollectorType &gt; </div>
  196. <table class="mlabels">
  197. <tr>
  198. <td class="mlabels-left">
  199. <table class="memname">
  200. <tr>
  201. <td class="memname">bool <a class="el" href="class_closest_hit_collision_collector.html">ClosestHitCollisionCollector</a>&lt; CollectorType &gt;::HadHit </td>
  202. <td>(</td>
  203. <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  204. <td> const</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. <p>Check if this collector has had a hit. </p>
  214. </div>
  215. </div>
  216. <a id="a14955035534ef11baa2d3785ba004eee" name="a14955035534ef11baa2d3785ba004eee"></a>
  217. <h2 class="memtitle"><span class="permalink"><a href="#a14955035534ef11baa2d3785ba004eee">&#9670;&#160;</a></span>Reset()</h2>
  218. <div class="memitem">
  219. <div class="memproto">
  220. <div class="memtemplate">
  221. template&lt;class CollectorType &gt; </div>
  222. <table class="mlabels">
  223. <tr>
  224. <td class="mlabels-left">
  225. <table class="memname">
  226. <tr>
  227. <td class="memname">virtual void <a class="el" href="class_closest_hit_collision_collector.html">ClosestHitCollisionCollector</a>&lt; CollectorType &gt;::Reset </td>
  228. <td>(</td>
  229. <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  230. <td></td>
  231. </tr>
  232. </table>
  233. </td>
  234. <td class="mlabels-right">
  235. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
  236. </tr>
  237. </table>
  238. </div><div class="memdoc">
  239. </div>
  240. </div>
  241. <h2 class="groupheader">Member Data Documentation</h2>
  242. <a id="a770bdcdb6dc04ab4070aad443395e642" name="a770bdcdb6dc04ab4070aad443395e642"></a>
  243. <h2 class="memtitle"><span class="permalink"><a href="#a770bdcdb6dc04ab4070aad443395e642">&#9670;&#160;</a></span>mHit</h2>
  244. <div class="memitem">
  245. <div class="memproto">
  246. <div class="memtemplate">
  247. template&lt;class CollectorType &gt; </div>
  248. <table class="memname">
  249. <tr>
  250. <td class="memname"><a class="el" href="#afe58b3f7279a8934bb7faca08f68bdf7">ResultType</a> <a class="el" href="class_closest_hit_collision_collector.html">ClosestHitCollisionCollector</a>&lt; CollectorType &gt;::mHit</td>
  251. </tr>
  252. </table>
  253. </div><div class="memdoc">
  254. </div>
  255. </div>
  256. <hr/>The documentation for this class was generated from the following file:<ul>
  257. <li>Jolt/Physics/Collision/<a class="el" href="_collision_collector_impl_8h_source.html">CollisionCollectorImpl.h</a></li>
  258. </ul>
  259. </div><!-- contents -->
  260. </div><!-- doc-content -->
  261. <!-- start footer part -->
  262. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  263. <ul>
  264. <li class="navelem"><a class="el" href="class_closest_hit_collision_collector.html">ClosestHitCollisionCollector</a></li>
  265. <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>
  266. </ul>
  267. </div>
  268. </body>
  269. </html>