Home Explore Help
Sign In
cpp
/
JoltPhysics
mirror of https://github.com/jrouwe/JoltPhysics.git
2
0
Fork 0
Files Issues 0 Wiki
Branch: gh-pages
Branches Tags
JoltPhysics
/
_collision_collector_8h_source.html

_collision_collector_8h_source.html 38 KB
Permalink History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243 
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
    2. 

  2. <html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
    3. 

  3. <head>
    4. 

  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
    5. 

  5. <meta http-equiv="X-UA-Compatible" content="IE=11"/>
    6. 

  6. <meta name="generator" content="Doxygen 1.12.0"/>
    7. 

  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
    8. 

  8. <title>Jolt Physics: Jolt/Physics/Collision/CollisionCollector.h Source File</title>
    9. 

  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
    10. 

  10. <script type="text/javascript" src="jquery.js"></script>
    11. 

  11. <script type="text/javascript" src="dynsections.js"></script>
    12. 

  12. <script type="text/javascript" src="clipboard.js"></script>
    13. 

  13. <link href="navtree.css" rel="stylesheet" type="text/css"/>
    14. 

  14. <script type="text/javascript" src="navtreedata.js"></script>
    15. 

  15. <script type="text/javascript" src="navtree.js"></script>
    16. 

  16. <script type="text/javascript" src="resize.js"></script>
    17. 

  17. <script type="text/javascript" src="cookie.js"></script>
    18. 

  18. <link href="search/search.css" rel="stylesheet" type="text/css"/>
    19. 

  19. <script type="text/javascript" src="search/searchdata.js"></script>
    20. 

  20. <script type="text/javascript" src="search/search.js"></script>
    21. 

  21. <script type="text/x-mathjax-config">
    22. 

  22. MathJax.Hub.Config({
    23. 

  23.   extensions: ["tex2jax.js"],
    24. 

  24.   jax: ["input/TeX","output/HTML-CSS"],
    25. 

  25. });
    26. 

  26. </script>
    27. 

  27. <script type="text/javascript" async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js"></script>
    28. 

  28. <link href="doxygen.css" rel="stylesheet" type="text/css" />
    29. 

  29. </head>
    30. 

  30. <body>
    31. 

  31. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
    32. 

  32. <div id="titlearea">
    33. 

  33. <table cellspacing="0" cellpadding="0">
    34. 

  34.  <tbody>
    35. 

  35.  <tr id="projectrow">
    36. 

  36.   <td id="projectlogo"><img alt="Logo" src="LogoSmall.png"/></td>
    37. 

  37.   <td id="projectalign">
    38. 

  38.    <div id="projectname">Jolt Physics
    39. 

  39.    </div>
    40. 

  40.    <div id="projectbrief">A multi core friendly Game Physics Engine</div>
    41. 

  41.   </td>
    42. 

  42.  </tr>
    43. 

  43.  </tbody>
    44. 

  44. </table>
    45. 

  45. </div>
    46. 

  46. <!-- end header part -->
    47. 

  47. <!-- Generated by Doxygen 1.12.0 -->
    48. 

  48. <script type="text/javascript">
    49. 

  49. /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
    50. 

  50. var searchBox = new SearchBox("searchBox", "search/",'.html');
    51. 

  51. /* @license-end */
    52. 

  52. </script>
    53. 

  53. <script type="text/javascript">
    54. 

  54. /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
    55. 

  55. $(function() { codefold.init(0); });
    56. 

  56. /* @license-end */
    57. 

  57. </script>
    58. 

  58. <script type="text/javascript" src="menudata.js"></script>
    59. 

  59. <script type="text/javascript" src="menu.js"></script>
    60. 

  60. <script type="text/javascript">
    61. 

  61. /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
    62. 

  62. $(function() {
    63. 

  63.   initMenu('',true,false,'search.php','Search',true);
    64. 

  64.   $(function() { init_search(); });
    65. 

  65. });
    66. 

  66. /* @license-end */
    67. 

  67. </script>
    68. 

  68. <div id="main-nav"></div>
    69. 

  69. </div><!-- top -->
    70. 

  70. <div id="side-nav" class="ui-resizable side-nav-resizable">
    71. 

  71.   <div id="nav-tree">
    72. 

  72.     <div id="nav-tree-contents">
    73. 

  73.       <div id="nav-sync" class="sync"></div>
    74. 

  74.     </div>
    75. 

  75.   </div>
    76. 

  76.   <div id="splitbar" style="-moz-user-select:none;" 
    77. 

  77.        class="ui-resizable-handle">
    78. 

  78.   </div>
    79. 

  79. </div>
    80. 

  80. <script type="text/javascript">
    81. 

  81. /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
    82. 

  82. $(function(){initNavTree('_collision_collector_8h_source.html',''); initResizable(true); });
    83. 

  83. /* @license-end */
    84. 

  84. </script>
    85. 

  85. <div id="doc-content">
    86. 

  86. <!-- window showing the filter options -->
    87. 

  87. <div id="MSearchSelectWindow"
    88. 

  88.      onmouseover="return searchBox.OnSearchSelectShow()"
    89. 

  89.      onmouseout="return searchBox.OnSearchSelectHide()"
    90. 

  90.      onkeydown="return searchBox.OnSearchSelectKey(event)">
    91. 

  91. </div>
    92. 

  92. 

  93. <!-- iframe showing the search results (closed by default) -->
    94. 

  94. <div id="MSearchResultsWindow">
    95. 

  95. <div id="MSearchResults">
    96. 

  96. <div class="SRPage">
    97. 

  97. <div id="SRIndex">
    98. 

  98. <div id="SRResults"></div>
    99. 

  99. <div class="SRStatus" id="Loading">Loading...</div>
    100. 

  100. <div class="SRStatus" id="Searching">Searching...</div>
    101. 

  101. <div class="SRStatus" id="NoMatches">No Matches</div>
    102. 

  102. </div>
    103. 

  103. </div>
    104. 

  104. </div>
    105. 

  105. </div>
    106. 

  106. 

  107. <div class="header">
    108. 

  108.   <div class="headertitle"><div class="title">CollisionCollector.h</div></div>
    109. 

  109. </div><!--header-->
    110. 

  110. <div class="contents">
    111. 

  111. <a href="_collision_collector_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno">    1</span><span class="comment">// Jolt Physics Library (https://github.com/jrouwe/JoltPhysics)</span></div>
    112. 

  112. <div class="line"><a id="l00002" name="l00002"></a><span class="lineno">    2</span><span class="comment">// SPDX-FileCopyrightText: 2021 Jorrit Rouwe</span></div>
    113. 

  113. <div class="line"><a id="l00003" name="l00003"></a><span class="lineno">    3</span><span class="comment">// SPDX-License-Identifier: MIT</span></div>
    114. 

  114. <div class="line"><a id="l00004" name="l00004"></a><span class="lineno">    4</span> </div>
    115. 

  115. <div class="line"><a id="l00005" name="l00005"></a><span class="lineno">    5</span><span class="preprocessor">#pragma once</span></div>
    116. 

  116. <div class="line"><a id="l00006" name="l00006"></a><span class="lineno">    6</span> </div>
    117. 

  117. <div class="line"><a id="l00007" name="l00007"></a><span class="lineno">    7</span><a class="code hl_define" href="_core_8h.html#ad14098b68b8c44ea6112601031268405">JPH_NAMESPACE_BEGIN</a></div>
    118. 

  118. <div class="line"><a id="l00008" name="l00008"></a><span class="lineno">    8</span> </div>
    119. 

  119. <div class="line"><a id="l00009" name="l00009"></a><span class="lineno">    9</span><span class="keyword">class </span><a class="code hl_class" href="class_body.html">Body</a>;</div>
    120. 

  120. <div class="line"><a id="l00010" name="l00010"></a><span class="lineno">   10</span><span class="keyword">class </span><a class="code hl_class" href="class_transformed_shape.html">TransformedShape</a>;</div>
    121. 

  121. <div class="line"><a id="l00011" name="l00011"></a><span class="lineno">   11</span> </div>
    122. 

  122. <div class="foldopen" id="foldopen00013" data-start="{" data-end="};">
    123. 

  123. <div class="line"><a id="l00013" name="l00013"></a><span class="lineno"><a class="line" href="class_collision_collector_traits_cast_ray.html">   13</a></span><span class="keyword">class </span><a class="code hl_class" href="class_collision_collector_traits_cast_ray.html">CollisionCollectorTraitsCastRay</a></div>
    124. 

  124. <div class="line"><a id="l00014" name="l00014"></a><span class="lineno">   14</span>{</div>
    125. 

  125. <div class="line"><a id="l00015" name="l00015"></a><span class="lineno">   15</span><span class="keyword">public</span>:</div>
    126. 

  126. <div class="line"><a id="l00017" name="l00017"></a><span class="lineno"><a class="line" href="class_collision_collector_traits_cast_ray.html#ad2a01c00dc5dc3fae86b1b2c08ddfae6">   17</a></span>    <span class="keyword">static</span> <span class="keyword">constexpr</span> <span class="keywordtype">float</span> <a class="code hl_variable" href="class_collision_collector_traits_cast_ray.html#ad2a01c00dc5dc3fae86b1b2c08ddfae6">InitialEarlyOutFraction</a> = 1.0f + FLT_EPSILON;    </div>
    127. 

  127. <div class="line"><a id="l00018" name="l00018"></a><span class="lineno"><a class="line" href="class_collision_collector_traits_cast_ray.html#afa6f91ce29ad08f2e10f02de6b6f88c8">   18</a></span>    <span class="keyword">static</span> <span class="keyword">constexpr</span> <span class="keywordtype">float</span> <a class="code hl_variable" href="class_collision_collector_traits_cast_ray.html#afa6f91ce29ad08f2e10f02de6b6f88c8">ShouldEarlyOutFraction</a> = 0.0f;                   </div>
    128. 

  128. <div class="line"><a id="l00019" name="l00019"></a><span class="lineno">   19</span>};</div>
    129. 

  129. </div>
    130. 

  130. <div class="line"><a id="l00020" name="l00020"></a><span class="lineno">   20</span> </div>
    131. 

  131. <div class="foldopen" id="foldopen00022" data-start="{" data-end="};">
    132. 

  132. <div class="line"><a id="l00022" name="l00022"></a><span class="lineno"><a class="line" href="class_collision_collector_traits_cast_shape.html">   22</a></span><span class="keyword">class </span><a class="code hl_class" href="class_collision_collector_traits_cast_shape.html">CollisionCollectorTraitsCastShape</a></div>
    133. 

  133. <div class="line"><a id="l00023" name="l00023"></a><span class="lineno">   23</span>{</div>
    134. 

  134. <div class="line"><a id="l00024" name="l00024"></a><span class="lineno">   24</span><span class="keyword">public</span>:</div>
    135. 

  135. <div class="line"><a id="l00026" name="l00026"></a><span class="lineno"><a class="line" href="class_collision_collector_traits_cast_shape.html#a05bb7735aee24a1dbb7da03e0b43323d">   26</a></span>    <span class="keyword">static</span> <span class="keyword">constexpr</span> <span class="keywordtype">float</span> <a class="code hl_variable" href="class_collision_collector_traits_cast_shape.html#a05bb7735aee24a1dbb7da03e0b43323d">InitialEarlyOutFraction</a> = 1.0f + FLT_EPSILON;    </div>
    136. 

  136. <div class="line"><a id="l00027" name="l00027"></a><span class="lineno"><a class="line" href="class_collision_collector_traits_cast_shape.html#a0e140c58d35f83e0992dd50e7f51bb20">   27</a></span>    <span class="keyword">static</span> <span class="keyword">constexpr</span> <span class="keywordtype">float</span> <a class="code hl_variable" href="class_collision_collector_traits_cast_shape.html#a0e140c58d35f83e0992dd50e7f51bb20">ShouldEarlyOutFraction</a> = -FLT_MAX;               </div>
    137. 

  137. <div class="line"><a id="l00028" name="l00028"></a><span class="lineno">   28</span>};</div>
    138. 

  138. </div>
    139. 

  139. <div class="line"><a id="l00029" name="l00029"></a><span class="lineno">   29</span> </div>
    140. 

  140. <div class="foldopen" id="foldopen00031" data-start="{" data-end="};">
    141. 

  141. <div class="line"><a id="l00031" name="l00031"></a><span class="lineno"><a class="line" href="class_collision_collector_traits_collide_shape.html">   31</a></span><span class="keyword">class </span><a class="code hl_class" href="class_collision_collector_traits_collide_shape.html">CollisionCollectorTraitsCollideShape</a></div>
    142. 

  142. <div class="line"><a id="l00032" name="l00032"></a><span class="lineno">   32</span>{</div>
    143. 

  143. <div class="line"><a id="l00033" name="l00033"></a><span class="lineno">   33</span><span class="keyword">public</span>:</div>
    144. 

  144. <div class="line"><a id="l00035" name="l00035"></a><span class="lineno"><a class="line" href="class_collision_collector_traits_collide_shape.html#ab3c91ac7a729d543b263c51194826488">   35</a></span>    <span class="keyword">static</span> <span class="keyword">constexpr</span> <span class="keywordtype">float</span> <a class="code hl_variable" href="class_collision_collector_traits_collide_shape.html#ab3c91ac7a729d543b263c51194826488">InitialEarlyOutFraction</a> = FLT_MAX;               </div>
    145. 

  145. <div class="line"><a id="l00036" name="l00036"></a><span class="lineno"><a class="line" href="class_collision_collector_traits_collide_shape.html#ae17bd05b85c1d2e11adcbd1dad050299">   36</a></span>    <span class="keyword">static</span> <span class="keyword">constexpr</span> <span class="keywordtype">float</span> <a class="code hl_variable" href="class_collision_collector_traits_collide_shape.html#ae17bd05b85c1d2e11adcbd1dad050299">ShouldEarlyOutFraction</a> = -FLT_MAX;               </div>
    146. 

  146. <div class="line"><a id="l00037" name="l00037"></a><span class="lineno">   37</span>};</div>
    147. 

  147. </div>
    148. 

  148. <div class="line"><a id="l00038" name="l00038"></a><span class="lineno">   38</span> </div>
    149. 

  149. <div class="line"><a id="l00040" name="l00040"></a><span class="lineno"><a class="line" href="_collision_collector_8h.html#a752023f1ea66323b2045dc2331831284">   40</a></span><span class="keyword">using </span><a class="code hl_class" href="class_collision_collector_traits_collide_shape.html">CollisionCollectorTraitsCollidePoint</a> = <a class="code hl_class" href="class_collision_collector_traits_collide_shape.html">CollisionCollectorTraitsCollideShape</a>;</div>
    150. 

  150. <div class="line"><a id="l00041" name="l00041"></a><span class="lineno">   41</span> </div>
    151. 

  151. <div class="line"><a id="l00043" name="l00043"></a><span class="lineno">   43</span><span class="keyword">template</span> &lt;<span class="keyword">class</span> ResultTypeArg, <span class="keyword">class</span> TraitsType&gt;</div>
    152. 

  152. <div class="foldopen" id="foldopen00044" data-start="{" data-end="};">
    153. 

  153. <div class="line"><a id="l00044" name="l00044"></a><span class="lineno"><a class="line" href="class_collision_collector.html">   44</a></span><span class="keyword">class </span><a class="code hl_class" href="class_collision_collector.html">CollisionCollector</a></div>
    154. 

  154. <div class="line"><a id="l00045" name="l00045"></a><span class="lineno">   45</span>{</div>
    155. 

  155. <div class="line"><a id="l00046" name="l00046"></a><span class="lineno">   46</span><span class="keyword">public</span>:</div>
    156. 

  156. <div class="line"><a id="l00048" name="l00048"></a><span class="lineno"><a class="line" href="class_collision_collector.html#aca5d333c728a1e1768694c8845d86783">   48</a></span>    <span class="keyword">using </span><a class="code hl_typedef" href="class_collision_collector.html#aca5d333c728a1e1768694c8845d86783">ResultType</a> = ResultTypeArg;</div>
    157. 

  157. <div class="line"><a id="l00049" name="l00049"></a><span class="lineno">   49</span> </div>
    158. 

  158. <div class="line"><a id="l00051" name="l00051"></a><span class="lineno"><a class="line" href="class_collision_collector.html#a1da599bacd865c579f31e64676e36206">   51</a></span>                            <a class="code hl_function" href="class_collision_collector.html#a1da599bacd865c579f31e64676e36206">CollisionCollector</a>() = <span class="keywordflow">default</span>;</div>
    159. 

  159. <div class="line"><a id="l00052" name="l00052"></a><span class="lineno">   52</span> </div>
    160. 

  160. <div class="line"><a id="l00054" name="l00054"></a><span class="lineno">   54</span>    <span class="keyword">template</span> &lt;<span class="keyword">class</span> ResultTypeArg2&gt;</div>
    161. 

  161. <div class="line"><a id="l00055" name="l00055"></a><span class="lineno"><a class="line" href="class_collision_collector.html#a7d7b02e890a7ea24b0030027ce4851f9">   55</a></span>    <span class="keyword">explicit</span>                <a class="code hl_function" href="class_collision_collector.html#a7d7b02e890a7ea24b0030027ce4851f9">CollisionCollector</a>(<span class="keyword">const</span> <a class="code hl_class" href="class_collision_collector.html">CollisionCollector&lt;ResultTypeArg2, TraitsType&gt;</a> &amp;inRHS) : mEarlyOutFraction(inRHS.<a class="code hl_function" href="class_collision_collector.html#ab972bb0e68e602c5eea898dfb7166d07">GetEarlyOutFraction</a>()), mContext(inRHS.<a class="code hl_function" href="class_collision_collector.html#ab9bfe5f6799afc12509d8dbad2c5b90b">GetContext</a>()) { }</div>
    162. 

  162. <div class="line"><a id="l00056" name="l00056"></a><span class="lineno"><a class="line" href="class_collision_collector.html#a9ece66bb7cac504d660f412ded03e024">   56</a></span>                            <a class="code hl_function" href="class_collision_collector.html#a9ece66bb7cac504d660f412ded03e024">CollisionCollector</a>(<span class="keyword">const</span> <a class="code hl_class" href="class_collision_collector.html">CollisionCollector&lt;ResultTypeArg, TraitsType&gt;</a> &amp;inRHS) = <span class="keywordflow">default</span>;</div>
    163. 

  163. <div class="line"><a id="l00057" name="l00057"></a><span class="lineno">   57</span> </div>
    164. 

  164. <div class="line"><a id="l00059" name="l00059"></a><span class="lineno"><a class="line" href="class_collision_collector.html#a428497d94c0d54c4fb4e7ce6a016fc0d">   59</a></span>    <span class="keyword">virtual</span>                 <a class="code hl_function" href="class_collision_collector.html#a428497d94c0d54c4fb4e7ce6a016fc0d">~CollisionCollector</a>() = <span class="keywordflow">default</span>;</div>
    165. 

  165. <div class="line"><a id="l00060" name="l00060"></a><span class="lineno">   60</span> </div>
    166. 

  166. <div class="line"><a id="l00062" name="l00062"></a><span class="lineno"><a class="line" href="class_collision_collector.html#a77f6668a80319dfb85f68b97c7b6d103">   62</a></span>    <span class="keyword">virtual</span> <span class="keywordtype">void</span>            <a class="code hl_function" href="class_collision_collector.html#a77f6668a80319dfb85f68b97c7b6d103">Reset</a>()                                         { mEarlyOutFraction = TraitsType::InitialEarlyOutFraction; }</div>
    167. 

  167. <div class="line"><a id="l00063" name="l00063"></a><span class="lineno">   63</span> </div>
    168. 

  168. <div class="line"><a id="l00067" name="l00067"></a><span class="lineno"><a class="line" href="class_collision_collector.html#ac2986bb5d0b4f6147d2507571ee3a014">   67</a></span>    <span class="keyword">virtual</span> <span class="keywordtype">void</span>            <a class="code hl_function" href="class_collision_collector.html#ac2986bb5d0b4f6147d2507571ee3a014">OnBody</a>([[maybe_unused]] <span class="keyword">const</span> <a class="code hl_class" href="class_body.html">Body</a> &amp;inBody)     { <span class="comment">/* Collects nothing by default */</span> }</div>
    169. 

  169. <div class="line"><a id="l00068" name="l00068"></a><span class="lineno">   68</span> </div>
    170. 

  170. <div class="line"><a id="l00070" name="l00070"></a><span class="lineno"><a class="line" href="class_collision_collector.html#ae5d038bd6a96af9c55fb49623fbd31ba">   70</a></span>    <span class="keyword">virtual</span> <span class="keywordtype">void</span>            <a class="code hl_function" href="class_collision_collector.html#ae5d038bd6a96af9c55fb49623fbd31ba">OnBodyEnd</a>()                                     { <span class="comment">/* Does nothing by default */</span> }</div>
    171. 

  171. <div class="line"><a id="l00071" name="l00071"></a><span class="lineno">   71</span> </div>
    172. 

  172. <div class="line"><a id="l00074" name="l00074"></a><span class="lineno"><a class="line" href="class_collision_collector.html#ada5357990f959132a05d4d4d21f8c7b3">   74</a></span>    <span class="keywordtype">void</span>                    <a class="code hl_function" href="class_collision_collector.html#ada5357990f959132a05d4d4d21f8c7b3">SetContext</a>(<span class="keyword">const</span> <a class="code hl_class" href="class_transformed_shape.html">TransformedShape</a> *inContext)   { mContext = inContext; }</div>
    173. 

  173. <div class="line"><a id="l00075" name="l00075"></a><span class="lineno"><a class="line" href="class_collision_collector.html#ab9bfe5f6799afc12509d8dbad2c5b90b">   75</a></span>    <span class="keyword">const</span> <a class="code hl_class" href="class_transformed_shape.html">TransformedShape</a> *<a class="code hl_function" href="class_collision_collector.html#ab9bfe5f6799afc12509d8dbad2c5b90b">GetContext</a>()<span class="keyword"> const                              </span>{ <span class="keywordflow">return</span> mContext; }</div>
    174. 

  174. <div class="line"><a id="l00076" name="l00076"></a><span class="lineno">   76</span> </div>
    175. 

  175. <div class="line"><a id="l00078" name="l00078"></a><span class="lineno"><a class="line" href="class_collision_collector.html#aefb07c8a9dd625efefeb0f37ee2957d6">   78</a></span>    <span class="keyword">virtual</span> <span class="keywordtype">void</span>            <a class="code hl_function" href="class_collision_collector.html#aefb07c8a9dd625efefeb0f37ee2957d6">SetUserData</a>(<a class="code hl_typedef" href="_core_8h.html#a60e8696a4678cd348e991a1f172e53f7">uint64</a> inUserData)                  { <span class="comment">/* Does nothing by default */</span> }</div>
    176. 

  176. <div class="line"><a id="l00079" name="l00079"></a><span class="lineno">   79</span> </div>
    177. 

  177. <div class="line"><a id="l00081" name="l00081"></a><span class="lineno"><a class="line" href="class_collision_collector.html#a762c35402676662897e50dd8224e496e">   81</a></span>    <span class="keyword">virtual</span> <span class="keywordtype">void</span>            <a class="code hl_function" href="class_collision_collector.html#a762c35402676662897e50dd8224e496e">AddHit</a>(<span class="keyword">const</span> <a class="code hl_typedef" href="class_collision_collector.html#aca5d333c728a1e1768694c8845d86783">ResultType</a> &amp;inResult) = 0;</div>
    178. 

  178. <div class="line"><a id="l00082" name="l00082"></a><span class="lineno">   82</span> </div>
    179. 

  179. <div class="line"><a id="l00084" name="l00084"></a><span class="lineno"><a class="line" href="class_collision_collector.html#ac46233c07f2d69db516879fbbcef8be1">   84</a></span>    <span class="keyword">inline</span> <span class="keywordtype">void</span>             <a class="code hl_function" href="class_collision_collector.html#ac46233c07f2d69db516879fbbcef8be1">UpdateEarlyOutFraction</a>(<span class="keywordtype">float</span> inFraction)        { <a class="code hl_define" href="_issue_reporting_8h.html#aaf6b1df827e11b7ca5f6f8778bd8f8cd">JPH_ASSERT</a>(inFraction &lt;= mEarlyOutFraction); mEarlyOutFraction = inFraction; }</div>
    180. 

  180. <div class="line"><a id="l00085" name="l00085"></a><span class="lineno">   85</span> </div>
    181. 

  181. <div class="line"><a id="l00087" name="l00087"></a><span class="lineno"><a class="line" href="class_collision_collector.html#a07e4d9859fe39cfde6674ebb3ece445a">   87</a></span>    <span class="keyword">inline</span> <span class="keywordtype">void</span>             <a class="code hl_function" href="class_collision_collector.html#a07e4d9859fe39cfde6674ebb3ece445a">ResetEarlyOutFraction</a>(<span class="keywordtype">float</span> inFraction = TraitsType::InitialEarlyOutFraction) { mEarlyOutFraction = inFraction; }</div>
    182. 

  182. <div class="line"><a id="l00088" name="l00088"></a><span class="lineno">   88</span> </div>
    183. 

  183. <div class="line"><a id="l00090" name="l00090"></a><span class="lineno"><a class="line" href="class_collision_collector.html#a04a9260170d7c96389b50c6f6843c8b5">   90</a></span>    <span class="keyword">inline</span> <span class="keywordtype">void</span>             <a class="code hl_function" href="class_collision_collector.html#a04a9260170d7c96389b50c6f6843c8b5">ForceEarlyOut</a>()                                 { mEarlyOutFraction = TraitsType::ShouldEarlyOutFraction; }</div>
    184. 

  184. <div class="line"><a id="l00091" name="l00091"></a><span class="lineno">   91</span> </div>
    185. 

  185. <div class="line"><a id="l00093" name="l00093"></a><span class="lineno"><a class="line" href="class_collision_collector.html#a45cb1cfbb5ec957d3c66b65d2333d825">   93</a></span>    <span class="keyword">inline</span> <span class="keywordtype">bool</span>             <a class="code hl_function" href="class_collision_collector.html#a45cb1cfbb5ec957d3c66b65d2333d825">ShouldEarlyOut</a>()<span class="keyword"> const                          </span>{ <span class="keywordflow">return</span> mEarlyOutFraction &lt;= TraitsType::ShouldEarlyOutFraction; }</div>
    186. 

  186. <div class="line"><a id="l00094" name="l00094"></a><span class="lineno">   94</span> </div>
    187. 

  187. <div class="line"><a id="l00096" name="l00096"></a><span class="lineno"><a class="line" href="class_collision_collector.html#ab972bb0e68e602c5eea898dfb7166d07">   96</a></span>    <span class="keyword">inline</span> <span class="keywordtype">float</span>            <a class="code hl_function" href="class_collision_collector.html#ab972bb0e68e602c5eea898dfb7166d07">GetEarlyOutFraction</a>()<span class="keyword"> const                     </span>{ <span class="keywordflow">return</span> mEarlyOutFraction; }</div>
    188. 

  188. <div class="line"><a id="l00097" name="l00097"></a><span class="lineno">   97</span> </div>
    189. 

  189. <div class="line"><a id="l00099" name="l00099"></a><span class="lineno"><a class="line" href="class_collision_collector.html#aeb1fb262127298ec8bc296ead30a2e77">   99</a></span>    <span class="keyword">inline</span> <span class="keywordtype">float</span>            <a class="code hl_function" href="class_collision_collector.html#aeb1fb262127298ec8bc296ead30a2e77">GetPositiveEarlyOutFraction</a>()<span class="keyword"> const             </span>{ <span class="keywordflow">return</span> max(FLT_MIN, mEarlyOutFraction); }</div>
    190. 

  190. <div class="line"><a id="l00100" name="l00100"></a><span class="lineno">  100</span> </div>
    191. 

  191. <div class="line"><a id="l00101" name="l00101"></a><span class="lineno">  101</span><span class="keyword">private</span>:</div>
    192. 

  192. <div class="line"><a id="l00103" name="l00103"></a><span class="lineno">  103</span>    <span class="keywordtype">float</span>                   mEarlyOutFraction = TraitsType::InitialEarlyOutFraction;</div>
    193. 

  193. <div class="line"><a id="l00104" name="l00104"></a><span class="lineno">  104</span> </div>
    194. 

  194. <div class="line"><a id="l00106" name="l00106"></a><span class="lineno">  106</span>    <span class="keyword">const</span> <a class="code hl_class" href="class_transformed_shape.html">TransformedShape</a> *mContext = <span class="keyword">nullptr</span>;</div>
    195. 

  195. <div class="line"><a id="l00107" name="l00107"></a><span class="lineno">  107</span>};</div>
    196. 

  196. </div>
    197. 

  197. <div class="line"><a id="l00108" name="l00108"></a><span class="lineno">  108</span> </div>
    198. 

  198. <div class="line"><a id="l00109" name="l00109"></a><span class="lineno">  109</span><a class="code hl_define" href="_core_8h.html#a73da8725998b00321a9db341202d650d">JPH_NAMESPACE_END</a></div>
    199. 

  199. <div class="ttc" id="a_core_8h_html_a60e8696a4678cd348e991a1f172e53f7"><div class="ttname"><a href="_core_8h.html#a60e8696a4678cd348e991a1f172e53f7">uint64</a></div><div class="ttdeci">std::uint64_t uint64</div><div class="ttdef"><b>Definition</b> Core.h:504</div></div>
    200. 

  200. <div class="ttc" id="a_core_8h_html_a73da8725998b00321a9db341202d650d"><div class="ttname"><a href="_core_8h.html#a73da8725998b00321a9db341202d650d">JPH_NAMESPACE_END</a></div><div class="ttdeci">#define JPH_NAMESPACE_END</div><div class="ttdef"><b>Definition</b> Core.h:425</div></div>
    201. 

  201. <div class="ttc" id="a_core_8h_html_ad14098b68b8c44ea6112601031268405"><div class="ttname"><a href="_core_8h.html#ad14098b68b8c44ea6112601031268405">JPH_NAMESPACE_BEGIN</a></div><div class="ttdeci">#define JPH_NAMESPACE_BEGIN</div><div class="ttdef"><b>Definition</b> Core.h:419</div></div>
    202. 

  202. <div class="ttc" id="a_issue_reporting_8h_html_aaf6b1df827e11b7ca5f6f8778bd8f8cd"><div class="ttname"><a href="_issue_reporting_8h.html#aaf6b1df827e11b7ca5f6f8778bd8f8cd">JPH_ASSERT</a></div><div class="ttdeci">#define JPH_ASSERT(...)</div><div class="ttdef"><b>Definition</b> IssueReporting.h:33</div></div>
    203. 

  203. <div class="ttc" id="aclass_body_html"><div class="ttname"><a href="class_body.html">Body</a></div><div class="ttdef"><b>Definition</b> Body.h:39</div></div>
    204. 

  204. <div class="ttc" id="aclass_collision_collector_html"><div class="ttname"><a href="class_collision_collector.html">CollisionCollector</a></div><div class="ttdoc">Virtual interface that allows collecting multiple collision results.</div><div class="ttdef"><b>Definition</b> CollisionCollector.h:45</div></div>
    205. 

  205. <div class="ttc" id="aclass_collision_collector_html_a04a9260170d7c96389b50c6f6843c8b5"><div class="ttname"><a href="class_collision_collector.html#a04a9260170d7c96389b50c6f6843c8b5">CollisionCollector::ForceEarlyOut</a></div><div class="ttdeci">void ForceEarlyOut()</div><div class="ttdoc">Force the collision detection algorithm to terminate as soon as possible. Call this from the AddHit f...</div><div class="ttdef"><b>Definition</b> CollisionCollector.h:90</div></div>
    206. 

  206. <div class="ttc" id="aclass_collision_collector_html_a07e4d9859fe39cfde6674ebb3ece445a"><div class="ttname"><a href="class_collision_collector.html#a07e4d9859fe39cfde6674ebb3ece445a">CollisionCollector::ResetEarlyOutFraction</a></div><div class="ttdeci">void ResetEarlyOutFraction(float inFraction=TraitsType::InitialEarlyOutFraction)</div><div class="ttdoc">Reset the early out fraction to a specific value.</div><div class="ttdef"><b>Definition</b> CollisionCollector.h:87</div></div>
    207. 

  207. <div class="ttc" id="aclass_collision_collector_html_a1da599bacd865c579f31e64676e36206"><div class="ttname"><a href="class_collision_collector.html#a1da599bacd865c579f31e64676e36206">CollisionCollector::CollisionCollector</a></div><div class="ttdeci">CollisionCollector()=default</div><div class="ttdoc">Default constructor.</div></div>
    208. 

  208. <div class="ttc" id="aclass_collision_collector_html_a428497d94c0d54c4fb4e7ce6a016fc0d"><div class="ttname"><a href="class_collision_collector.html#a428497d94c0d54c4fb4e7ce6a016fc0d">CollisionCollector::~CollisionCollector</a></div><div class="ttdeci">virtual ~CollisionCollector()=default</div><div class="ttdoc">Destructor.</div></div>
    209. 

  209. <div class="ttc" id="aclass_collision_collector_html_a45cb1cfbb5ec957d3c66b65d2333d825"><div class="ttname"><a href="class_collision_collector.html#a45cb1cfbb5ec957d3c66b65d2333d825">CollisionCollector::ShouldEarlyOut</a></div><div class="ttdeci">bool ShouldEarlyOut() const</div><div class="ttdoc">When true, the collector will no longer accept any additional hits and the collision detection routin...</div><div class="ttdef"><b>Definition</b> CollisionCollector.h:93</div></div>
    210. 

  210. <div class="ttc" id="aclass_collision_collector_html_a762c35402676662897e50dd8224e496e"><div class="ttname"><a href="class_collision_collector.html#a762c35402676662897e50dd8224e496e">CollisionCollector::AddHit</a></div><div class="ttdeci">virtual void AddHit(const ResultType &amp;inResult)=0</div><div class="ttdoc">This function will be called for every hit found, it's up to the application to decide how to store t...</div></div>
    211. 

  211. <div class="ttc" id="aclass_collision_collector_html_a77f6668a80319dfb85f68b97c7b6d103"><div class="ttname"><a href="class_collision_collector.html#a77f6668a80319dfb85f68b97c7b6d103">CollisionCollector::Reset</a></div><div class="ttdeci">virtual void Reset()</div><div class="ttdoc">If you want to reuse this collector, call Reset()</div><div class="ttdef"><b>Definition</b> CollisionCollector.h:62</div></div>
    212. 

  212. <div class="ttc" id="aclass_collision_collector_html_a7d7b02e890a7ea24b0030027ce4851f9"><div class="ttname"><a href="class_collision_collector.html#a7d7b02e890a7ea24b0030027ce4851f9">CollisionCollector::CollisionCollector</a></div><div class="ttdeci">CollisionCollector(const CollisionCollector&lt; ResultTypeArg2, TraitsType &gt; &amp;inRHS)</div><div class="ttdoc">Constructor to initialize from another collector.</div><div class="ttdef"><b>Definition</b> CollisionCollector.h:55</div></div>
    213. 

  213. <div class="ttc" id="aclass_collision_collector_html_a9ece66bb7cac504d660f412ded03e024"><div class="ttname"><a href="class_collision_collector.html#a9ece66bb7cac504d660f412ded03e024">CollisionCollector::CollisionCollector</a></div><div class="ttdeci">CollisionCollector(const CollisionCollector&lt; ResultTypeArg, TraitsType &gt; &amp;inRHS)=default</div></div>
    214. 

  214. <div class="ttc" id="aclass_collision_collector_html_ab972bb0e68e602c5eea898dfb7166d07"><div class="ttname"><a href="class_collision_collector.html#ab972bb0e68e602c5eea898dfb7166d07">CollisionCollector::GetEarlyOutFraction</a></div><div class="ttdeci">float GetEarlyOutFraction() const</div><div class="ttdoc">Get the current early out value.</div><div class="ttdef"><b>Definition</b> CollisionCollector.h:96</div></div>
    215. 

  215. <div class="ttc" id="aclass_collision_collector_html_ab9bfe5f6799afc12509d8dbad2c5b90b"><div class="ttname"><a href="class_collision_collector.html#ab9bfe5f6799afc12509d8dbad2c5b90b">CollisionCollector::GetContext</a></div><div class="ttdeci">const TransformedShape * GetContext() const</div><div class="ttdef"><b>Definition</b> CollisionCollector.h:75</div></div>
    216. 

  216. <div class="ttc" id="aclass_collision_collector_html_ac2986bb5d0b4f6147d2507571ee3a014"><div class="ttname"><a href="class_collision_collector.html#ac2986bb5d0b4f6147d2507571ee3a014">CollisionCollector::OnBody</a></div><div class="ttdeci">virtual void OnBody(const Body &amp;inBody)</div><div class="ttdef"><b>Definition</b> CollisionCollector.h:67</div></div>
    217. 

  217. <div class="ttc" id="aclass_collision_collector_html_ac46233c07f2d69db516879fbbcef8be1"><div class="ttname"><a href="class_collision_collector.html#ac46233c07f2d69db516879fbbcef8be1">CollisionCollector::UpdateEarlyOutFraction</a></div><div class="ttdeci">void UpdateEarlyOutFraction(float inFraction)</div><div class="ttdoc">Update the early out fraction (should be lower than before)</div><div class="ttdef"><b>Definition</b> CollisionCollector.h:84</div></div>
    218. 

  218. <div class="ttc" id="aclass_collision_collector_html_aca5d333c728a1e1768694c8845d86783"><div class="ttname"><a href="class_collision_collector.html#aca5d333c728a1e1768694c8845d86783">CollisionCollector::ResultType</a></div><div class="ttdeci">ResultTypeArg ResultType</div><div class="ttdoc">Declare ResultType so that derived classes can use it.</div><div class="ttdef"><b>Definition</b> CollisionCollector.h:48</div></div>
    219. 

  219. <div class="ttc" id="aclass_collision_collector_html_ada5357990f959132a05d4d4d21f8c7b3"><div class="ttname"><a href="class_collision_collector.html#ada5357990f959132a05d4d4d21f8c7b3">CollisionCollector::SetContext</a></div><div class="ttdeci">void SetContext(const TransformedShape *inContext)</div><div class="ttdef"><b>Definition</b> CollisionCollector.h:74</div></div>
    220. 

  220. <div class="ttc" id="aclass_collision_collector_html_ae5d038bd6a96af9c55fb49623fbd31ba"><div class="ttname"><a href="class_collision_collector.html#ae5d038bd6a96af9c55fb49623fbd31ba">CollisionCollector::OnBodyEnd</a></div><div class="ttdeci">virtual void OnBodyEnd()</div><div class="ttdoc">When running a query through the NarrowPhaseQuery class, this will be called after all AddHit calls h...</div><div class="ttdef"><b>Definition</b> CollisionCollector.h:70</div></div>
    221. 

  221. <div class="ttc" id="aclass_collision_collector_html_aeb1fb262127298ec8bc296ead30a2e77"><div class="ttname"><a href="class_collision_collector.html#aeb1fb262127298ec8bc296ead30a2e77">CollisionCollector::GetPositiveEarlyOutFraction</a></div><div class="ttdeci">float GetPositiveEarlyOutFraction() const</div><div class="ttdoc">Get the current early out value but make sure it's bigger than zero, this is used for shape casting a...</div><div class="ttdef"><b>Definition</b> CollisionCollector.h:99</div></div>
    222. 

  222. <div class="ttc" id="aclass_collision_collector_html_aefb07c8a9dd625efefeb0f37ee2957d6"><div class="ttname"><a href="class_collision_collector.html#aefb07c8a9dd625efefeb0f37ee2957d6">CollisionCollector::SetUserData</a></div><div class="ttdeci">virtual void SetUserData(uint64 inUserData)</div><div class="ttdoc">This function can be used to set some user data on the collision collector.</div><div class="ttdef"><b>Definition</b> CollisionCollector.h:78</div></div>
    223. 

  223. <div class="ttc" id="aclass_collision_collector_traits_cast_ray_html"><div class="ttname"><a href="class_collision_collector_traits_cast_ray.html">CollisionCollectorTraitsCastRay</a></div><div class="ttdoc">Traits to use for CastRay.</div><div class="ttdef"><b>Definition</b> CollisionCollector.h:14</div></div>
    224. 

  224. <div class="ttc" id="aclass_collision_collector_traits_cast_ray_html_ad2a01c00dc5dc3fae86b1b2c08ddfae6"><div class="ttname"><a href="class_collision_collector_traits_cast_ray.html#ad2a01c00dc5dc3fae86b1b2c08ddfae6">CollisionCollectorTraitsCastRay::InitialEarlyOutFraction</a></div><div class="ttdeci">static constexpr float InitialEarlyOutFraction</div><div class="ttdoc">For rays the early out fraction is the fraction along the line to order hits.</div><div class="ttdef"><b>Definition</b> CollisionCollector.h:17</div></div>
    225. 

  225. <div class="ttc" id="aclass_collision_collector_traits_cast_ray_html_afa6f91ce29ad08f2e10f02de6b6f88c8"><div class="ttname"><a href="class_collision_collector_traits_cast_ray.html#afa6f91ce29ad08f2e10f02de6b6f88c8">CollisionCollectorTraitsCastRay::ShouldEarlyOutFraction</a></div><div class="ttdeci">static constexpr float ShouldEarlyOutFraction</div><div class="ttdoc">Closest hit: Fraction is 0.</div><div class="ttdef"><b>Definition</b> CollisionCollector.h:18</div></div>
    226. 

  226. <div class="ttc" id="aclass_collision_collector_traits_cast_shape_html"><div class="ttname"><a href="class_collision_collector_traits_cast_shape.html">CollisionCollectorTraitsCastShape</a></div><div class="ttdoc">Traits to use for CastShape.</div><div class="ttdef"><b>Definition</b> CollisionCollector.h:23</div></div>
    227. 

  227. <div class="ttc" id="aclass_collision_collector_traits_cast_shape_html_a05bb7735aee24a1dbb7da03e0b43323d"><div class="ttname"><a href="class_collision_collector_traits_cast_shape.html#a05bb7735aee24a1dbb7da03e0b43323d">CollisionCollectorTraitsCastShape::InitialEarlyOutFraction</a></div><div class="ttdeci">static constexpr float InitialEarlyOutFraction</div><div class="ttdoc">For rays the early out fraction is the fraction along the line to order hits.</div><div class="ttdef"><b>Definition</b> CollisionCollector.h:26</div></div>
    228. 

  228. <div class="ttc" id="aclass_collision_collector_traits_cast_shape_html_a0e140c58d35f83e0992dd50e7f51bb20"><div class="ttname"><a href="class_collision_collector_traits_cast_shape.html#a0e140c58d35f83e0992dd50e7f51bb20">CollisionCollectorTraitsCastShape::ShouldEarlyOutFraction</a></div><div class="ttdeci">static constexpr float ShouldEarlyOutFraction</div><div class="ttdoc">Deepest hit: Penetration is infinite.</div><div class="ttdef"><b>Definition</b> CollisionCollector.h:27</div></div>
    229. 

  229. <div class="ttc" id="aclass_collision_collector_traits_collide_shape_html"><div class="ttname"><a href="class_collision_collector_traits_collide_shape.html">CollisionCollectorTraitsCollideShape</a></div><div class="ttdoc">Traits to use for CollideShape.</div><div class="ttdef"><b>Definition</b> CollisionCollector.h:32</div></div>
    230. 

  230. <div class="ttc" id="aclass_collision_collector_traits_collide_shape_html_ab3c91ac7a729d543b263c51194826488"><div class="ttname"><a href="class_collision_collector_traits_collide_shape.html#ab3c91ac7a729d543b263c51194826488">CollisionCollectorTraitsCollideShape::InitialEarlyOutFraction</a></div><div class="ttdeci">static constexpr float InitialEarlyOutFraction</div><div class="ttdoc">For shape collisions we use -penetration depth to order hits.</div><div class="ttdef"><b>Definition</b> CollisionCollector.h:35</div></div>
    231. 

  231. <div class="ttc" id="aclass_collision_collector_traits_collide_shape_html_ae17bd05b85c1d2e11adcbd1dad050299"><div class="ttname"><a href="class_collision_collector_traits_collide_shape.html#ae17bd05b85c1d2e11adcbd1dad050299">CollisionCollectorTraitsCollideShape::ShouldEarlyOutFraction</a></div><div class="ttdeci">static constexpr float ShouldEarlyOutFraction</div><div class="ttdoc">Deepest hit: Penetration is infinite.</div><div class="ttdef"><b>Definition</b> CollisionCollector.h:36</div></div>
    232. 

  232. <div class="ttc" id="aclass_transformed_shape_html"><div class="ttname"><a href="class_transformed_shape.html">TransformedShape</a></div><div class="ttdef"><b>Definition</b> TransformedShape.h:26</div></div>
    233. 

  233. </div><!-- fragment --></div><!-- contents -->
    234. 

  234. </div><!-- doc-content -->
    235. 

  235. <!-- start footer part -->
    236. 

  236. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
    237. 

  237.   <ul>
    238. 

  238.     <li class="navelem"><a class="el" href="dir_d99289a5d3c46cf26f14ff6c90658d9f.html">Jolt</a></li><li class="navelem"><a class="el" href="dir_a0f33af92addde396fc27b064c5eb8a9.html">Physics</a></li><li class="navelem"><a class="el" href="dir_1a1d05ab9ff27ca8d1ed94cd62670cdf.html">Collision</a></li><li class="navelem"><a class="el" href="_collision_collector_8h.html">CollisionCollector.h</a></li>
    239. 

  239.     <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>
    240. 

  240.   </ul>
    241. 

  241. </div>
    242. 

  242. </body>
    243. 

  243. </html>
    244.