struct_body_pair.html 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328
  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: BodyPair Struct 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('struct_body_pair.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="struct_body_pair-members.html">List of all members</a> </div>
  110. <div class="headertitle"><div class="title">BodyPair Struct Reference</div></div>
  111. </div><!--header-->
  112. <div class="contents">
  113. <p>Structure that holds a body pair.
  114. <a href="#details">More...</a></p>
  115. <p><code>#include &lt;<a class="el" href="_body_pair_8h_source.html">BodyPair.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:af07fc6b828c249ac30e5ad5f406016f8" id="r_af07fc6b828c249ac30e5ad5f406016f8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_memory_8h.html#a91074fb218fe28954a0938c099ddd9e0">JPH_OVERRIDE_NEW_DELETE</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#af07fc6b828c249ac30e5ad5f406016f8">BodyPair</a> ()=default</td></tr>
  120. <tr class="memdesc:af07fc6b828c249ac30e5ad5f406016f8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor. <br /></td></tr>
  121. <tr class="separator:af07fc6b828c249ac30e5ad5f406016f8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  122. <tr class="memitem:a89d92908491717f39027b1f51a50088c" id="r_a89d92908491717f39027b1f51a50088c"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a89d92908491717f39027b1f51a50088c">BodyPair</a> (<a class="el" href="class_body_i_d.html">BodyID</a> inA, <a class="el" href="class_body_i_d.html">BodyID</a> inB)</td></tr>
  123. <tr class="separator:a89d92908491717f39027b1f51a50088c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  124. <tr class="memitem:a9170bf752664d8527564d386e428930a" id="r_a9170bf752664d8527564d386e428930a"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a9170bf752664d8527564d386e428930a">operator==</a> (const <a class="el" href="struct_body_pair.html">BodyPair</a> &amp;inRHS) const</td></tr>
  125. <tr class="memdesc:a9170bf752664d8527564d386e428930a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Equals operator. <br /></td></tr>
  126. <tr class="separator:a9170bf752664d8527564d386e428930a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  127. <tr class="memitem:a20493f29c36b3f20e8db0e86849e1547" id="r_a20493f29c36b3f20e8db0e86849e1547"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a20493f29c36b3f20e8db0e86849e1547">operator&lt;</a> (const <a class="el" href="struct_body_pair.html">BodyPair</a> &amp;inRHS) const</td></tr>
  128. <tr class="memdesc:a20493f29c36b3f20e8db0e86849e1547"><td class="mdescLeft">&#160;</td><td class="mdescRight">Smaller than operator, used for consistently ordering body pairs. <br /></td></tr>
  129. <tr class="separator:a20493f29c36b3f20e8db0e86849e1547"><td class="memSeparator" colspan="2">&#160;</td></tr>
  130. <tr class="memitem:a5c584f3eda9897aa691047f585fdde06" id="r_a5c584f3eda9897aa691047f585fdde06"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_core_8h.html#a60e8696a4678cd348e991a1f172e53f7">uint64</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a5c584f3eda9897aa691047f585fdde06">GetHash</a> () const</td></tr>
  131. <tr class="memdesc:a5c584f3eda9897aa691047f585fdde06"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the hash value of this object. <br /></td></tr>
  132. <tr class="separator:a5c584f3eda9897aa691047f585fdde06"><td class="memSeparator" colspan="2">&#160;</td></tr>
  133. </table><table class="memberdecls">
  134. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
  135. Public Attributes</h2></td></tr>
  136. <tr class="memitem:a9071ec4a6f8552717d3a397528e3b2b8" id="r_a9071ec4a6f8552717d3a397528e3b2b8"><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="#a9071ec4a6f8552717d3a397528e3b2b8">mBodyA</a></td></tr>
  137. <tr class="separator:a9071ec4a6f8552717d3a397528e3b2b8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  138. <tr class="memitem:aeb1186aac2ffbb99da346a15569f1855" id="r_aeb1186aac2ffbb99da346a15569f1855"><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="#aeb1186aac2ffbb99da346a15569f1855">mBodyB</a></td></tr>
  139. <tr class="separator:aeb1186aac2ffbb99da346a15569f1855"><td class="memSeparator" colspan="2">&#160;</td></tr>
  140. </table>
  141. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  142. <div class="textblock"><p>Structure that holds a body pair. </p>
  143. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  144. <a id="af07fc6b828c249ac30e5ad5f406016f8" name="af07fc6b828c249ac30e5ad5f406016f8"></a>
  145. <h2 class="memtitle"><span class="permalink"><a href="#af07fc6b828c249ac30e5ad5f406016f8">&#9670;&#160;</a></span>BodyPair() <span class="overload">[1/2]</span></h2>
  146. <div class="memitem">
  147. <div class="memproto">
  148. <table class="mlabels">
  149. <tr>
  150. <td class="mlabels-left">
  151. <table class="memname">
  152. <tr>
  153. <td class="memname"><a class="el" href="_memory_8h.html#a91074fb218fe28954a0938c099ddd9e0">JPH_OVERRIDE_NEW_DELETE</a> BodyPair::BodyPair </td>
  154. <td>(</td>
  155. <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  156. <td></td>
  157. </tr>
  158. </table>
  159. </td>
  160. <td class="mlabels-right">
  161. <span class="mlabels"><span class="mlabel">default</span></span> </td>
  162. </tr>
  163. </table>
  164. </div><div class="memdoc">
  165. <p>Constructor. </p>
  166. </div>
  167. </div>
  168. <a id="a89d92908491717f39027b1f51a50088c" name="a89d92908491717f39027b1f51a50088c"></a>
  169. <h2 class="memtitle"><span class="permalink"><a href="#a89d92908491717f39027b1f51a50088c">&#9670;&#160;</a></span>BodyPair() <span class="overload">[2/2]</span></h2>
  170. <div class="memitem">
  171. <div class="memproto">
  172. <table class="mlabels">
  173. <tr>
  174. <td class="mlabels-left">
  175. <table class="memname">
  176. <tr>
  177. <td class="memname">BodyPair::BodyPair </td>
  178. <td>(</td>
  179. <td class="paramtype"><a class="el" href="class_body_i_d.html">BodyID</a></td> <td class="paramname"><span class="paramname"><em>inA</em></span>, </td>
  180. </tr>
  181. <tr>
  182. <td class="paramkey"></td>
  183. <td></td>
  184. <td class="paramtype"><a class="el" href="class_body_i_d.html">BodyID</a></td> <td class="paramname"><span class="paramname"><em>inB</em></span>&#160;)</td>
  185. </tr>
  186. </table>
  187. </td>
  188. <td class="mlabels-right">
  189. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  190. </tr>
  191. </table>
  192. </div><div class="memdoc">
  193. </div>
  194. </div>
  195. <h2 class="groupheader">Member Function Documentation</h2>
  196. <a id="a5c584f3eda9897aa691047f585fdde06" name="a5c584f3eda9897aa691047f585fdde06"></a>
  197. <h2 class="memtitle"><span class="permalink"><a href="#a5c584f3eda9897aa691047f585fdde06">&#9670;&#160;</a></span>GetHash()</h2>
  198. <div class="memitem">
  199. <div class="memproto">
  200. <table class="mlabels">
  201. <tr>
  202. <td class="mlabels-left">
  203. <table class="memname">
  204. <tr>
  205. <td class="memname"><a class="el" href="_core_8h.html#a60e8696a4678cd348e991a1f172e53f7">uint64</a> BodyPair::GetHash </td>
  206. <td>(</td>
  207. <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  208. <td> const</td>
  209. </tr>
  210. </table>
  211. </td>
  212. <td class="mlabels-right">
  213. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  214. </tr>
  215. </table>
  216. </div><div class="memdoc">
  217. <p>Get the hash value of this object. </p>
  218. </div>
  219. </div>
  220. <a id="a20493f29c36b3f20e8db0e86849e1547" name="a20493f29c36b3f20e8db0e86849e1547"></a>
  221. <h2 class="memtitle"><span class="permalink"><a href="#a20493f29c36b3f20e8db0e86849e1547">&#9670;&#160;</a></span>operator&lt;()</h2>
  222. <div class="memitem">
  223. <div class="memproto">
  224. <table class="mlabels">
  225. <tr>
  226. <td class="mlabels-left">
  227. <table class="memname">
  228. <tr>
  229. <td class="memname">bool BodyPair::operator&lt; </td>
  230. <td>(</td>
  231. <td class="paramtype">const <a class="el" href="struct_body_pair.html">BodyPair</a> &amp;</td> <td class="paramname"><span class="paramname"><em>inRHS</em></span></td><td>)</td>
  232. <td> const</td>
  233. </tr>
  234. </table>
  235. </td>
  236. <td class="mlabels-right">
  237. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  238. </tr>
  239. </table>
  240. </div><div class="memdoc">
  241. <p>Smaller than operator, used for consistently ordering body pairs. </p>
  242. </div>
  243. </div>
  244. <a id="a9170bf752664d8527564d386e428930a" name="a9170bf752664d8527564d386e428930a"></a>
  245. <h2 class="memtitle"><span class="permalink"><a href="#a9170bf752664d8527564d386e428930a">&#9670;&#160;</a></span>operator==()</h2>
  246. <div class="memitem">
  247. <div class="memproto">
  248. <table class="mlabels">
  249. <tr>
  250. <td class="mlabels-left">
  251. <table class="memname">
  252. <tr>
  253. <td class="memname">bool BodyPair::operator== </td>
  254. <td>(</td>
  255. <td class="paramtype">const <a class="el" href="struct_body_pair.html">BodyPair</a> &amp;</td> <td class="paramname"><span class="paramname"><em>inRHS</em></span></td><td>)</td>
  256. <td> const</td>
  257. </tr>
  258. </table>
  259. </td>
  260. <td class="mlabels-right">
  261. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  262. </tr>
  263. </table>
  264. </div><div class="memdoc">
  265. <p>Equals operator. </p>
  266. </div>
  267. </div>
  268. <h2 class="groupheader">Member Data Documentation</h2>
  269. <a id="a9071ec4a6f8552717d3a397528e3b2b8" name="a9071ec4a6f8552717d3a397528e3b2b8"></a>
  270. <h2 class="memtitle"><span class="permalink"><a href="#a9071ec4a6f8552717d3a397528e3b2b8">&#9670;&#160;</a></span>mBodyA</h2>
  271. <div class="memitem">
  272. <div class="memproto">
  273. <table class="memname">
  274. <tr>
  275. <td class="memname"><a class="el" href="class_body_i_d.html">BodyID</a> BodyPair::mBodyA</td>
  276. </tr>
  277. </table>
  278. </div><div class="memdoc">
  279. </div>
  280. </div>
  281. <a id="aeb1186aac2ffbb99da346a15569f1855" name="aeb1186aac2ffbb99da346a15569f1855"></a>
  282. <h2 class="memtitle"><span class="permalink"><a href="#aeb1186aac2ffbb99da346a15569f1855">&#9670;&#160;</a></span>mBodyB</h2>
  283. <div class="memitem">
  284. <div class="memproto">
  285. <table class="memname">
  286. <tr>
  287. <td class="memname"><a class="el" href="class_body_i_d.html">BodyID</a> BodyPair::mBodyB</td>
  288. </tr>
  289. </table>
  290. </div><div class="memdoc">
  291. </div>
  292. </div>
  293. <hr/>The documentation for this struct was generated from the following file:<ul>
  294. <li>Jolt/Physics/Body/<a class="el" href="_body_pair_8h_source.html">BodyPair.h</a></li>
  295. </ul>
  296. </div><!-- contents -->
  297. </div><!-- doc-content -->
  298. <!-- start footer part -->
  299. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  300. <ul>
  301. <li class="navelem"><a class="el" href="struct_body_pair.html">BodyPair</a></li>
  302. <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>
  303. </ul>
  304. </div>
  305. </body>
  306. </html>