class_collide_point_result.html 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212
  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: CollidePointResult 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_collide_point_result.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="#pub-attribs">Public Attributes</a> &#124;
  109. <a href="class_collide_point_result-members.html">List of all members</a> </div>
  110. <div class="headertitle"><div class="title">CollidePointResult Class Reference</div></div>
  111. </div><!--header-->
  112. <div class="contents">
  113. <p>Structure that holds the result of colliding a point against a shape.
  114. <a href="#details">More...</a></p>
  115. <p><code>#include &lt;<a class="el" href="_collide_point_result_8h_source.html">CollidePointResult.h</a>&gt;</code></p>
  116. <table class="memberdecls">
  117. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
  118. Public Member Functions</h2></td></tr>
  119. <tr class="memitem:a2fe473a4baa681ab11ce3a291d8a26a8" id="r_a2fe473a4baa681ab11ce3a291d8a26a8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_memory_8h.html#a91074fb218fe28954a0938c099ddd9e0">JPH_OVERRIDE_NEW_DELETE</a> float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a2fe473a4baa681ab11ce3a291d8a26a8">GetEarlyOutFraction</a> () const</td></tr>
  120. <tr class="memdesc:a2fe473a4baa681ab11ce3a291d8a26a8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Function required by the <a class="el" href="class_collision_collector.html" title="Virtual interface that allows collecting multiple collision results.">CollisionCollector</a>. A smaller fraction is considered to be a 'better hit'. For point queries there is no sensible return value. <br /></td></tr>
  121. <tr class="separator:a2fe473a4baa681ab11ce3a291d8a26a8"><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-attribs" name="pub-attribs"></a>
  124. Public Attributes</h2></td></tr>
  125. <tr class="memitem:af82d1a1ce22fddff9c57c5970b6f4de3" id="r_af82d1a1ce22fddff9c57c5970b6f4de3"><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="#af82d1a1ce22fddff9c57c5970b6f4de3">mBodyID</a></td></tr>
  126. <tr class="memdesc:af82d1a1ce22fddff9c57c5970b6f4de3"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="class_body.html">Body</a> that was hit. <br /></td></tr>
  127. <tr class="separator:af82d1a1ce22fddff9c57c5970b6f4de3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  128. <tr class="memitem:afb9f97847ff73066b54793e15ebb2aa8" id="r_afb9f97847ff73066b54793e15ebb2aa8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_sub_shape_i_d.html">SubShapeID</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#afb9f97847ff73066b54793e15ebb2aa8">mSubShapeID2</a></td></tr>
  129. <tr class="memdesc:afb9f97847ff73066b54793e15ebb2aa8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sub shape ID of shape that we collided against. <br /></td></tr>
  130. <tr class="separator:afb9f97847ff73066b54793e15ebb2aa8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  131. </table>
  132. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  133. <div class="textblock"><p>Structure that holds the result of colliding a point against a shape. </p>
  134. </div><h2 class="groupheader">Member Function Documentation</h2>
  135. <a id="a2fe473a4baa681ab11ce3a291d8a26a8" name="a2fe473a4baa681ab11ce3a291d8a26a8"></a>
  136. <h2 class="memtitle"><span class="permalink"><a href="#a2fe473a4baa681ab11ce3a291d8a26a8">&#9670;&#160;</a></span>GetEarlyOutFraction()</h2>
  137. <div class="memitem">
  138. <div class="memproto">
  139. <table class="mlabels">
  140. <tr>
  141. <td class="mlabels-left">
  142. <table class="memname">
  143. <tr>
  144. <td class="memname"><a class="el" href="_memory_8h.html#a91074fb218fe28954a0938c099ddd9e0">JPH_OVERRIDE_NEW_DELETE</a> float CollidePointResult::GetEarlyOutFraction </td>
  145. <td>(</td>
  146. <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  147. <td> const</td>
  148. </tr>
  149. </table>
  150. </td>
  151. <td class="mlabels-right">
  152. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  153. </tr>
  154. </table>
  155. </div><div class="memdoc">
  156. <p>Function required by the <a class="el" href="class_collision_collector.html" title="Virtual interface that allows collecting multiple collision results.">CollisionCollector</a>. A smaller fraction is considered to be a 'better hit'. For point queries there is no sensible return value. </p>
  157. </div>
  158. </div>
  159. <h2 class="groupheader">Member Data Documentation</h2>
  160. <a id="af82d1a1ce22fddff9c57c5970b6f4de3" name="af82d1a1ce22fddff9c57c5970b6f4de3"></a>
  161. <h2 class="memtitle"><span class="permalink"><a href="#af82d1a1ce22fddff9c57c5970b6f4de3">&#9670;&#160;</a></span>mBodyID</h2>
  162. <div class="memitem">
  163. <div class="memproto">
  164. <table class="memname">
  165. <tr>
  166. <td class="memname"><a class="el" href="class_body_i_d.html">BodyID</a> CollidePointResult::mBodyID</td>
  167. </tr>
  168. </table>
  169. </div><div class="memdoc">
  170. <p><a class="el" href="class_body.html">Body</a> that was hit. </p>
  171. </div>
  172. </div>
  173. <a id="afb9f97847ff73066b54793e15ebb2aa8" name="afb9f97847ff73066b54793e15ebb2aa8"></a>
  174. <h2 class="memtitle"><span class="permalink"><a href="#afb9f97847ff73066b54793e15ebb2aa8">&#9670;&#160;</a></span>mSubShapeID2</h2>
  175. <div class="memitem">
  176. <div class="memproto">
  177. <table class="memname">
  178. <tr>
  179. <td class="memname"><a class="el" href="class_sub_shape_i_d.html">SubShapeID</a> CollidePointResult::mSubShapeID2</td>
  180. </tr>
  181. </table>
  182. </div><div class="memdoc">
  183. <p>Sub shape ID of shape that we collided against. </p>
  184. </div>
  185. </div>
  186. <hr/>The documentation for this class was generated from the following file:<ul>
  187. <li>Jolt/Physics/Collision/<a class="el" href="_collide_point_result_8h_source.html">CollidePointResult.h</a></li>
  188. </ul>
  189. </div><!-- contents -->
  190. </div><!-- doc-content -->
  191. <!-- start footer part -->
  192. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  193. <ul>
  194. <li class="navelem"><a class="el" href="class_collide_point_result.html">CollidePointResult</a></li>
  195. <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>
  196. </ul>
  197. </div>
  198. </body>
  199. </html>