cpp
/
JoltPhysics
mirror of https://github.com/jrouwe/JoltPhysics.git


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607
							<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.12.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Jolt Physics: LargeIslandSplitter Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="cookie.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
  extensions: ["tex2jax.js"],
  jax: ["input/TeX","output/HTML-CSS"],
});
</script>
<script type="text/javascript" async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectlogo"><img alt="Logo" src="LogoSmall.png"/></td>
  <td id="projectalign">
   <div id="projectname">Jolt Physics
   </div>
   <div id="projectbrief">A multi core friendly Game Physics Engine</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.12.0 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search',true);
  $(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){initNavTree('class_large_island_splitter.html',''); initResizable(true); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

<div class="header">
  <div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-attribs">Static Public Attributes</a> &#124;
<a href="class_large_island_splitter-members.html">List of all members</a>  </div>
  <div class="headertitle"><div class="title">LargeIslandSplitter Class Reference</div></div>
</div><!--header-->
<div class="contents">

<p><code>#include &lt;<a class="el" href="_large_island_splitter_8h_source.html">LargeIslandSplitter.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for LargeIslandSplitter:</div>
<div class="dyncontent">
 <div class="center">
  <img src="class_large_island_splitter.png" usemap="#LargeIslandSplitter_map" alt=""/>
  <map id="LargeIslandSplitter_map" name="LargeIslandSplitter_map">
<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,117,24"/>
  </map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_large_island_splitter_1_1_split.html">Split</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Describes a split of constraints and contacts.  <a href="struct_large_island_splitter_1_1_split.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_large_island_splitter_1_1_splits.html">Splits</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Structure that describes the resulting splits from the large island splitter.  <a href="class_large_island_splitter_1_1_splits.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-types" name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:aa7b284b561bd630d6d288bb706439f68" id="r_aa7b284b561bd630d6d288bb706439f68"><td class="memItemLeft" align="right" valign="top">enum class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aa7b284b561bd630d6d288bb706439f68">EStatus</a> { <a class="el" href="#aa7b284b561bd630d6d288bb706439f68a01811fa00be6bc53249ea970efb0cc9f">WaitingForBatch</a>
, <a class="el" href="#aa7b284b561bd630d6d288bb706439f68a39b684c3a6067a4e201699e906bd4af1">BatchRetrieved</a>
, <a class="el" href="#aa7b284b561bd630d6d288bb706439f68a6d9a123e6f06ce621f7ad5f18f9392c4">AllBatchesDone</a>
 }</td></tr>
<tr class="memdesc:aa7b284b561bd630d6d288bb706439f68"><td class="mdescLeft">&#160;</td><td class="mdescRight">Status code for retrieving a batch.  <a href="#aa7b284b561bd630d6d288bb706439f68">More...</a><br /></td></tr>
<tr class="separator:aa7b284b561bd630d6d288bb706439f68"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a6453331c5fb852bb201b04f14dc9a281" id="r_a6453331c5fb852bb201b04f14dc9a281"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a6453331c5fb852bb201b04f14dc9a281">~LargeIslandSplitter</a> ()</td></tr>
<tr class="memdesc:a6453331c5fb852bb201b04f14dc9a281"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor.  <br /></td></tr>
<tr class="separator:a6453331c5fb852bb201b04f14dc9a281"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6423724ea978d94f3faff78bb5a5965d" id="r_a6423724ea978d94f3faff78bb5a5965d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a6423724ea978d94f3faff78bb5a5965d">Prepare</a> (const <a class="el" href="class_island_builder.html">IslandBuilder</a> &amp;inIslandBuilder, <a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a> inNumActiveBodies, <a class="el" href="class_temp_allocator.html">TempAllocator</a> *inTempAllocator)</td></tr>
<tr class="memdesc:a6423724ea978d94f3faff78bb5a5965d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Prepare the island splitter by allocating memory.  <br /></td></tr>
<tr class="separator:a6423724ea978d94f3faff78bb5a5965d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abdd73c85801b06752d297cf36df1b44f" id="r_abdd73c85801b06752d297cf36df1b44f"><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="#abdd73c85801b06752d297cf36df1b44f">AssignSplit</a> (const <a class="el" href="class_body.html">Body</a> *inBody1, const <a class="el" href="class_body.html">Body</a> *inBody2)</td></tr>
<tr class="memdesc:abdd73c85801b06752d297cf36df1b44f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Assign two bodies to a split. Returns the split index.  <br /></td></tr>
<tr class="separator:abdd73c85801b06752d297cf36df1b44f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1b2ef7ebff94911ee008f25f6c0c741b" id="r_a1b2ef7ebff94911ee008f25f6c0c741b"><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="#a1b2ef7ebff94911ee008f25f6c0c741b">AssignToNonParallelSplit</a> (const <a class="el" href="class_body.html">Body</a> *inBody)</td></tr>
<tr class="memdesc:a1b2ef7ebff94911ee008f25f6c0c741b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Force a body to be in a non parallel split. Returns the split index.  <br /></td></tr>
<tr class="separator:a1b2ef7ebff94911ee008f25f6c0c741b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0e0435f6f000b574ec4e9649400f38cd" id="r_a0e0435f6f000b574ec4e9649400f38cd"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a0e0435f6f000b574ec4e9649400f38cd">SplitIsland</a> (<a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a> inIslandIndex, const <a class="el" href="class_island_builder.html">IslandBuilder</a> &amp;inIslandBuilder, const <a class="el" href="class_body_manager.html">BodyManager</a> &amp;inBodyManager, const <a class="el" href="class_contact_constraint_manager.html">ContactConstraintManager</a> &amp;inContactManager, <a class="el" href="class_constraint.html">Constraint</a> **inActiveConstraints, CalculateSolverSteps &amp;ioStepsCalculator)</td></tr>
<tr class="memdesc:a0e0435f6f000b574ec4e9649400f38cd"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="class_large_island_splitter_1_1_splits.html" title="Structure that describes the resulting splits from the large island splitter.">Splits</a> up an island, the created splits will be added to the list of batches and can be fetched with FetchNextBatch. Returns false if the island did not need splitting.  <br /></td></tr>
<tr class="separator:a0e0435f6f000b574ec4e9649400f38cd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3f35114156b5519b85f82988fe3944b9" id="r_a3f35114156b5519b85f82988fe3944b9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#aa7b284b561bd630d6d288bb706439f68">EStatus</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a3f35114156b5519b85f82988fe3944b9">FetchNextBatch</a> (<a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a> &amp;outSplitIslandIndex, <a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a> *&amp;outConstraintsBegin, <a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a> *&amp;outConstraintsEnd, <a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a> *&amp;outContactsBegin, <a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a> *&amp;outContactsEnd, bool &amp;outFirstIteration)</td></tr>
<tr class="memdesc:a3f35114156b5519b85f82988fe3944b9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Fetch the next batch to process, returns a handle in outSplitIslandIndex that must be provided to MarkBatchProcessed when complete.  <br /></td></tr>
<tr class="separator:a3f35114156b5519b85f82988fe3944b9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2934ec09e8492356eab6360ba6091fb4" id="r_a2934ec09e8492356eab6360ba6091fb4"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a2934ec09e8492356eab6360ba6091fb4">MarkBatchProcessed</a> (<a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a> inSplitIslandIndex, const <a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a> *inConstraintsBegin, const <a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a> *inConstraintsEnd, const <a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a> *inContactsBegin, const <a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a> *inContactsEnd, bool &amp;outLastIteration, bool &amp;outFinalBatch)</td></tr>
<tr class="memdesc:a2934ec09e8492356eab6360ba6091fb4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Mark a batch as processed.  <br /></td></tr>
<tr class="separator:a2934ec09e8492356eab6360ba6091fb4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9c0c434f77d1e58d2fce4fbe9247236e" id="r_a9c0c434f77d1e58d2fce4fbe9247236e"><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="#a9c0c434f77d1e58d2fce4fbe9247236e">GetIslandIndex</a> (<a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a> inSplitIslandIndex) const</td></tr>
<tr class="memdesc:a9c0c434f77d1e58d2fce4fbe9247236e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the island index of the island that was split for a particular split island index.  <br /></td></tr>
<tr class="separator:a9c0c434f77d1e58d2fce4fbe9247236e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acf4099c9cd655a77a1c7331724608d22" id="r_acf4099c9cd655a77a1c7331724608d22"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#acf4099c9cd655a77a1c7331724608d22">PrepareForSolvePositions</a> ()</td></tr>
<tr class="memdesc:acf4099c9cd655a77a1c7331724608d22"><td class="mdescLeft">&#160;</td><td class="mdescRight">Prepare the island splitter for iterating over the split islands again for position solving. Marks all batches as startable.  <br /></td></tr>
<tr class="separator:acf4099c9cd655a77a1c7331724608d22"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac5d0857609c5c1375dd9cd78a5f6148a" id="r_ac5d0857609c5c1375dd9cd78a5f6148a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ac5d0857609c5c1375dd9cd78a5f6148a">Reset</a> (<a class="el" href="class_temp_allocator.html">TempAllocator</a> *inTempAllocator)</td></tr>
<tr class="memdesc:ac5d0857609c5c1375dd9cd78a5f6148a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reset the island splitter.  <br /></td></tr>
<tr class="separator:ac5d0857609c5c1375dd9cd78a5f6148a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<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>
<tr class="separator:a809b6e4ade7ae32f6d248f2a3b783d45 inherit pub_methods_class_non_copyable"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="separator:a501d34ffcc34b30de6d541887a901057 inherit pub_methods_class_non_copyable"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="separator:aaf9b12dcaae80c9d304df7a941d4e21f inherit pub_methods_class_non_copyable"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-attribs" name="pub-static-attribs"></a>
Static Public Attributes</h2></td></tr>
<tr class="memitem:a5280cc4c5d98d6e65f339c7187c7cc80" id="r_a5280cc4c5d98d6e65f339c7187c7cc80"><td class="memItemLeft" align="right" valign="top">static constexpr <a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a5280cc4c5d98d6e65f339c7187c7cc80">cNumSplits</a> = sizeof(SplitMask) * 8</td></tr>
<tr class="separator:a5280cc4c5d98d6e65f339c7187c7cc80"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ada535de30d7ab4bdb2bc630b7b28d81f" id="r_ada535de30d7ab4bdb2bc630b7b28d81f"><td class="memItemLeft" align="right" valign="top">static constexpr <a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ada535de30d7ab4bdb2bc630b7b28d81f">cNonParallelSplitIdx</a> = <a class="el" href="#a5280cc4c5d98d6e65f339c7187c7cc80">cNumSplits</a> - 1</td></tr>
<tr class="separator:ada535de30d7ab4bdb2bc630b7b28d81f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a86a79602d9b93ec4a0c5837465a70b0a" id="r_a86a79602d9b93ec4a0c5837465a70b0a"><td class="memItemLeft" align="right" valign="top">static constexpr <a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a86a79602d9b93ec4a0c5837465a70b0a">cLargeIslandTreshold</a> = 128</td></tr>
<tr class="memdesc:a86a79602d9b93ec4a0c5837465a70b0a"><td class="mdescLeft">&#160;</td><td class="mdescRight">If the number of constraints + contacts in an island is larger than this, we will try to split the island.  <br /></td></tr>
<tr class="separator:a86a79602d9b93ec4a0c5837465a70b0a"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Assigns bodies in large islands to multiple groups that can run in parallel</p>
<p>This basically implements what is described in: High-Performance Physical Simulations on Next-Generation Architecture with Many Cores by Chen et al. See: <a href="http://web.eecs.umich.edu/~msmelyan/papers/physsim_onmanycore_itj.pdf">http://web.eecs.umich.edu/~msmelyan/papers/physsim_onmanycore_itj.pdf</a> section "PARALLELIZATION METHODOLOGY"</p>
<p>WARNING: This class is an internal part of <a class="el" href="class_physics_system.html">PhysicsSystem</a>, it has no functions that can be called by users of the library. </p>
</div><h2 class="groupheader">Member Enumeration Documentation</h2>
<a id="aa7b284b561bd630d6d288bb706439f68" name="aa7b284b561bd630d6d288bb706439f68"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa7b284b561bd630d6d288bb706439f68">&#9670;&#160;</a></span>EStatus</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">enum class <a class="el" href="#aa7b284b561bd630d6d288bb706439f68">LargeIslandSplitter::EStatus</a></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">strong</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Status code for retrieving a batch. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="aa7b284b561bd630d6d288bb706439f68a01811fa00be6bc53249ea970efb0cc9f" name="aa7b284b561bd630d6d288bb706439f68a01811fa00be6bc53249ea970efb0cc9f"></a>WaitingForBatch&#160;</td><td class="fielddoc"><p>Work is expected to be available later. </p>
</td></tr>
<tr><td class="fieldname"><a id="aa7b284b561bd630d6d288bb706439f68a39b684c3a6067a4e201699e906bd4af1" name="aa7b284b561bd630d6d288bb706439f68a39b684c3a6067a4e201699e906bd4af1"></a>BatchRetrieved&#160;</td><td class="fielddoc"><p>Work is being returned. </p>
</td></tr>
<tr><td class="fieldname"><a id="aa7b284b561bd630d6d288bb706439f68a6d9a123e6f06ce621f7ad5f18f9392c4" name="aa7b284b561bd630d6d288bb706439f68a6d9a123e6f06ce621f7ad5f18f9392c4"></a>AllBatchesDone&#160;</td><td class="fielddoc"><p>No further work is expected from this. </p>
</td></tr>
</table>

</div>
</div>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a6453331c5fb852bb201b04f14dc9a281" name="a6453331c5fb852bb201b04f14dc9a281"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6453331c5fb852bb201b04f14dc9a281">&#9670;&#160;</a></span>~LargeIslandSplitter()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">LargeIslandSplitter::~LargeIslandSplitter </td>
          <td>(</td>
          <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Destructor. </p>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="abdd73c85801b06752d297cf36df1b44f" name="abdd73c85801b06752d297cf36df1b44f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abdd73c85801b06752d297cf36df1b44f">&#9670;&#160;</a></span>AssignSplit()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a> LargeIslandSplitter::AssignSplit </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="class_body.html">Body</a> *</td>          <td class="paramname"><span class="paramname"><em>inBody1</em></span>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="class_body.html">Body</a> *</td>          <td class="paramname"><span class="paramname"><em>inBody2</em></span>&#160;)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Assign two bodies to a split. Returns the split index. </p>

</div>
</div>
<a id="a1b2ef7ebff94911ee008f25f6c0c741b" name="a1b2ef7ebff94911ee008f25f6c0c741b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1b2ef7ebff94911ee008f25f6c0c741b">&#9670;&#160;</a></span>AssignToNonParallelSplit()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a> LargeIslandSplitter::AssignToNonParallelSplit </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="class_body.html">Body</a> *</td>          <td class="paramname"><span class="paramname"><em>inBody</em></span></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Force a body to be in a non parallel split. Returns the split index. </p>

</div>
</div>
<a id="a3f35114156b5519b85f82988fe3944b9" name="a3f35114156b5519b85f82988fe3944b9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3f35114156b5519b85f82988fe3944b9">&#9670;&#160;</a></span>FetchNextBatch()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="#aa7b284b561bd630d6d288bb706439f68">LargeIslandSplitter::EStatus</a> LargeIslandSplitter::FetchNextBatch </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a> &amp;</td>          <td class="paramname"><span class="paramname"><em>outSplitIslandIndex</em></span>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <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>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <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>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <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>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <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>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool &amp;</td>          <td class="paramname"><span class="paramname"><em>outFirstIteration</em></span>&#160;)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Fetch the next batch to process, returns a handle in outSplitIslandIndex that must be provided to MarkBatchProcessed when complete. </p>

</div>
</div>
<a id="a9c0c434f77d1e58d2fce4fbe9247236e" name="a9c0c434f77d1e58d2fce4fbe9247236e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9c0c434f77d1e58d2fce4fbe9247236e">&#9670;&#160;</a></span>GetIslandIndex()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a> LargeIslandSplitter::GetIslandIndex </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a></td>          <td class="paramname"><span class="paramname"><em>inSplitIslandIndex</em></span></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Get the island index of the island that was split for a particular split island index. </p>

</div>
</div>
<a id="a2934ec09e8492356eab6360ba6091fb4" name="a2934ec09e8492356eab6360ba6091fb4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2934ec09e8492356eab6360ba6091fb4">&#9670;&#160;</a></span>MarkBatchProcessed()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void LargeIslandSplitter::MarkBatchProcessed </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a></td>          <td class="paramname"><span class="paramname"><em>inSplitIslandIndex</em></span>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a> *</td>          <td class="paramname"><span class="paramname"><em>inConstraintsBegin</em></span>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a> *</td>          <td class="paramname"><span class="paramname"><em>inConstraintsEnd</em></span>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a> *</td>          <td class="paramname"><span class="paramname"><em>inContactsBegin</em></span>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a> *</td>          <td class="paramname"><span class="paramname"><em>inContactsEnd</em></span>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool &amp;</td>          <td class="paramname"><span class="paramname"><em>outLastIteration</em></span>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool &amp;</td>          <td class="paramname"><span class="paramname"><em>outFinalBatch</em></span>&#160;)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Mark a batch as processed. </p>

</div>
</div>
<a id="a6423724ea978d94f3faff78bb5a5965d" name="a6423724ea978d94f3faff78bb5a5965d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6423724ea978d94f3faff78bb5a5965d">&#9670;&#160;</a></span>Prepare()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void LargeIslandSplitter::Prepare </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="class_island_builder.html">IslandBuilder</a> &amp;</td>          <td class="paramname"><span class="paramname"><em>inIslandBuilder</em></span>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <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>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <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>
        </tr>
      </table>
</div><div class="memdoc">

<p>Prepare the island splitter by allocating memory. </p>

</div>
</div>
<a id="acf4099c9cd655a77a1c7331724608d22" name="acf4099c9cd655a77a1c7331724608d22"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acf4099c9cd655a77a1c7331724608d22">&#9670;&#160;</a></span>PrepareForSolvePositions()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void LargeIslandSplitter::PrepareForSolvePositions </td>
          <td>(</td>
          <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Prepare the island splitter for iterating over the split islands again for position solving. Marks all batches as startable. </p>

</div>
</div>
<a id="ac5d0857609c5c1375dd9cd78a5f6148a" name="ac5d0857609c5c1375dd9cd78a5f6148a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac5d0857609c5c1375dd9cd78a5f6148a">&#9670;&#160;</a></span>Reset()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void LargeIslandSplitter::Reset </td>
          <td>(</td>
          <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>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Reset the island splitter. </p>

</div>
</div>
<a id="a0e0435f6f000b574ec4e9649400f38cd" name="a0e0435f6f000b574ec4e9649400f38cd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0e0435f6f000b574ec4e9649400f38cd">&#9670;&#160;</a></span>SplitIsland()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool LargeIslandSplitter::SplitIsland </td>
          <td>(</td>
          <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>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="class_island_builder.html">IslandBuilder</a> &amp;</td>          <td class="paramname"><span class="paramname"><em>inIslandBuilder</em></span>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="class_body_manager.html">BodyManager</a> &amp;</td>          <td class="paramname"><span class="paramname"><em>inBodyManager</em></span>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="class_contact_constraint_manager.html">ContactConstraintManager</a> &amp;</td>          <td class="paramname"><span class="paramname"><em>inContactManager</em></span>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="class_constraint.html">Constraint</a> **</td>          <td class="paramname"><span class="paramname"><em>inActiveConstraints</em></span>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">CalculateSolverSteps &amp;</td>          <td class="paramname"><span class="paramname"><em>ioStepsCalculator</em></span>&#160;)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><a class="el" href="class_large_island_splitter_1_1_splits.html" title="Structure that describes the resulting splits from the large island splitter.">Splits</a> up an island, the created splits will be added to the list of batches and can be fetched with FetchNextBatch. Returns false if the island did not need splitting. </p>

</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a86a79602d9b93ec4a0c5837465a70b0a" name="a86a79602d9b93ec4a0c5837465a70b0a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a86a79602d9b93ec4a0c5837465a70b0a">&#9670;&#160;</a></span>cLargeIslandTreshold</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a> LargeIslandSplitter::cLargeIslandTreshold = 128</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">constexpr</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>If the number of constraints + contacts in an island is larger than this, we will try to split the island. </p>

</div>
</div>
<a id="ada535de30d7ab4bdb2bc630b7b28d81f" name="ada535de30d7ab4bdb2bc630b7b28d81f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ada535de30d7ab4bdb2bc630b7b28d81f">&#9670;&#160;</a></span>cNonParallelSplitIdx</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a> LargeIslandSplitter::cNonParallelSplitIdx = <a class="el" href="#a5280cc4c5d98d6e65f339c7187c7cc80">cNumSplits</a> - 1</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">constexpr</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<a id="a5280cc4c5d98d6e65f339c7187c7cc80" name="a5280cc4c5d98d6e65f339c7187c7cc80"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5280cc4c5d98d6e65f339c7187c7cc80">&#9670;&#160;</a></span>cNumSplits</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a> LargeIslandSplitter::cNumSplits = sizeof(SplitMask) * 8</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">constexpr</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>Jolt/Physics/<a class="el" href="_large_island_splitter_8h_source.html">LargeIslandSplitter.h</a></li>
<li>Jolt/Physics/<a class="el" href="_large_island_splitter_8cpp.html">LargeIslandSplitter.cpp</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="class_large_island_splitter.html">LargeIslandSplitter</a></li>
    <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>
  </ul>
</div>
</body>
</html>