class_island_builder.html 36 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577
  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: IslandBuilder 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_island_builder.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="class_island_builder-members.html">List of all members</a> </div>
  109. <div class="headertitle"><div class="title">IslandBuilder Class Reference</div></div>
  110. </div><!--header-->
  111. <div class="contents">
  112. <p>Keeps track of connected bodies and builds islands for multithreaded velocity/position update.
  113. <a href="#details">More...</a></p>
  114. <p><code>#include &lt;<a class="el" href="_island_builder_8h_source.html">IslandBuilder.h</a>&gt;</code></p>
  115. <div class="dynheader">
  116. Inheritance diagram for IslandBuilder:</div>
  117. <div class="dyncontent">
  118. <div class="center">
  119. <img src="class_island_builder.png" usemap="#IslandBuilder_map" alt=""/>
  120. <map id="IslandBuilder_map" name="IslandBuilder_map">
  121. <area href="class_non_copyable.html" title="Class that makes another class non-copyable. Usage: Inherit from NonCopyable." alt="NonCopyable" shape="rect" coords="0,0,89,24"/>
  122. </map>
  123. </div></div>
  124. <table class="memberdecls">
  125. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
  126. Public Member Functions</h2></td></tr>
  127. <tr class="memitem:a88fd7d9e6a6982dc394fd7d647df41cb" id="r_a88fd7d9e6a6982dc394fd7d647df41cb"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a88fd7d9e6a6982dc394fd7d647df41cb">~IslandBuilder</a> ()</td></tr>
  128. <tr class="memdesc:a88fd7d9e6a6982dc394fd7d647df41cb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor. <br /></td></tr>
  129. <tr class="separator:a88fd7d9e6a6982dc394fd7d647df41cb"><td class="memSeparator" colspan="2">&#160;</td></tr>
  130. <tr class="memitem:a060b323839a30c3096ec581b4684290d" id="r_a060b323839a30c3096ec581b4684290d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a060b323839a30c3096ec581b4684290d">Init</a> (<a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a> inMaxActiveBodies)</td></tr>
  131. <tr class="memdesc:a060b323839a30c3096ec581b4684290d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialize the island builder with the maximum amount of bodies that could be active. <br /></td></tr>
  132. <tr class="separator:a060b323839a30c3096ec581b4684290d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  133. <tr class="memitem:aaf615d7e17f6b82156eef5932a4bc9d6" id="r_aaf615d7e17f6b82156eef5932a4bc9d6"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aaf615d7e17f6b82156eef5932a4bc9d6">PrepareContactConstraints</a> (<a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a> inMaxContactConstraints, <a class="el" href="class_temp_allocator.html">TempAllocator</a> *inTempAllocator)</td></tr>
  134. <tr class="memdesc:aaf615d7e17f6b82156eef5932a4bc9d6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Prepare for simulation step by allocating space for the contact constraints. <br /></td></tr>
  135. <tr class="separator:aaf615d7e17f6b82156eef5932a4bc9d6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  136. <tr class="memitem:ac70b90cc284ac3999e18b865724392da" id="r_ac70b90cc284ac3999e18b865724392da"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ac70b90cc284ac3999e18b865724392da">PrepareNonContactConstraints</a> (<a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a> inNumConstraints, <a class="el" href="class_temp_allocator.html">TempAllocator</a> *inTempAllocator)</td></tr>
  137. <tr class="memdesc:ac70b90cc284ac3999e18b865724392da"><td class="mdescLeft">&#160;</td><td class="mdescRight">Prepare for simulation step by allocating space for the non-contact constraints. <br /></td></tr>
  138. <tr class="separator:ac70b90cc284ac3999e18b865724392da"><td class="memSeparator" colspan="2">&#160;</td></tr>
  139. <tr class="memitem:ad3c6e43cef523989bab88ed8cc11575f" id="r_ad3c6e43cef523989bab88ed8cc11575f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ad3c6e43cef523989bab88ed8cc11575f">LinkBodies</a> (<a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a> inFirst, <a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a> inSecond)</td></tr>
  140. <tr class="memdesc:ad3c6e43cef523989bab88ed8cc11575f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Link two bodies by their index in the BodyManager::mActiveBodies list to form islands. <br /></td></tr>
  141. <tr class="separator:ad3c6e43cef523989bab88ed8cc11575f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  142. <tr class="memitem:a323b5204fe8c9fdb7a15791469780259" id="r_a323b5204fe8c9fdb7a15791469780259"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a323b5204fe8c9fdb7a15791469780259">LinkConstraint</a> (<a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a> inConstraintIndex, <a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a> inFirst, <a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a> inSecond)</td></tr>
  143. <tr class="memdesc:a323b5204fe8c9fdb7a15791469780259"><td class="mdescLeft">&#160;</td><td class="mdescRight">Link a constraint to a body by their index in the BodyManager::mActiveBodies. <br /></td></tr>
  144. <tr class="separator:a323b5204fe8c9fdb7a15791469780259"><td class="memSeparator" colspan="2">&#160;</td></tr>
  145. <tr class="memitem:a32b2a16b2eca88110ad2604e2b129132" id="r_a32b2a16b2eca88110ad2604e2b129132"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a32b2a16b2eca88110ad2604e2b129132">LinkContact</a> (<a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a> inContactIndex, <a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a> inFirst, <a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a> inSecond)</td></tr>
  146. <tr class="memdesc:a32b2a16b2eca88110ad2604e2b129132"><td class="mdescLeft">&#160;</td><td class="mdescRight">Link a contact to a body by their index in the BodyManager::mActiveBodies. <br /></td></tr>
  147. <tr class="separator:a32b2a16b2eca88110ad2604e2b129132"><td class="memSeparator" colspan="2">&#160;</td></tr>
  148. <tr class="memitem:af8e0ac69b3e021ab24317116ded1c622" id="r_af8e0ac69b3e021ab24317116ded1c622"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#af8e0ac69b3e021ab24317116ded1c622">Finalize</a> (const <a class="el" href="class_body_i_d.html">BodyID</a> *inActiveBodies, <a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a> inNumActiveBodies, <a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a> inNumContacts, <a class="el" href="class_temp_allocator.html">TempAllocator</a> *inTempAllocator)</td></tr>
  149. <tr class="memdesc:af8e0ac69b3e021ab24317116ded1c622"><td class="mdescLeft">&#160;</td><td class="mdescRight">Finalize the islands after all bodies have been Link()-ed. <br /></td></tr>
  150. <tr class="separator:af8e0ac69b3e021ab24317116ded1c622"><td class="memSeparator" colspan="2">&#160;</td></tr>
  151. <tr class="memitem:a6f0d6d67425a9d02cf561a06784431f4" id="r_a6f0d6d67425a9d02cf561a06784431f4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a6f0d6d67425a9d02cf561a06784431f4">GetNumIslands</a> () const</td></tr>
  152. <tr class="memdesc:a6f0d6d67425a9d02cf561a06784431f4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the amount of islands formed. <br /></td></tr>
  153. <tr class="separator:a6f0d6d67425a9d02cf561a06784431f4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  154. <tr class="memitem:ace0201e247b5fcb9639bba23b385e718" id="r_ace0201e247b5fcb9639bba23b385e718"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ace0201e247b5fcb9639bba23b385e718">GetBodiesInIsland</a> (<a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a> inIslandIndex, <a class="el" href="class_body_i_d.html">BodyID</a> *&amp;outBodiesBegin, <a class="el" href="class_body_i_d.html">BodyID</a> *&amp;outBodiesEnd) const</td></tr>
  155. <tr class="memdesc:ace0201e247b5fcb9639bba23b385e718"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get iterator for a particular island, return false if there are no constraints. <br /></td></tr>
  156. <tr class="separator:ace0201e247b5fcb9639bba23b385e718"><td class="memSeparator" colspan="2">&#160;</td></tr>
  157. <tr class="memitem:abb0ec0d343289ee4294fa3abbde16a82" id="r_abb0ec0d343289ee4294fa3abbde16a82"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#abb0ec0d343289ee4294fa3abbde16a82">GetConstraintsInIsland</a> (<a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a> inIslandIndex, <a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a> *&amp;outConstraintsBegin, <a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a> *&amp;outConstraintsEnd) const</td></tr>
  158. <tr class="separator:abb0ec0d343289ee4294fa3abbde16a82"><td class="memSeparator" colspan="2">&#160;</td></tr>
  159. <tr class="memitem:a39454ff17c3dc0d7b133c79ac2d0d7e0" id="r_a39454ff17c3dc0d7b133c79ac2d0d7e0"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a39454ff17c3dc0d7b133c79ac2d0d7e0">GetContactsInIsland</a> (<a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a> inIslandIndex, <a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a> *&amp;outContactsBegin, <a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a> *&amp;outContactsEnd) const</td></tr>
  160. <tr class="separator:a39454ff17c3dc0d7b133c79ac2d0d7e0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  161. <tr class="memitem:a576814bc0405702b74174635e0b44d6d" id="r_a576814bc0405702b74174635e0b44d6d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a576814bc0405702b74174635e0b44d6d">SetNumPositionSteps</a> (<a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a> inIslandIndex, <a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a> inNumPositionSteps)</td></tr>
  162. <tr class="memdesc:a576814bc0405702b74174635e0b44d6d"><td class="mdescLeft">&#160;</td><td class="mdescRight">The number of position iterations for each island. <br /></td></tr>
  163. <tr class="separator:a576814bc0405702b74174635e0b44d6d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  164. <tr class="memitem:a213561deca43cb4c9bde6560bed5a0e1" id="r_a213561deca43cb4c9bde6560bed5a0e1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a213561deca43cb4c9bde6560bed5a0e1">GetNumPositionSteps</a> (<a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a> inIslandIndex) const</td></tr>
  165. <tr class="separator:a213561deca43cb4c9bde6560bed5a0e1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  166. <tr class="memitem:a3a23a4981c11d55933cc2533504eb38a" id="r_a3a23a4981c11d55933cc2533504eb38a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a3a23a4981c11d55933cc2533504eb38a">ResetIslands</a> (<a class="el" href="class_temp_allocator.html">TempAllocator</a> *inTempAllocator)</td></tr>
  167. <tr class="memdesc:a3a23a4981c11d55933cc2533504eb38a"><td class="mdescLeft">&#160;</td><td class="mdescRight">After you're done calling the three functions above, call this function to free associated data. <br /></td></tr>
  168. <tr class="separator:a3a23a4981c11d55933cc2533504eb38a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  169. <tr class="inherit_header pub_methods_class_non_copyable"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pub_methods_class_non_copyable')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="class_non_copyable.html">NonCopyable</a></td></tr>
  170. <tr class="memitem:a809b6e4ade7ae32f6d248f2a3b783d45 inherit pub_methods_class_non_copyable" id="r_a809b6e4ade7ae32f6d248f2a3b783d45"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_non_copyable.html#a809b6e4ade7ae32f6d248f2a3b783d45">NonCopyable</a> ()=default</td></tr>
  171. <tr class="separator:a809b6e4ade7ae32f6d248f2a3b783d45 inherit pub_methods_class_non_copyable"><td class="memSeparator" colspan="2">&#160;</td></tr>
  172. <tr class="memitem:a501d34ffcc34b30de6d541887a901057 inherit pub_methods_class_non_copyable" id="r_a501d34ffcc34b30de6d541887a901057"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_non_copyable.html#a501d34ffcc34b30de6d541887a901057">NonCopyable</a> (const <a class="el" href="class_non_copyable.html">NonCopyable</a> &amp;)=delete</td></tr>
  173. <tr class="separator:a501d34ffcc34b30de6d541887a901057 inherit pub_methods_class_non_copyable"><td class="memSeparator" colspan="2">&#160;</td></tr>
  174. <tr class="memitem:aaf9b12dcaae80c9d304df7a941d4e21f inherit pub_methods_class_non_copyable" id="r_aaf9b12dcaae80c9d304df7a941d4e21f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_non_copyable.html#aaf9b12dcaae80c9d304df7a941d4e21f">operator=</a> (const <a class="el" href="class_non_copyable.html">NonCopyable</a> &amp;)=delete</td></tr>
  175. <tr class="separator:aaf9b12dcaae80c9d304df7a941d4e21f inherit pub_methods_class_non_copyable"><td class="memSeparator" colspan="2">&#160;</td></tr>
  176. </table>
  177. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  178. <div class="textblock"><p>Keeps track of connected bodies and builds islands for multithreaded velocity/position update. </p>
  179. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  180. <a id="a88fd7d9e6a6982dc394fd7d647df41cb" name="a88fd7d9e6a6982dc394fd7d647df41cb"></a>
  181. <h2 class="memtitle"><span class="permalink"><a href="#a88fd7d9e6a6982dc394fd7d647df41cb">&#9670;&#160;</a></span>~IslandBuilder()</h2>
  182. <div class="memitem">
  183. <div class="memproto">
  184. <table class="memname">
  185. <tr>
  186. <td class="memname"><a class="el" href="_core_8h.html#ad14098b68b8c44ea6112601031268405">JPH_NAMESPACE_BEGIN</a> IslandBuilder::~IslandBuilder </td>
  187. <td>(</td>
  188. <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  189. <td></td>
  190. </tr>
  191. </table>
  192. </div><div class="memdoc">
  193. <p>Destructor. </p>
  194. </div>
  195. </div>
  196. <h2 class="groupheader">Member Function Documentation</h2>
  197. <a id="af8e0ac69b3e021ab24317116ded1c622" name="af8e0ac69b3e021ab24317116ded1c622"></a>
  198. <h2 class="memtitle"><span class="permalink"><a href="#af8e0ac69b3e021ab24317116ded1c622">&#9670;&#160;</a></span>Finalize()</h2>
  199. <div class="memitem">
  200. <div class="memproto">
  201. <table class="memname">
  202. <tr>
  203. <td class="memname">void IslandBuilder::Finalize </td>
  204. <td>(</td>
  205. <td class="paramtype">const <a class="el" href="class_body_i_d.html">BodyID</a> *</td> <td class="paramname"><span class="paramname"><em>inActiveBodies</em></span>, </td>
  206. </tr>
  207. <tr>
  208. <td class="paramkey"></td>
  209. <td></td>
  210. <td class="paramtype"><a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a></td> <td class="paramname"><span class="paramname"><em>inNumActiveBodies</em></span>, </td>
  211. </tr>
  212. <tr>
  213. <td class="paramkey"></td>
  214. <td></td>
  215. <td class="paramtype"><a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a></td> <td class="paramname"><span class="paramname"><em>inNumContacts</em></span>, </td>
  216. </tr>
  217. <tr>
  218. <td class="paramkey"></td>
  219. <td></td>
  220. <td class="paramtype"><a class="el" href="class_temp_allocator.html">TempAllocator</a> *</td> <td class="paramname"><span class="paramname"><em>inTempAllocator</em></span>&#160;)</td>
  221. </tr>
  222. </table>
  223. </div><div class="memdoc">
  224. <p>Finalize the islands after all bodies have been Link()-ed. </p>
  225. </div>
  226. </div>
  227. <a id="ace0201e247b5fcb9639bba23b385e718" name="ace0201e247b5fcb9639bba23b385e718"></a>
  228. <h2 class="memtitle"><span class="permalink"><a href="#ace0201e247b5fcb9639bba23b385e718">&#9670;&#160;</a></span>GetBodiesInIsland()</h2>
  229. <div class="memitem">
  230. <div class="memproto">
  231. <table class="memname">
  232. <tr>
  233. <td class="memname">void IslandBuilder::GetBodiesInIsland </td>
  234. <td>(</td>
  235. <td class="paramtype"><a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a></td> <td class="paramname"><span class="paramname"><em>inIslandIndex</em></span>, </td>
  236. </tr>
  237. <tr>
  238. <td class="paramkey"></td>
  239. <td></td>
  240. <td class="paramtype"><a class="el" href="class_body_i_d.html">BodyID</a> *&amp;</td> <td class="paramname"><span class="paramname"><em>outBodiesBegin</em></span>, </td>
  241. </tr>
  242. <tr>
  243. <td class="paramkey"></td>
  244. <td></td>
  245. <td class="paramtype"><a class="el" href="class_body_i_d.html">BodyID</a> *&amp;</td> <td class="paramname"><span class="paramname"><em>outBodiesEnd</em></span>&#160;) const</td>
  246. </tr>
  247. </table>
  248. </div><div class="memdoc">
  249. <p>Get iterator for a particular island, return false if there are no constraints. </p>
  250. </div>
  251. </div>
  252. <a id="abb0ec0d343289ee4294fa3abbde16a82" name="abb0ec0d343289ee4294fa3abbde16a82"></a>
  253. <h2 class="memtitle"><span class="permalink"><a href="#abb0ec0d343289ee4294fa3abbde16a82">&#9670;&#160;</a></span>GetConstraintsInIsland()</h2>
  254. <div class="memitem">
  255. <div class="memproto">
  256. <table class="memname">
  257. <tr>
  258. <td class="memname">bool IslandBuilder::GetConstraintsInIsland </td>
  259. <td>(</td>
  260. <td class="paramtype"><a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a></td> <td class="paramname"><span class="paramname"><em>inIslandIndex</em></span>, </td>
  261. </tr>
  262. <tr>
  263. <td class="paramkey"></td>
  264. <td></td>
  265. <td class="paramtype"><a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a> *&amp;</td> <td class="paramname"><span class="paramname"><em>outConstraintsBegin</em></span>, </td>
  266. </tr>
  267. <tr>
  268. <td class="paramkey"></td>
  269. <td></td>
  270. <td class="paramtype"><a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a> *&amp;</td> <td class="paramname"><span class="paramname"><em>outConstraintsEnd</em></span>&#160;) const</td>
  271. </tr>
  272. </table>
  273. </div><div class="memdoc">
  274. </div>
  275. </div>
  276. <a id="a39454ff17c3dc0d7b133c79ac2d0d7e0" name="a39454ff17c3dc0d7b133c79ac2d0d7e0"></a>
  277. <h2 class="memtitle"><span class="permalink"><a href="#a39454ff17c3dc0d7b133c79ac2d0d7e0">&#9670;&#160;</a></span>GetContactsInIsland()</h2>
  278. <div class="memitem">
  279. <div class="memproto">
  280. <table class="memname">
  281. <tr>
  282. <td class="memname">bool IslandBuilder::GetContactsInIsland </td>
  283. <td>(</td>
  284. <td class="paramtype"><a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a></td> <td class="paramname"><span class="paramname"><em>inIslandIndex</em></span>, </td>
  285. </tr>
  286. <tr>
  287. <td class="paramkey"></td>
  288. <td></td>
  289. <td class="paramtype"><a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a> *&amp;</td> <td class="paramname"><span class="paramname"><em>outContactsBegin</em></span>, </td>
  290. </tr>
  291. <tr>
  292. <td class="paramkey"></td>
  293. <td></td>
  294. <td class="paramtype"><a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a> *&amp;</td> <td class="paramname"><span class="paramname"><em>outContactsEnd</em></span>&#160;) const</td>
  295. </tr>
  296. </table>
  297. </div><div class="memdoc">
  298. </div>
  299. </div>
  300. <a id="a6f0d6d67425a9d02cf561a06784431f4" name="a6f0d6d67425a9d02cf561a06784431f4"></a>
  301. <h2 class="memtitle"><span class="permalink"><a href="#a6f0d6d67425a9d02cf561a06784431f4">&#9670;&#160;</a></span>GetNumIslands()</h2>
  302. <div class="memitem">
  303. <div class="memproto">
  304. <table class="mlabels">
  305. <tr>
  306. <td class="mlabels-left">
  307. <table class="memname">
  308. <tr>
  309. <td class="memname"><a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a> IslandBuilder::GetNumIslands </td>
  310. <td>(</td>
  311. <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  312. <td> const</td>
  313. </tr>
  314. </table>
  315. </td>
  316. <td class="mlabels-right">
  317. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  318. </tr>
  319. </table>
  320. </div><div class="memdoc">
  321. <p>Get the amount of islands formed. </p>
  322. </div>
  323. </div>
  324. <a id="a213561deca43cb4c9bde6560bed5a0e1" name="a213561deca43cb4c9bde6560bed5a0e1"></a>
  325. <h2 class="memtitle"><span class="permalink"><a href="#a213561deca43cb4c9bde6560bed5a0e1">&#9670;&#160;</a></span>GetNumPositionSteps()</h2>
  326. <div class="memitem">
  327. <div class="memproto">
  328. <table class="mlabels">
  329. <tr>
  330. <td class="mlabels-left">
  331. <table class="memname">
  332. <tr>
  333. <td class="memname"><a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a> IslandBuilder::GetNumPositionSteps </td>
  334. <td>(</td>
  335. <td class="paramtype"><a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a></td> <td class="paramname"><span class="paramname"><em>inIslandIndex</em></span></td><td>)</td>
  336. <td> const</td>
  337. </tr>
  338. </table>
  339. </td>
  340. <td class="mlabels-right">
  341. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  342. </tr>
  343. </table>
  344. </div><div class="memdoc">
  345. </div>
  346. </div>
  347. <a id="a060b323839a30c3096ec581b4684290d" name="a060b323839a30c3096ec581b4684290d"></a>
  348. <h2 class="memtitle"><span class="permalink"><a href="#a060b323839a30c3096ec581b4684290d">&#9670;&#160;</a></span>Init()</h2>
  349. <div class="memitem">
  350. <div class="memproto">
  351. <table class="memname">
  352. <tr>
  353. <td class="memname">void IslandBuilder::Init </td>
  354. <td>(</td>
  355. <td class="paramtype"><a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a></td> <td class="paramname"><span class="paramname"><em>inMaxActiveBodies</em></span></td><td>)</td>
  356. <td></td>
  357. </tr>
  358. </table>
  359. </div><div class="memdoc">
  360. <p>Initialize the island builder with the maximum amount of bodies that could be active. </p>
  361. </div>
  362. </div>
  363. <a id="ad3c6e43cef523989bab88ed8cc11575f" name="ad3c6e43cef523989bab88ed8cc11575f"></a>
  364. <h2 class="memtitle"><span class="permalink"><a href="#ad3c6e43cef523989bab88ed8cc11575f">&#9670;&#160;</a></span>LinkBodies()</h2>
  365. <div class="memitem">
  366. <div class="memproto">
  367. <table class="memname">
  368. <tr>
  369. <td class="memname">void IslandBuilder::LinkBodies </td>
  370. <td>(</td>
  371. <td class="paramtype"><a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a></td> <td class="paramname"><span class="paramname"><em>inFirst</em></span>, </td>
  372. </tr>
  373. <tr>
  374. <td class="paramkey"></td>
  375. <td></td>
  376. <td class="paramtype"><a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a></td> <td class="paramname"><span class="paramname"><em>inSecond</em></span>&#160;)</td>
  377. </tr>
  378. </table>
  379. </div><div class="memdoc">
  380. <p>Link two bodies by their index in the BodyManager::mActiveBodies list to form islands. </p>
  381. </div>
  382. </div>
  383. <a id="a323b5204fe8c9fdb7a15791469780259" name="a323b5204fe8c9fdb7a15791469780259"></a>
  384. <h2 class="memtitle"><span class="permalink"><a href="#a323b5204fe8c9fdb7a15791469780259">&#9670;&#160;</a></span>LinkConstraint()</h2>
  385. <div class="memitem">
  386. <div class="memproto">
  387. <table class="memname">
  388. <tr>
  389. <td class="memname">void IslandBuilder::LinkConstraint </td>
  390. <td>(</td>
  391. <td class="paramtype"><a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a></td> <td class="paramname"><span class="paramname"><em>inConstraintIndex</em></span>, </td>
  392. </tr>
  393. <tr>
  394. <td class="paramkey"></td>
  395. <td></td>
  396. <td class="paramtype"><a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a></td> <td class="paramname"><span class="paramname"><em>inFirst</em></span>, </td>
  397. </tr>
  398. <tr>
  399. <td class="paramkey"></td>
  400. <td></td>
  401. <td class="paramtype"><a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a></td> <td class="paramname"><span class="paramname"><em>inSecond</em></span>&#160;)</td>
  402. </tr>
  403. </table>
  404. </div><div class="memdoc">
  405. <p>Link a constraint to a body by their index in the BodyManager::mActiveBodies. </p>
  406. </div>
  407. </div>
  408. <a id="a32b2a16b2eca88110ad2604e2b129132" name="a32b2a16b2eca88110ad2604e2b129132"></a>
  409. <h2 class="memtitle"><span class="permalink"><a href="#a32b2a16b2eca88110ad2604e2b129132">&#9670;&#160;</a></span>LinkContact()</h2>
  410. <div class="memitem">
  411. <div class="memproto">
  412. <table class="memname">
  413. <tr>
  414. <td class="memname">void IslandBuilder::LinkContact </td>
  415. <td>(</td>
  416. <td class="paramtype"><a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a></td> <td class="paramname"><span class="paramname"><em>inContactIndex</em></span>, </td>
  417. </tr>
  418. <tr>
  419. <td class="paramkey"></td>
  420. <td></td>
  421. <td class="paramtype"><a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a></td> <td class="paramname"><span class="paramname"><em>inFirst</em></span>, </td>
  422. </tr>
  423. <tr>
  424. <td class="paramkey"></td>
  425. <td></td>
  426. <td class="paramtype"><a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a></td> <td class="paramname"><span class="paramname"><em>inSecond</em></span>&#160;)</td>
  427. </tr>
  428. </table>
  429. </div><div class="memdoc">
  430. <p>Link a contact to a body by their index in the BodyManager::mActiveBodies. </p>
  431. </div>
  432. </div>
  433. <a id="aaf615d7e17f6b82156eef5932a4bc9d6" name="aaf615d7e17f6b82156eef5932a4bc9d6"></a>
  434. <h2 class="memtitle"><span class="permalink"><a href="#aaf615d7e17f6b82156eef5932a4bc9d6">&#9670;&#160;</a></span>PrepareContactConstraints()</h2>
  435. <div class="memitem">
  436. <div class="memproto">
  437. <table class="memname">
  438. <tr>
  439. <td class="memname">void IslandBuilder::PrepareContactConstraints </td>
  440. <td>(</td>
  441. <td class="paramtype"><a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a></td> <td class="paramname"><span class="paramname"><em>inMaxContactConstraints</em></span>, </td>
  442. </tr>
  443. <tr>
  444. <td class="paramkey"></td>
  445. <td></td>
  446. <td class="paramtype"><a class="el" href="class_temp_allocator.html">TempAllocator</a> *</td> <td class="paramname"><span class="paramname"><em>inTempAllocator</em></span>&#160;)</td>
  447. </tr>
  448. </table>
  449. </div><div class="memdoc">
  450. <p>Prepare for simulation step by allocating space for the contact constraints. </p>
  451. </div>
  452. </div>
  453. <a id="ac70b90cc284ac3999e18b865724392da" name="ac70b90cc284ac3999e18b865724392da"></a>
  454. <h2 class="memtitle"><span class="permalink"><a href="#ac70b90cc284ac3999e18b865724392da">&#9670;&#160;</a></span>PrepareNonContactConstraints()</h2>
  455. <div class="memitem">
  456. <div class="memproto">
  457. <table class="memname">
  458. <tr>
  459. <td class="memname">void IslandBuilder::PrepareNonContactConstraints </td>
  460. <td>(</td>
  461. <td class="paramtype"><a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a></td> <td class="paramname"><span class="paramname"><em>inNumConstraints</em></span>, </td>
  462. </tr>
  463. <tr>
  464. <td class="paramkey"></td>
  465. <td></td>
  466. <td class="paramtype"><a class="el" href="class_temp_allocator.html">TempAllocator</a> *</td> <td class="paramname"><span class="paramname"><em>inTempAllocator</em></span>&#160;)</td>
  467. </tr>
  468. </table>
  469. </div><div class="memdoc">
  470. <p>Prepare for simulation step by allocating space for the non-contact constraints. </p>
  471. </div>
  472. </div>
  473. <a id="a3a23a4981c11d55933cc2533504eb38a" name="a3a23a4981c11d55933cc2533504eb38a"></a>
  474. <h2 class="memtitle"><span class="permalink"><a href="#a3a23a4981c11d55933cc2533504eb38a">&#9670;&#160;</a></span>ResetIslands()</h2>
  475. <div class="memitem">
  476. <div class="memproto">
  477. <table class="memname">
  478. <tr>
  479. <td class="memname">void IslandBuilder::ResetIslands </td>
  480. <td>(</td>
  481. <td class="paramtype"><a class="el" href="class_temp_allocator.html">TempAllocator</a> *</td> <td class="paramname"><span class="paramname"><em>inTempAllocator</em></span></td><td>)</td>
  482. <td></td>
  483. </tr>
  484. </table>
  485. </div><div class="memdoc">
  486. <p>After you're done calling the three functions above, call this function to free associated data. </p>
  487. </div>
  488. </div>
  489. <a id="a576814bc0405702b74174635e0b44d6d" name="a576814bc0405702b74174635e0b44d6d"></a>
  490. <h2 class="memtitle"><span class="permalink"><a href="#a576814bc0405702b74174635e0b44d6d">&#9670;&#160;</a></span>SetNumPositionSteps()</h2>
  491. <div class="memitem">
  492. <div class="memproto">
  493. <table class="mlabels">
  494. <tr>
  495. <td class="mlabels-left">
  496. <table class="memname">
  497. <tr>
  498. <td class="memname">void IslandBuilder::SetNumPositionSteps </td>
  499. <td>(</td>
  500. <td class="paramtype"><a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a></td> <td class="paramname"><span class="paramname"><em>inIslandIndex</em></span>, </td>
  501. </tr>
  502. <tr>
  503. <td class="paramkey"></td>
  504. <td></td>
  505. <td class="paramtype"><a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a></td> <td class="paramname"><span class="paramname"><em>inNumPositionSteps</em></span>&#160;)</td>
  506. </tr>
  507. </table>
  508. </td>
  509. <td class="mlabels-right">
  510. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  511. </tr>
  512. </table>
  513. </div><div class="memdoc">
  514. <p>The number of position iterations for each island. </p>
  515. </div>
  516. </div>
  517. <hr/>The documentation for this class was generated from the following files:<ul>
  518. <li>Jolt/Physics/<a class="el" href="_island_builder_8h_source.html">IslandBuilder.h</a></li>
  519. <li>Jolt/Physics/<a class="el" href="_island_builder_8cpp.html">IslandBuilder.cpp</a></li>
  520. </ul>
  521. </div><!-- contents -->
  522. </div><!-- doc-content -->
  523. <!-- start footer part -->
  524. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  525. <ul>
  526. <li class="navelem"><a class="el" href="class_island_builder.html">IslandBuilder</a></li>
  527. <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>
  528. </ul>
  529. </div>
  530. </body>
  531. </html>