_body_pair_8h_source.html 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168
  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/Body/BodyPair.h Source File</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('_body_pair_8h_source.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="headertitle"><div class="title">BodyPair.h</div></div>
  107. </div><!--header-->
  108. <div class="contents">
  109. <a href="_body_pair_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>
  110. <div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment">// SPDX-FileCopyrightText: 2021 Jorrit Rouwe</span></div>
  111. <div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment">// SPDX-License-Identifier: MIT</span></div>
  112. <div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span> </div>
  113. <div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="preprocessor">#pragma once</span></div>
  114. <div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span> </div>
  115. <div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="preprocessor">#include &lt;<a class="code" href="_body_i_d_8h.html">Jolt/Physics/Body/BodyID.h</a>&gt;</span></div>
  116. <div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="preprocessor">#include &lt;<a class="code" href="_hash_combine_8h.html">Jolt/Core/HashCombine.h</a>&gt;</span></div>
  117. <div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span> </div>
  118. <div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><a class="code hl_define" href="_core_8h.html#ad14098b68b8c44ea6112601031268405">JPH_NAMESPACE_BEGIN</a></div>
  119. <div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span> </div>
  120. <div class="foldopen" id="foldopen00013" data-start="{" data-end="};">
  121. <div class="line"><a id="l00013" name="l00013"></a><span class="lineno"><a class="line" href="struct_body_pair.html"> 13</a></span><span class="keyword">struct </span>alignas(uint64) <a class="code hl_struct" href="struct_body_pair.html">BodyPair</a></div>
  122. <div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span>{</div>
  123. <div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span> <a class="code hl_define" href="_memory_8h.html#a91074fb218fe28954a0938c099ddd9e0">JPH_OVERRIDE_NEW_DELETE</a></div>
  124. <div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span> </div>
  125. <div class="line"><a id="l00018" name="l00018"></a><span class="lineno"><a class="line" href="struct_body_pair.html#af07fc6b828c249ac30e5ad5f406016f8"> 18</a></span> <a class="code hl_function" href="struct_body_pair.html#af07fc6b828c249ac30e5ad5f406016f8">BodyPair</a>() = <span class="keywordflow">default</span>;</div>
  126. <div class="line"><a id="l00019" name="l00019"></a><span class="lineno"><a class="line" href="struct_body_pair.html#a89d92908491717f39027b1f51a50088c"> 19</a></span> <a class="code hl_function" href="struct_body_pair.html#a89d92908491717f39027b1f51a50088c">BodyPair</a>(<a class="code hl_class" href="class_body_i_d.html">BodyID</a> inA, <a class="code hl_class" href="class_body_i_d.html">BodyID</a> inB) : mBodyA(inA), mBodyB(inB) { }</div>
  127. <div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> </div>
  128. <div class="line"><a id="l00022" name="l00022"></a><span class="lineno"><a class="line" href="struct_body_pair.html#a9170bf752664d8527564d386e428930a"> 22</a></span> <span class="keywordtype">bool</span> operator == (<span class="keyword">const</span> <a class="code hl_struct" href="struct_body_pair.html">BodyPair</a> &amp;inRHS)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> *<span class="keyword">reinterpret_cast&lt;</span><span class="keyword">const </span><a class="code hl_typedef" href="_core_8h.html#a60e8696a4678cd348e991a1f172e53f7">uint64</a> *<span class="keyword">&gt;</span>(<span class="keyword">this</span>) == *<span class="keyword">reinterpret_cast&lt;</span><span class="keyword">const </span><a class="code hl_typedef" href="_core_8h.html#a60e8696a4678cd348e991a1f172e53f7">uint64</a> *<span class="keyword">&gt;</span>(&amp;inRHS); }</div>
  129. <div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> </div>
  130. <div class="line"><a id="l00025" name="l00025"></a><span class="lineno"><a class="line" href="struct_body_pair.html#a20493f29c36b3f20e8db0e86849e1547"> 25</a></span> <span class="keywordtype">bool</span> operator &lt; (<span class="keyword">const</span> <a class="code hl_struct" href="struct_body_pair.html">BodyPair</a> &amp;inRHS)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> *<span class="keyword">reinterpret_cast&lt;</span><span class="keyword">const </span><a class="code hl_typedef" href="_core_8h.html#a60e8696a4678cd348e991a1f172e53f7">uint64</a> *<span class="keyword">&gt;</span>(<span class="keyword">this</span>) &lt; *<span class="keyword">reinterpret_cast&lt;</span><span class="keyword">const </span><a class="code hl_typedef" href="_core_8h.html#a60e8696a4678cd348e991a1f172e53f7">uint64</a> *<span class="keyword">&gt;</span>(&amp;inRHS); }</div>
  131. <div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> </div>
  132. <div class="line"><a id="l00028" name="l00028"></a><span class="lineno"><a class="line" href="struct_body_pair.html#a5c584f3eda9897aa691047f585fdde06"> 28</a></span> <a class="code hl_typedef" href="_core_8h.html#a60e8696a4678cd348e991a1f172e53f7">uint64</a> <a class="code hl_function" href="struct_body_pair.html#a5c584f3eda9897aa691047f585fdde06">GetHash</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code hl_function" href="_hash_combine_8h.html#a8ce241fe287672b4a559499d341d2ee7">Hash64</a>(*<span class="keyword">reinterpret_cast&lt;</span><span class="keyword">const </span><a class="code hl_typedef" href="_core_8h.html#a60e8696a4678cd348e991a1f172e53f7">uint64</a> *<span class="keyword">&gt;</span>(<span class="keyword">this</span>)); }</div>
  133. <div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> </div>
  134. <div class="line"><a id="l00030" name="l00030"></a><span class="lineno"><a class="line" href="struct_body_pair.html#a9071ec4a6f8552717d3a397528e3b2b8"> 30</a></span> <a class="code hl_class" href="class_body_i_d.html">BodyID</a> <a class="code hl_variable" href="struct_body_pair.html#a9071ec4a6f8552717d3a397528e3b2b8">mBodyA</a>;</div>
  135. <div class="line"><a id="l00031" name="l00031"></a><span class="lineno"><a class="line" href="struct_body_pair.html#aeb1186aac2ffbb99da346a15569f1855"> 31</a></span> <a class="code hl_class" href="class_body_i_d.html">BodyID</a> <a class="code hl_variable" href="struct_body_pair.html#aeb1186aac2ffbb99da346a15569f1855">mBodyB</a>;</div>
  136. <div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span>};</div>
  137. </div>
  138. <div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> </div>
  139. <div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span><span class="keyword">static_assert</span>(<span class="keyword">sizeof</span>(<a class="code hl_struct" href="struct_body_pair.html">BodyPair</a>) == <span class="keyword">sizeof</span>(<a class="code hl_typedef" href="_core_8h.html#a60e8696a4678cd348e991a1f172e53f7">uint64</a>), <span class="stringliteral">&quot;Mismatch in class size&quot;</span>);</div>
  140. <div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> </div>
  141. <div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span><a class="code hl_define" href="_core_8h.html#a73da8725998b00321a9db341202d650d">JPH_NAMESPACE_END</a></div>
  142. <div class="ttc" id="a_body_i_d_8h_html"><div class="ttname"><a href="_body_i_d_8h.html">BodyID.h</a></div></div>
  143. <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>
  144. <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>
  145. <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>
  146. <div class="ttc" id="a_hash_combine_8h_html"><div class="ttname"><a href="_hash_combine_8h.html">HashCombine.h</a></div></div>
  147. <div class="ttc" id="a_hash_combine_8h_html_a8ce241fe287672b4a559499d341d2ee7"><div class="ttname"><a href="_hash_combine_8h.html#a8ce241fe287672b4a559499d341d2ee7">Hash64</a></div><div class="ttdeci">uint64 Hash64(uint64 inValue)</div><div class="ttdef"><b>Definition</b> HashCombine.h:43</div></div>
  148. <div class="ttc" id="a_memory_8h_html_a91074fb218fe28954a0938c099ddd9e0"><div class="ttname"><a href="_memory_8h.html#a91074fb218fe28954a0938c099ddd9e0">JPH_OVERRIDE_NEW_DELETE</a></div><div class="ttdeci">#define JPH_OVERRIDE_NEW_DELETE</div><div class="ttdoc">Macro to override the new and delete functions.</div><div class="ttdef"><b>Definition</b> Memory.h:50</div></div>
  149. <div class="ttc" id="aclass_body_i_d_html"><div class="ttname"><a href="class_body_i_d.html">BodyID</a></div><div class="ttdoc">ID of a body. This is a way of reasoning about bodies in a multithreaded simulation while avoiding ra...</div><div class="ttdef"><b>Definition</b> BodyID.h:13</div></div>
  150. <div class="ttc" id="astruct_body_pair_html"><div class="ttname"><a href="struct_body_pair.html">BodyPair</a></div><div class="ttdoc">Structure that holds a body pair.</div><div class="ttdef"><b>Definition</b> BodyPair.h:14</div></div>
  151. <div class="ttc" id="astruct_body_pair_html_a5c584f3eda9897aa691047f585fdde06"><div class="ttname"><a href="struct_body_pair.html#a5c584f3eda9897aa691047f585fdde06">BodyPair::GetHash</a></div><div class="ttdeci">uint64 GetHash() const</div><div class="ttdoc">Get the hash value of this object.</div><div class="ttdef"><b>Definition</b> BodyPair.h:28</div></div>
  152. <div class="ttc" id="astruct_body_pair_html_a89d92908491717f39027b1f51a50088c"><div class="ttname"><a href="struct_body_pair.html#a89d92908491717f39027b1f51a50088c">BodyPair::BodyPair</a></div><div class="ttdeci">BodyPair(BodyID inA, BodyID inB)</div><div class="ttdef"><b>Definition</b> BodyPair.h:19</div></div>
  153. <div class="ttc" id="astruct_body_pair_html_a9071ec4a6f8552717d3a397528e3b2b8"><div class="ttname"><a href="struct_body_pair.html#a9071ec4a6f8552717d3a397528e3b2b8">BodyPair::mBodyA</a></div><div class="ttdeci">BodyID mBodyA</div><div class="ttdef"><b>Definition</b> BodyPair.h:30</div></div>
  154. <div class="ttc" id="astruct_body_pair_html_aeb1186aac2ffbb99da346a15569f1855"><div class="ttname"><a href="struct_body_pair.html#aeb1186aac2ffbb99da346a15569f1855">BodyPair::mBodyB</a></div><div class="ttdeci">BodyID mBodyB</div><div class="ttdef"><b>Definition</b> BodyPair.h:31</div></div>
  155. <div class="ttc" id="astruct_body_pair_html_af07fc6b828c249ac30e5ad5f406016f8"><div class="ttname"><a href="struct_body_pair.html#af07fc6b828c249ac30e5ad5f406016f8">BodyPair::BodyPair</a></div><div class="ttdeci">JPH_OVERRIDE_NEW_DELETE BodyPair()=default</div><div class="ttdoc">Constructor.</div></div>
  156. </div><!-- fragment --></div><!-- contents -->
  157. </div><!-- doc-content -->
  158. <!-- start footer part -->
  159. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  160. <ul>
  161. <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_a240ac3d525f21f79994f1dc1d19664e.html">Body</a></li><li class="navelem"><a class="el" href="_body_pair_8h.html">BodyPair.h</a></li>
  162. <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>
  163. </ul>
  164. </div>
  165. </body>
  166. </html>