class_a_a_b_b_tree_builder_1_1_node.html 35 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580
  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: AABBTreeBuilder::Node 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_a_a_b_b_tree_builder_1_1_node.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="#pub-static-attribs">Static Public Attributes</a> &#124;
  110. <a href="#friends">Friends</a> &#124;
  111. <a href="class_a_a_b_b_tree_builder_1_1_node-members.html">List of all members</a> </div>
  112. <div class="headertitle"><div class="title">AABBTreeBuilder::Node Class Reference</div></div>
  113. </div><!--header-->
  114. <div class="contents">
  115. <p>A node in the tree, contains the <a class="el" href="class_a_a_box.html" title="Axis aligned box.">AABox</a> for the tree and any child nodes or triangles.
  116. <a href="#details">More...</a></p>
  117. <p><code>#include &lt;<a class="el" href="_a_a_b_b_tree_builder_8h_source.html">AABBTreeBuilder.h</a>&gt;</code></p>
  118. <table class="memberdecls">
  119. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
  120. Public Member Functions</h2></td></tr>
  121. <tr class="memitem:ab9f14f78dc59d08126ca910121c173e0" id="r_ab9f14f78dc59d08126ca910121c173e0"><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="#ab9f14f78dc59d08126ca910121c173e0">GetTriangleCount</a> () const</td></tr>
  122. <tr class="memdesc:ab9f14f78dc59d08126ca910121c173e0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get number of triangles in this node. <br /></td></tr>
  123. <tr class="separator:ab9f14f78dc59d08126ca910121c173e0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  124. <tr class="memitem:ae10ed18604852aa130a4770fe72c9240" id="r_ae10ed18604852aa130a4770fe72c9240"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ae10ed18604852aa130a4770fe72c9240">HasChildren</a> () const</td></tr>
  125. <tr class="memdesc:ae10ed18604852aa130a4770fe72c9240"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if this node has any children. <br /></td></tr>
  126. <tr class="separator:ae10ed18604852aa130a4770fe72c9240"><td class="memSeparator" colspan="2">&#160;</td></tr>
  127. <tr class="memitem:ae5ae39e12dc3d0b500fd75ae9c478c73" id="r_ae5ae39e12dc3d0b500fd75ae9c478c73"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="class_a_a_b_b_tree_builder_1_1_node.html">Node</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ae5ae39e12dc3d0b500fd75ae9c478c73">GetChild</a> (<a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a> inIdx, const <a class="el" href="class_array.html">Array</a>&lt; <a class="el" href="class_a_a_b_b_tree_builder_1_1_node.html">Node</a> &gt; &amp;inNodes) const</td></tr>
  128. <tr class="memdesc:ae5ae39e12dc3d0b500fd75ae9c478c73"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get child node. <br /></td></tr>
  129. <tr class="separator:ae5ae39e12dc3d0b500fd75ae9c478c73"><td class="memSeparator" colspan="2">&#160;</td></tr>
  130. <tr class="memitem:afbab1987d7190726347767cec6377dff" id="r_afbab1987d7190726347767cec6377dff"><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="#afbab1987d7190726347767cec6377dff">GetMinDepth</a> (const <a class="el" href="class_array.html">Array</a>&lt; <a class="el" href="class_a_a_b_b_tree_builder_1_1_node.html">Node</a> &gt; &amp;inNodes) const</td></tr>
  131. <tr class="memdesc:afbab1987d7190726347767cec6377dff"><td class="mdescLeft">&#160;</td><td class="mdescRight">Min depth of tree. <br /></td></tr>
  132. <tr class="separator:afbab1987d7190726347767cec6377dff"><td class="memSeparator" colspan="2">&#160;</td></tr>
  133. <tr class="memitem:a77cd52e5274427820f93887aec1212d2" id="r_a77cd52e5274427820f93887aec1212d2"><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="#a77cd52e5274427820f93887aec1212d2">GetMaxDepth</a> (const <a class="el" href="class_array.html">Array</a>&lt; <a class="el" href="class_a_a_b_b_tree_builder_1_1_node.html">Node</a> &gt; &amp;inNodes) const</td></tr>
  134. <tr class="memdesc:a77cd52e5274427820f93887aec1212d2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Max depth of tree. <br /></td></tr>
  135. <tr class="separator:a77cd52e5274427820f93887aec1212d2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  136. <tr class="memitem:aa3b24418feec3d41613d57fa5868953e" id="r_aa3b24418feec3d41613d57fa5868953e"><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="#aa3b24418feec3d41613d57fa5868953e">GetNodeCount</a> (const <a class="el" href="class_array.html">Array</a>&lt; <a class="el" href="class_a_a_b_b_tree_builder_1_1_node.html">Node</a> &gt; &amp;inNodes) const</td></tr>
  137. <tr class="memdesc:aa3b24418feec3d41613d57fa5868953e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Number of nodes in tree. <br /></td></tr>
  138. <tr class="separator:aa3b24418feec3d41613d57fa5868953e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  139. <tr class="memitem:a798df3d3fcd597f653ab660897aa6fd2" id="r_a798df3d3fcd597f653ab660897aa6fd2"><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="#a798df3d3fcd597f653ab660897aa6fd2">GetLeafNodeCount</a> (const <a class="el" href="class_array.html">Array</a>&lt; <a class="el" href="class_a_a_b_b_tree_builder_1_1_node.html">Node</a> &gt; &amp;inNodes) const</td></tr>
  140. <tr class="memdesc:a798df3d3fcd597f653ab660897aa6fd2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Number of leaf nodes in tree. <br /></td></tr>
  141. <tr class="separator:a798df3d3fcd597f653ab660897aa6fd2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  142. <tr class="memitem:a70279979794f6d2beb9812c970ebf0f0" id="r_a70279979794f6d2beb9812c970ebf0f0"><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="#a70279979794f6d2beb9812c970ebf0f0">GetTriangleCountInTree</a> (const <a class="el" href="class_array.html">Array</a>&lt; <a class="el" href="class_a_a_b_b_tree_builder_1_1_node.html">Node</a> &gt; &amp;inNodes) const</td></tr>
  143. <tr class="memdesc:a70279979794f6d2beb9812c970ebf0f0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get triangle count in tree. <br /></td></tr>
  144. <tr class="separator:a70279979794f6d2beb9812c970ebf0f0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  145. <tr class="memitem:ac35b06c2738bc8d3eaa2d5ec1c5d3409" id="r_ac35b06c2738bc8d3eaa2d5ec1c5d3409"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ac35b06c2738bc8d3eaa2d5ec1c5d3409">GetTriangleCountPerNode</a> (const <a class="el" href="class_array.html">Array</a>&lt; <a class="el" href="class_a_a_b_b_tree_builder_1_1_node.html">Node</a> &gt; &amp;inNodes, float &amp;outAverage, <a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a> &amp;outMin, <a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a> &amp;outMax) const</td></tr>
  146. <tr class="memdesc:ac35b06c2738bc8d3eaa2d5ec1c5d3409"><td class="mdescLeft">&#160;</td><td class="mdescRight">Calculate min and max triangles per node. <br /></td></tr>
  147. <tr class="separator:ac35b06c2738bc8d3eaa2d5ec1c5d3409"><td class="memSeparator" colspan="2">&#160;</td></tr>
  148. <tr class="memitem:ad2cfaf6317f8a85ffa234ec8014a1328" id="r_ad2cfaf6317f8a85ffa234ec8014a1328"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ad2cfaf6317f8a85ffa234ec8014a1328">CalculateSAHCost</a> (const <a class="el" href="class_array.html">Array</a>&lt; <a class="el" href="class_a_a_b_b_tree_builder_1_1_node.html">Node</a> &gt; &amp;inNodes, float inCostTraversal, float inCostLeaf) const</td></tr>
  149. <tr class="memdesc:ad2cfaf6317f8a85ffa234ec8014a1328"><td class="mdescLeft">&#160;</td><td class="mdescRight">Calculate the total cost of the tree using the surface area heuristic. <br /></td></tr>
  150. <tr class="separator:ad2cfaf6317f8a85ffa234ec8014a1328"><td class="memSeparator" colspan="2">&#160;</td></tr>
  151. <tr class="memitem:ab8fcaadbe92d6b806a4d1cd0a64747e3" id="r_ab8fcaadbe92d6b806a4d1cd0a64747e3"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ab8fcaadbe92d6b806a4d1cd0a64747e3">GetNChildren</a> (const <a class="el" href="class_array.html">Array</a>&lt; <a class="el" href="class_a_a_b_b_tree_builder_1_1_node.html">Node</a> &gt; &amp;inNodes, <a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a> inN, <a class="el" href="class_array.html">Array</a>&lt; const <a class="el" href="class_a_a_b_b_tree_builder_1_1_node.html">Node</a> * &gt; &amp;outChildren) const</td></tr>
  152. <tr class="memdesc:ab8fcaadbe92d6b806a4d1cd0a64747e3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Recursively get children (breadth first) to get in total inN children (or less if there are no more) <br /></td></tr>
  153. <tr class="separator:ab8fcaadbe92d6b806a4d1cd0a64747e3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  154. </table><table class="memberdecls">
  155. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
  156. Public Attributes</h2></td></tr>
  157. <tr class="memitem:a4549ed8b447ff95b86f267118f229f49" id="r_a4549ed8b447ff95b86f267118f229f49"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_a_a_box.html">AABox</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a4549ed8b447ff95b86f267118f229f49">mBounds</a></td></tr>
  158. <tr class="memdesc:a4549ed8b447ff95b86f267118f229f49"><td class="mdescLeft">&#160;</td><td class="mdescRight">Bounding box. <br /></td></tr>
  159. <tr class="separator:a4549ed8b447ff95b86f267118f229f49"><td class="memSeparator" colspan="2">&#160;</td></tr>
  160. <tr class="memitem:a0c1859c01298bbe7a61fca6ba80c3f8b" id="r_a0c1859c01298bbe7a61fca6ba80c3f8b"><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="#a0c1859c01298bbe7a61fca6ba80c3f8b">mTrianglesBegin</a></td></tr>
  161. <tr class="memdesc:a0c1859c01298bbe7a61fca6ba80c3f8b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Triangles (if no child nodes) <br /></td></tr>
  162. <tr class="separator:a0c1859c01298bbe7a61fca6ba80c3f8b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  163. <tr class="memitem:a681a1cab13cf6b265bfdbcd345114f35" id="r_a681a1cab13cf6b265bfdbcd345114f35"><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="#a681a1cab13cf6b265bfdbcd345114f35">mNumTriangles</a> = 0</td></tr>
  164. <tr class="separator:a681a1cab13cf6b265bfdbcd345114f35"><td class="memSeparator" colspan="2">&#160;</td></tr>
  165. <tr class="memitem:a3b2733be6148d0bcb3cc07302ae10516" id="r_a3b2733be6148d0bcb3cc07302ae10516"><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="#a3b2733be6148d0bcb3cc07302ae10516">mChild</a> [2] = { <a class="el" href="#a5473a1105433005850b46881180c04b0">cInvalidNodeIndex</a>, <a class="el" href="#a5473a1105433005850b46881180c04b0">cInvalidNodeIndex</a> }</td></tr>
  166. <tr class="memdesc:a3b2733be6148d0bcb3cc07302ae10516"><td class="mdescLeft">&#160;</td><td class="mdescRight">Child node indices (if no triangles) <br /></td></tr>
  167. <tr class="separator:a3b2733be6148d0bcb3cc07302ae10516"><td class="memSeparator" colspan="2">&#160;</td></tr>
  168. </table><table class="memberdecls">
  169. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-attribs" name="pub-static-attribs"></a>
  170. Static Public Attributes</h2></td></tr>
  171. <tr class="memitem:a5473a1105433005850b46881180c04b0" id="r_a5473a1105433005850b46881180c04b0"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="_memory_8h.html#a91074fb218fe28954a0938c099ddd9e0">JPH_OVERRIDE_NEW_DELETE</a> constexpr <a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a5473a1105433005850b46881180c04b0">cInvalidNodeIndex</a> = ~<a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a>(0)</td></tr>
  172. <tr class="memdesc:a5473a1105433005850b46881180c04b0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Indicates that there is no child. <br /></td></tr>
  173. <tr class="separator:a5473a1105433005850b46881180c04b0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  174. </table><table class="memberdecls">
  175. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="friends" name="friends"></a>
  176. Friends</h2></td></tr>
  177. <tr class="memitem:a27094b8ce6a5cd4a6edb184d2ae9b302" id="r_a27094b8ce6a5cd4a6edb184d2ae9b302"><td class="memItemLeft" align="right" valign="top">class&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a27094b8ce6a5cd4a6edb184d2ae9b302">AABBTreeBuilder</a></td></tr>
  178. <tr class="separator:a27094b8ce6a5cd4a6edb184d2ae9b302"><td class="memSeparator" colspan="2">&#160;</td></tr>
  179. </table>
  180. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  181. <div class="textblock"><p>A node in the tree, contains the <a class="el" href="class_a_a_box.html" title="Axis aligned box.">AABox</a> for the tree and any child nodes or triangles. </p>
  182. </div><h2 class="groupheader">Member Function Documentation</h2>
  183. <a id="ad2cfaf6317f8a85ffa234ec8014a1328" name="ad2cfaf6317f8a85ffa234ec8014a1328"></a>
  184. <h2 class="memtitle"><span class="permalink"><a href="#ad2cfaf6317f8a85ffa234ec8014a1328">&#9670;&#160;</a></span>CalculateSAHCost()</h2>
  185. <div class="memitem">
  186. <div class="memproto">
  187. <table class="memname">
  188. <tr>
  189. <td class="memname">float AABBTreeBuilder::Node::CalculateSAHCost </td>
  190. <td>(</td>
  191. <td class="paramtype">const <a class="el" href="class_array.html">Array</a>&lt; <a class="el" href="class_a_a_b_b_tree_builder_1_1_node.html">Node</a> &gt; &amp;</td> <td class="paramname"><span class="paramname"><em>inNodes</em></span>, </td>
  192. </tr>
  193. <tr>
  194. <td class="paramkey"></td>
  195. <td></td>
  196. <td class="paramtype">float</td> <td class="paramname"><span class="paramname"><em>inCostTraversal</em></span>, </td>
  197. </tr>
  198. <tr>
  199. <td class="paramkey"></td>
  200. <td></td>
  201. <td class="paramtype">float</td> <td class="paramname"><span class="paramname"><em>inCostLeaf</em></span>&#160;) const</td>
  202. </tr>
  203. </table>
  204. </div><div class="memdoc">
  205. <p>Calculate the total cost of the tree using the surface area heuristic. </p>
  206. </div>
  207. </div>
  208. <a id="ae5ae39e12dc3d0b500fd75ae9c478c73" name="ae5ae39e12dc3d0b500fd75ae9c478c73"></a>
  209. <h2 class="memtitle"><span class="permalink"><a href="#ae5ae39e12dc3d0b500fd75ae9c478c73">&#9670;&#160;</a></span>GetChild()</h2>
  210. <div class="memitem">
  211. <div class="memproto">
  212. <table class="mlabels">
  213. <tr>
  214. <td class="mlabels-left">
  215. <table class="memname">
  216. <tr>
  217. <td class="memname">const <a class="el" href="class_a_a_b_b_tree_builder_1_1_node.html">Node</a> * AABBTreeBuilder::Node::GetChild </td>
  218. <td>(</td>
  219. <td class="paramtype"><a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a></td> <td class="paramname"><span class="paramname"><em>inIdx</em></span>, </td>
  220. </tr>
  221. <tr>
  222. <td class="paramkey"></td>
  223. <td></td>
  224. <td class="paramtype">const <a class="el" href="class_array.html">Array</a>&lt; <a class="el" href="class_a_a_b_b_tree_builder_1_1_node.html">Node</a> &gt; &amp;</td> <td class="paramname"><span class="paramname"><em>inNodes</em></span>&#160;) const</td>
  225. </tr>
  226. </table>
  227. </td>
  228. <td class="mlabels-right">
  229. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  230. </tr>
  231. </table>
  232. </div><div class="memdoc">
  233. <p>Get child node. </p>
  234. </div>
  235. </div>
  236. <a id="a798df3d3fcd597f653ab660897aa6fd2" name="a798df3d3fcd597f653ab660897aa6fd2"></a>
  237. <h2 class="memtitle"><span class="permalink"><a href="#a798df3d3fcd597f653ab660897aa6fd2">&#9670;&#160;</a></span>GetLeafNodeCount()</h2>
  238. <div class="memitem">
  239. <div class="memproto">
  240. <table class="memname">
  241. <tr>
  242. <td class="memname"><a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a> AABBTreeBuilder::Node::GetLeafNodeCount </td>
  243. <td>(</td>
  244. <td class="paramtype">const <a class="el" href="class_array.html">Array</a>&lt; <a class="el" href="class_a_a_b_b_tree_builder_1_1_node.html">Node</a> &gt; &amp;</td> <td class="paramname"><span class="paramname"><em>inNodes</em></span></td><td>)</td>
  245. <td> const</td>
  246. </tr>
  247. </table>
  248. </div><div class="memdoc">
  249. <p>Number of leaf nodes in tree. </p>
  250. </div>
  251. </div>
  252. <a id="a77cd52e5274427820f93887aec1212d2" name="a77cd52e5274427820f93887aec1212d2"></a>
  253. <h2 class="memtitle"><span class="permalink"><a href="#a77cd52e5274427820f93887aec1212d2">&#9670;&#160;</a></span>GetMaxDepth()</h2>
  254. <div class="memitem">
  255. <div class="memproto">
  256. <table class="memname">
  257. <tr>
  258. <td class="memname"><a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a> AABBTreeBuilder::Node::GetMaxDepth </td>
  259. <td>(</td>
  260. <td class="paramtype">const <a class="el" href="class_array.html">Array</a>&lt; <a class="el" href="class_a_a_b_b_tree_builder_1_1_node.html">Node</a> &gt; &amp;</td> <td class="paramname"><span class="paramname"><em>inNodes</em></span></td><td>)</td>
  261. <td> const</td>
  262. </tr>
  263. </table>
  264. </div><div class="memdoc">
  265. <p>Max depth of tree. </p>
  266. </div>
  267. </div>
  268. <a id="afbab1987d7190726347767cec6377dff" name="afbab1987d7190726347767cec6377dff"></a>
  269. <h2 class="memtitle"><span class="permalink"><a href="#afbab1987d7190726347767cec6377dff">&#9670;&#160;</a></span>GetMinDepth()</h2>
  270. <div class="memitem">
  271. <div class="memproto">
  272. <table class="memname">
  273. <tr>
  274. <td class="memname"><a class="el" href="_core_8h.html#ad14098b68b8c44ea6112601031268405">JPH_NAMESPACE_BEGIN</a> <a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a> AABBTreeBuilder::Node::GetMinDepth </td>
  275. <td>(</td>
  276. <td class="paramtype">const <a class="el" href="class_array.html">Array</a>&lt; <a class="el" href="class_a_a_b_b_tree_builder_1_1_node.html">Node</a> &gt; &amp;</td> <td class="paramname"><span class="paramname"><em>inNodes</em></span></td><td>)</td>
  277. <td> const</td>
  278. </tr>
  279. </table>
  280. </div><div class="memdoc">
  281. <p>Min depth of tree. </p>
  282. </div>
  283. </div>
  284. <a id="ab8fcaadbe92d6b806a4d1cd0a64747e3" name="ab8fcaadbe92d6b806a4d1cd0a64747e3"></a>
  285. <h2 class="memtitle"><span class="permalink"><a href="#ab8fcaadbe92d6b806a4d1cd0a64747e3">&#9670;&#160;</a></span>GetNChildren()</h2>
  286. <div class="memitem">
  287. <div class="memproto">
  288. <table class="memname">
  289. <tr>
  290. <td class="memname">void AABBTreeBuilder::Node::GetNChildren </td>
  291. <td>(</td>
  292. <td class="paramtype">const <a class="el" href="class_array.html">Array</a>&lt; <a class="el" href="class_a_a_b_b_tree_builder_1_1_node.html">Node</a> &gt; &amp;</td> <td class="paramname"><span class="paramname"><em>inNodes</em></span>, </td>
  293. </tr>
  294. <tr>
  295. <td class="paramkey"></td>
  296. <td></td>
  297. <td class="paramtype"><a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a></td> <td class="paramname"><span class="paramname"><em>inN</em></span>, </td>
  298. </tr>
  299. <tr>
  300. <td class="paramkey"></td>
  301. <td></td>
  302. <td class="paramtype"><a class="el" href="class_array.html">Array</a>&lt; const <a class="el" href="class_a_a_b_b_tree_builder_1_1_node.html">Node</a> * &gt; &amp;</td> <td class="paramname"><span class="paramname"><em>outChildren</em></span>&#160;) const</td>
  303. </tr>
  304. </table>
  305. </div><div class="memdoc">
  306. <p>Recursively get children (breadth first) to get in total inN children (or less if there are no more) </p>
  307. </div>
  308. </div>
  309. <a id="aa3b24418feec3d41613d57fa5868953e" name="aa3b24418feec3d41613d57fa5868953e"></a>
  310. <h2 class="memtitle"><span class="permalink"><a href="#aa3b24418feec3d41613d57fa5868953e">&#9670;&#160;</a></span>GetNodeCount()</h2>
  311. <div class="memitem">
  312. <div class="memproto">
  313. <table class="memname">
  314. <tr>
  315. <td class="memname"><a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a> AABBTreeBuilder::Node::GetNodeCount </td>
  316. <td>(</td>
  317. <td class="paramtype">const <a class="el" href="class_array.html">Array</a>&lt; <a class="el" href="class_a_a_b_b_tree_builder_1_1_node.html">Node</a> &gt; &amp;</td> <td class="paramname"><span class="paramname"><em>inNodes</em></span></td><td>)</td>
  318. <td> const</td>
  319. </tr>
  320. </table>
  321. </div><div class="memdoc">
  322. <p>Number of nodes in tree. </p>
  323. </div>
  324. </div>
  325. <a id="ab9f14f78dc59d08126ca910121c173e0" name="ab9f14f78dc59d08126ca910121c173e0"></a>
  326. <h2 class="memtitle"><span class="permalink"><a href="#ab9f14f78dc59d08126ca910121c173e0">&#9670;&#160;</a></span>GetTriangleCount()</h2>
  327. <div class="memitem">
  328. <div class="memproto">
  329. <table class="mlabels">
  330. <tr>
  331. <td class="mlabels-left">
  332. <table class="memname">
  333. <tr>
  334. <td class="memname"><a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a> AABBTreeBuilder::Node::GetTriangleCount </td>
  335. <td>(</td>
  336. <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  337. <td> const</td>
  338. </tr>
  339. </table>
  340. </td>
  341. <td class="mlabels-right">
  342. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  343. </tr>
  344. </table>
  345. </div><div class="memdoc">
  346. <p>Get number of triangles in this node. </p>
  347. </div>
  348. </div>
  349. <a id="a70279979794f6d2beb9812c970ebf0f0" name="a70279979794f6d2beb9812c970ebf0f0"></a>
  350. <h2 class="memtitle"><span class="permalink"><a href="#a70279979794f6d2beb9812c970ebf0f0">&#9670;&#160;</a></span>GetTriangleCountInTree()</h2>
  351. <div class="memitem">
  352. <div class="memproto">
  353. <table class="memname">
  354. <tr>
  355. <td class="memname"><a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a> AABBTreeBuilder::Node::GetTriangleCountInTree </td>
  356. <td>(</td>
  357. <td class="paramtype">const <a class="el" href="class_array.html">Array</a>&lt; <a class="el" href="class_a_a_b_b_tree_builder_1_1_node.html">Node</a> &gt; &amp;</td> <td class="paramname"><span class="paramname"><em>inNodes</em></span></td><td>)</td>
  358. <td> const</td>
  359. </tr>
  360. </table>
  361. </div><div class="memdoc">
  362. <p>Get triangle count in tree. </p>
  363. </div>
  364. </div>
  365. <a id="ac35b06c2738bc8d3eaa2d5ec1c5d3409" name="ac35b06c2738bc8d3eaa2d5ec1c5d3409"></a>
  366. <h2 class="memtitle"><span class="permalink"><a href="#ac35b06c2738bc8d3eaa2d5ec1c5d3409">&#9670;&#160;</a></span>GetTriangleCountPerNode()</h2>
  367. <div class="memitem">
  368. <div class="memproto">
  369. <table class="memname">
  370. <tr>
  371. <td class="memname">void AABBTreeBuilder::Node::GetTriangleCountPerNode </td>
  372. <td>(</td>
  373. <td class="paramtype">const <a class="el" href="class_array.html">Array</a>&lt; <a class="el" href="class_a_a_b_b_tree_builder_1_1_node.html">Node</a> &gt; &amp;</td> <td class="paramname"><span class="paramname"><em>inNodes</em></span>, </td>
  374. </tr>
  375. <tr>
  376. <td class="paramkey"></td>
  377. <td></td>
  378. <td class="paramtype">float &amp;</td> <td class="paramname"><span class="paramname"><em>outAverage</em></span>, </td>
  379. </tr>
  380. <tr>
  381. <td class="paramkey"></td>
  382. <td></td>
  383. <td class="paramtype"><a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a> &amp;</td> <td class="paramname"><span class="paramname"><em>outMin</em></span>, </td>
  384. </tr>
  385. <tr>
  386. <td class="paramkey"></td>
  387. <td></td>
  388. <td class="paramtype"><a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a> &amp;</td> <td class="paramname"><span class="paramname"><em>outMax</em></span>&#160;) const</td>
  389. </tr>
  390. </table>
  391. </div><div class="memdoc">
  392. <p>Calculate min and max triangles per node. </p>
  393. </div>
  394. </div>
  395. <a id="ae10ed18604852aa130a4770fe72c9240" name="ae10ed18604852aa130a4770fe72c9240"></a>
  396. <h2 class="memtitle"><span class="permalink"><a href="#ae10ed18604852aa130a4770fe72c9240">&#9670;&#160;</a></span>HasChildren()</h2>
  397. <div class="memitem">
  398. <div class="memproto">
  399. <table class="mlabels">
  400. <tr>
  401. <td class="mlabels-left">
  402. <table class="memname">
  403. <tr>
  404. <td class="memname">bool AABBTreeBuilder::Node::HasChildren </td>
  405. <td>(</td>
  406. <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  407. <td> const</td>
  408. </tr>
  409. </table>
  410. </td>
  411. <td class="mlabels-right">
  412. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  413. </tr>
  414. </table>
  415. </div><div class="memdoc">
  416. <p>Check if this node has any children. </p>
  417. </div>
  418. </div>
  419. <h2 class="groupheader">Friends And Related Symbol Documentation</h2>
  420. <a id="a27094b8ce6a5cd4a6edb184d2ae9b302" name="a27094b8ce6a5cd4a6edb184d2ae9b302"></a>
  421. <h2 class="memtitle"><span class="permalink"><a href="#a27094b8ce6a5cd4a6edb184d2ae9b302">&#9670;&#160;</a></span>AABBTreeBuilder</h2>
  422. <div class="memitem">
  423. <div class="memproto">
  424. <table class="mlabels">
  425. <tr>
  426. <td class="mlabels-left">
  427. <table class="memname">
  428. <tr>
  429. <td class="memname">friend class <a class="el" href="class_a_a_b_b_tree_builder.html">AABBTreeBuilder</a></td>
  430. </tr>
  431. </table>
  432. </td>
  433. <td class="mlabels-right">
  434. <span class="mlabels"><span class="mlabel">friend</span></span> </td>
  435. </tr>
  436. </table>
  437. </div><div class="memdoc">
  438. </div>
  439. </div>
  440. <h2 class="groupheader">Member Data Documentation</h2>
  441. <a id="a5473a1105433005850b46881180c04b0" name="a5473a1105433005850b46881180c04b0"></a>
  442. <h2 class="memtitle"><span class="permalink"><a href="#a5473a1105433005850b46881180c04b0">&#9670;&#160;</a></span>cInvalidNodeIndex</h2>
  443. <div class="memitem">
  444. <div class="memproto">
  445. <table class="mlabels">
  446. <tr>
  447. <td class="mlabels-left">
  448. <table class="memname">
  449. <tr>
  450. <td class="memname"><a class="el" href="_memory_8h.html#a91074fb218fe28954a0938c099ddd9e0">JPH_OVERRIDE_NEW_DELETE</a> constexpr <a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a> AABBTreeBuilder::Node::cInvalidNodeIndex = ~<a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a>(0)</td>
  451. </tr>
  452. </table>
  453. </td>
  454. <td class="mlabels-right">
  455. <span class="mlabels"><span class="mlabel">static</span><span class="mlabel">constexpr</span></span> </td>
  456. </tr>
  457. </table>
  458. </div><div class="memdoc">
  459. <p>Indicates that there is no child. </p>
  460. </div>
  461. </div>
  462. <a id="a4549ed8b447ff95b86f267118f229f49" name="a4549ed8b447ff95b86f267118f229f49"></a>
  463. <h2 class="memtitle"><span class="permalink"><a href="#a4549ed8b447ff95b86f267118f229f49">&#9670;&#160;</a></span>mBounds</h2>
  464. <div class="memitem">
  465. <div class="memproto">
  466. <table class="memname">
  467. <tr>
  468. <td class="memname"><a class="el" href="class_a_a_box.html">AABox</a> AABBTreeBuilder::Node::mBounds</td>
  469. </tr>
  470. </table>
  471. </div><div class="memdoc">
  472. <p>Bounding box. </p>
  473. </div>
  474. </div>
  475. <a id="a3b2733be6148d0bcb3cc07302ae10516" name="a3b2733be6148d0bcb3cc07302ae10516"></a>
  476. <h2 class="memtitle"><span class="permalink"><a href="#a3b2733be6148d0bcb3cc07302ae10516">&#9670;&#160;</a></span>mChild</h2>
  477. <div class="memitem">
  478. <div class="memproto">
  479. <table class="memname">
  480. <tr>
  481. <td class="memname"><a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a> AABBTreeBuilder::Node::mChild[2] = { <a class="el" href="#a5473a1105433005850b46881180c04b0">cInvalidNodeIndex</a>, <a class="el" href="#a5473a1105433005850b46881180c04b0">cInvalidNodeIndex</a> }</td>
  482. </tr>
  483. </table>
  484. </div><div class="memdoc">
  485. <p>Child node indices (if no triangles) </p>
  486. </div>
  487. </div>
  488. <a id="a681a1cab13cf6b265bfdbcd345114f35" name="a681a1cab13cf6b265bfdbcd345114f35"></a>
  489. <h2 class="memtitle"><span class="permalink"><a href="#a681a1cab13cf6b265bfdbcd345114f35">&#9670;&#160;</a></span>mNumTriangles</h2>
  490. <div class="memitem">
  491. <div class="memproto">
  492. <table class="memname">
  493. <tr>
  494. <td class="memname"><a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a> AABBTreeBuilder::Node::mNumTriangles = 0</td>
  495. </tr>
  496. </table>
  497. </div><div class="memdoc">
  498. </div>
  499. </div>
  500. <a id="a0c1859c01298bbe7a61fca6ba80c3f8b" name="a0c1859c01298bbe7a61fca6ba80c3f8b"></a>
  501. <h2 class="memtitle"><span class="permalink"><a href="#a0c1859c01298bbe7a61fca6ba80c3f8b">&#9670;&#160;</a></span>mTrianglesBegin</h2>
  502. <div class="memitem">
  503. <div class="memproto">
  504. <table class="memname">
  505. <tr>
  506. <td class="memname"><a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a> AABBTreeBuilder::Node::mTrianglesBegin</td>
  507. </tr>
  508. </table>
  509. </div><div class="memdoc">
  510. <p>Triangles (if no child nodes) </p>
  511. </div>
  512. </div>
  513. <hr/>The documentation for this class was generated from the following files:<ul>
  514. <li>Jolt/AABBTree/<a class="el" href="_a_a_b_b_tree_builder_8h_source.html">AABBTreeBuilder.h</a></li>
  515. <li>Jolt/AABBTree/<a class="el" href="_a_a_b_b_tree_builder_8cpp.html">AABBTreeBuilder.cpp</a></li>
  516. </ul>
  517. </div><!-- contents -->
  518. </div><!-- doc-content -->
  519. <!-- start footer part -->
  520. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  521. <ul>
  522. <li class="navelem"><a class="el" href="class_a_a_b_b_tree_builder.html">AABBTreeBuilder</a></li><li class="navelem"><a class="el" href="class_a_a_b_b_tree_builder_1_1_node.html">Node</a></li>
  523. <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>
  524. </ul>
  525. </div>
  526. </body>
  527. </html>