_manifold_between_two_faces_8h.html 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246
  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: Jolt/Physics/Collision/ManifoldBetweenTwoFaces.h File 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('_manifold_between_two_faces_8h.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="#func-members">Functions</a> </div>
  108. <div class="headertitle"><div class="title">ManifoldBetweenTwoFaces.h File Reference</div></div>
  109. </div><!--header-->
  110. <div class="contents">
  111. <div class="textblock"><code>#include &lt;<a class="el" href="_convex_shape_8h_source.html">Jolt/Physics/Collision/Shape/ConvexShape.h</a>&gt;</code><br />
  112. <code>#include &lt;<a class="el" href="_contact_listener_8h_source.html">Jolt/Physics/Collision/ContactListener.h</a>&gt;</code><br />
  113. </div>
  114. <p><a href="_manifold_between_two_faces_8h_source.html">Go to the source code of this file.</a></p>
  115. <table class="memberdecls">
  116. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
  117. Functions</h2></td></tr>
  118. <tr class="memitem:a75e0a7ac1c7d9a4e410265839934c8e9" id="r_a75e0a7ac1c7d9a4e410265839934c8e9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_core_8h.html#ad14098b68b8c44ea6112601031268405">JPH_NAMESPACE_BEGIN</a> <a class="el" href="_core_8h.html#a2712a9b0f778ab9d1aa5118b4e8e6bd8">JPH_EXPORT</a> void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a75e0a7ac1c7d9a4e410265839934c8e9">PruneContactPoints</a> (<a class="el" href="_math_types_8h.html#a6bc57c31f15cea47640b580d03737c68">Vec3Arg</a> inPenetrationAxis, <a class="el" href="_contact_listener_8h.html#ac6f5f34116f161cc13203803010c37c1">ContactPoints</a> &amp;ioContactPointsOn1, <a class="el" href="_contact_listener_8h.html#ac6f5f34116f161cc13203803010c37c1">ContactPoints</a> &amp;ioContactPointsOn2, <a class="el" href="_real_8h.html#a43bea2d9c57780b4b66bab1312fd77f3">RVec3Arg</a> inCenterOfMass)</td></tr>
  119. <tr class="separator:a75e0a7ac1c7d9a4e410265839934c8e9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  120. <tr class="memitem:ae513660caaa9d998e19e6aa14d8cbd97" id="r_ae513660caaa9d998e19e6aa14d8cbd97"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_core_8h.html#a2712a9b0f778ab9d1aa5118b4e8e6bd8">JPH_EXPORT</a> void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ae513660caaa9d998e19e6aa14d8cbd97">ManifoldBetweenTwoFaces</a> (<a class="el" href="_math_types_8h.html#a6bc57c31f15cea47640b580d03737c68">Vec3Arg</a> inContactPoint1, <a class="el" href="_math_types_8h.html#a6bc57c31f15cea47640b580d03737c68">Vec3Arg</a> inContactPoint2, <a class="el" href="_math_types_8h.html#a6bc57c31f15cea47640b580d03737c68">Vec3Arg</a> inPenetrationAxis, float inMaxContactDistance, const <a class="el" href="class_shape.html#a95d3060318d33c1ef314c5b856a70cb8">ConvexShape::SupportingFace</a> &amp;inShape1Face, const <a class="el" href="class_shape.html#a95d3060318d33c1ef314c5b856a70cb8">ConvexShape::SupportingFace</a> &amp;inShape2Face, <a class="el" href="_contact_listener_8h.html#ac6f5f34116f161cc13203803010c37c1">ContactPoints</a> &amp;outContactPoints1, <a class="el" href="_contact_listener_8h.html#ac6f5f34116f161cc13203803010c37c1">ContactPoints</a> &amp;outContactPoints2, <a class="el" href="_real_8h.html#a43bea2d9c57780b4b66bab1312fd77f3">RVec3Arg</a> inCenterOfMass)</td></tr>
  121. <tr class="separator:ae513660caaa9d998e19e6aa14d8cbd97"><td class="memSeparator" colspan="2">&#160;</td></tr>
  122. </table>
  123. <h2 class="groupheader">Function Documentation</h2>
  124. <a id="ae513660caaa9d998e19e6aa14d8cbd97" name="ae513660caaa9d998e19e6aa14d8cbd97"></a>
  125. <h2 class="memtitle"><span class="permalink"><a href="#ae513660caaa9d998e19e6aa14d8cbd97">&#9670;&#160;</a></span>ManifoldBetweenTwoFaces()</h2>
  126. <div class="memitem">
  127. <div class="memproto">
  128. <table class="memname">
  129. <tr>
  130. <td class="memname"><a class="el" href="_core_8h.html#a2712a9b0f778ab9d1aa5118b4e8e6bd8">JPH_EXPORT</a> void ManifoldBetweenTwoFaces </td>
  131. <td>(</td>
  132. <td class="paramtype"><a class="el" href="_math_types_8h.html#a6bc57c31f15cea47640b580d03737c68">Vec3Arg</a></td> <td class="paramname"><span class="paramname"><em>inContactPoint1</em></span>, </td>
  133. </tr>
  134. <tr>
  135. <td class="paramkey"></td>
  136. <td></td>
  137. <td class="paramtype"><a class="el" href="_math_types_8h.html#a6bc57c31f15cea47640b580d03737c68">Vec3Arg</a></td> <td class="paramname"><span class="paramname"><em>inContactPoint2</em></span>, </td>
  138. </tr>
  139. <tr>
  140. <td class="paramkey"></td>
  141. <td></td>
  142. <td class="paramtype"><a class="el" href="_math_types_8h.html#a6bc57c31f15cea47640b580d03737c68">Vec3Arg</a></td> <td class="paramname"><span class="paramname"><em>inPenetrationAxis</em></span>, </td>
  143. </tr>
  144. <tr>
  145. <td class="paramkey"></td>
  146. <td></td>
  147. <td class="paramtype">float</td> <td class="paramname"><span class="paramname"><em>inMaxContactDistance</em></span>, </td>
  148. </tr>
  149. <tr>
  150. <td class="paramkey"></td>
  151. <td></td>
  152. <td class="paramtype">const <a class="el" href="class_shape.html#a95d3060318d33c1ef314c5b856a70cb8">ConvexShape::SupportingFace</a> &amp;</td> <td class="paramname"><span class="paramname"><em>inShape1Face</em></span>, </td>
  153. </tr>
  154. <tr>
  155. <td class="paramkey"></td>
  156. <td></td>
  157. <td class="paramtype">const <a class="el" href="class_shape.html#a95d3060318d33c1ef314c5b856a70cb8">ConvexShape::SupportingFace</a> &amp;</td> <td class="paramname"><span class="paramname"><em>inShape2Face</em></span>, </td>
  158. </tr>
  159. <tr>
  160. <td class="paramkey"></td>
  161. <td></td>
  162. <td class="paramtype"><a class="el" href="_contact_listener_8h.html#ac6f5f34116f161cc13203803010c37c1">ContactPoints</a> &amp;</td> <td class="paramname"><span class="paramname"><em>outContactPoints1</em></span>, </td>
  163. </tr>
  164. <tr>
  165. <td class="paramkey"></td>
  166. <td></td>
  167. <td class="paramtype"><a class="el" href="_contact_listener_8h.html#ac6f5f34116f161cc13203803010c37c1">ContactPoints</a> &amp;</td> <td class="paramname"><span class="paramname"><em>outContactPoints2</em></span>, </td>
  168. </tr>
  169. <tr>
  170. <td class="paramkey"></td>
  171. <td></td>
  172. <td class="paramtype"><a class="el" href="_real_8h.html#a43bea2d9c57780b4b66bab1312fd77f3">RVec3Arg</a></td> <td class="paramname"><span class="paramname"><em>inCenterOfMass</em></span>&#160;)</td>
  173. </tr>
  174. </table>
  175. </div><div class="memdoc">
  176. <p>Determine contact points between 2 faces of 2 shapes and return them in outContactPoints 1 &amp; 2 </p><dl class="params"><dt>Parameters</dt><dd>
  177. <table class="params">
  178. <tr><td class="paramname">inContactPoint1</td><td>The contact point on shape 1 relative to inCenterOfMass </td></tr>
  179. <tr><td class="paramname">inContactPoint2</td><td>The contact point on shape 2 relative to inCenterOfMass </td></tr>
  180. <tr><td class="paramname">inPenetrationAxis</td><td>The local space penetration axis in world space </td></tr>
  181. <tr><td class="paramname">inMaxContactDistance</td><td>After face 2 is clipped against face 1, each remaining point on face 2 is tested against the plane of face 1. If the distance on the positive side of the plane is larger than this distance, the point will be discarded as a contact point. </td></tr>
  182. <tr><td class="paramname">inShape1Face</td><td>The supporting faces on shape 1 relative to inCenterOfMass </td></tr>
  183. <tr><td class="paramname">inShape2Face</td><td>The supporting faces on shape 2 relative to inCenterOfMass </td></tr>
  184. <tr><td class="paramname">outContactPoints1</td><td>Returns the contact points between the two shapes for shape 1 relative to inCenterOfMass (any existing points in the output array are left as is) </td></tr>
  185. <tr><td class="paramname">outContactPoints2</td><td>Returns the contact points between the two shapes for shape 2 relative to inCenterOfMass (any existing points in the output array are left as is)</td></tr>
  186. <tr><td class="paramname">inCenterOfMass</td><td>Center of mass position of body 1 </td></tr>
  187. </table>
  188. </dd>
  189. </dl>
  190. </div>
  191. </div>
  192. <a id="a75e0a7ac1c7d9a4e410265839934c8e9" name="a75e0a7ac1c7d9a4e410265839934c8e9"></a>
  193. <h2 class="memtitle"><span class="permalink"><a href="#a75e0a7ac1c7d9a4e410265839934c8e9">&#9670;&#160;</a></span>PruneContactPoints()</h2>
  194. <div class="memitem">
  195. <div class="memproto">
  196. <table class="memname">
  197. <tr>
  198. <td class="memname"><a class="el" href="_core_8h.html#ad14098b68b8c44ea6112601031268405">JPH_NAMESPACE_BEGIN</a> <a class="el" href="_core_8h.html#a2712a9b0f778ab9d1aa5118b4e8e6bd8">JPH_EXPORT</a> void PruneContactPoints </td>
  199. <td>(</td>
  200. <td class="paramtype"><a class="el" href="_math_types_8h.html#a6bc57c31f15cea47640b580d03737c68">Vec3Arg</a></td> <td class="paramname"><span class="paramname"><em>inPenetrationAxis</em></span>, </td>
  201. </tr>
  202. <tr>
  203. <td class="paramkey"></td>
  204. <td></td>
  205. <td class="paramtype"><a class="el" href="_contact_listener_8h.html#ac6f5f34116f161cc13203803010c37c1">ContactPoints</a> &amp;</td> <td class="paramname"><span class="paramname"><em>ioContactPointsOn1</em></span>, </td>
  206. </tr>
  207. <tr>
  208. <td class="paramkey"></td>
  209. <td></td>
  210. <td class="paramtype"><a class="el" href="_contact_listener_8h.html#ac6f5f34116f161cc13203803010c37c1">ContactPoints</a> &amp;</td> <td class="paramname"><span class="paramname"><em>ioContactPointsOn2</em></span>, </td>
  211. </tr>
  212. <tr>
  213. <td class="paramkey"></td>
  214. <td></td>
  215. <td class="paramtype"><a class="el" href="_real_8h.html#a43bea2d9c57780b4b66bab1312fd77f3">RVec3Arg</a></td> <td class="paramname"><span class="paramname"><em>inCenterOfMass</em></span>&#160;)</td>
  216. </tr>
  217. </table>
  218. </div><div class="memdoc">
  219. <p>Remove contact points if there are &gt; 4 (no more than 4 are needed for a stable solution) </p><dl class="params"><dt>Parameters</dt><dd>
  220. <table class="params">
  221. <tr><td class="paramname">inPenetrationAxis</td><td>is the world space penetration axis (must be normalized) </td></tr>
  222. <tr><td class="paramname">ioContactPointsOn1</td><td>The contact points on shape 1 relative to inCenterOfMass </td></tr>
  223. <tr><td class="paramname">ioContactPointsOn2</td><td>The contact points on shape 2 relative to inCenterOfMass On output ioContactPointsOn1/2 are reduced to 4 or less points</td></tr>
  224. <tr><td class="paramname">inCenterOfMass</td><td>Center of mass position of body 1 </td></tr>
  225. </table>
  226. </dd>
  227. </dl>
  228. </div>
  229. </div>
  230. </div><!-- contents -->
  231. </div><!-- doc-content -->
  232. <!-- start footer part -->
  233. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  234. <ul>
  235. <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="_manifold_between_two_faces_8h.html">ManifoldBetweenTwoFaces.h</a></li>
  236. <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>
  237. </ul>
  238. </div>
  239. </body>
  240. </html>