class_convex_hull_builder.html 30 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507
  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: ConvexHullBuilder 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_convex_hull_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="#nested-classes">Classes</a> &#124;
  108. <a href="#pub-types">Public Types</a> &#124;
  109. <a href="#pub-methods">Public Member Functions</a> &#124;
  110. <a href="class_convex_hull_builder-members.html">List of all members</a> </div>
  111. <div class="headertitle"><div class="title">ConvexHullBuilder Class Reference</div></div>
  112. </div><!--header-->
  113. <div class="contents">
  114. <p>A convex hull builder that tries to create hulls as accurately as possible. Used for offline processing.
  115. <a href="#details">More...</a></p>
  116. <p><code>#include &lt;<a class="el" href="_convex_hull_builder_8h_source.html">ConvexHullBuilder.h</a>&gt;</code></p>
  117. <div class="dynheader">
  118. Inheritance diagram for ConvexHullBuilder:</div>
  119. <div class="dyncontent">
  120. <div class="center">
  121. <img src="class_convex_hull_builder.png" usemap="#ConvexHullBuilder_map" alt=""/>
  122. <map id="ConvexHullBuilder_map" name="ConvexHullBuilder_map">
  123. <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"/>
  124. </map>
  125. </div></div>
  126. <table class="memberdecls">
  127. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
  128. Classes</h2></td></tr>
  129. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_convex_hull_builder_1_1_edge.html">Edge</a></td></tr>
  130. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Class that holds the information of an edge. <a href="class_convex_hull_builder_1_1_edge.html#details">More...</a><br /></td></tr>
  131. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  132. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_convex_hull_builder_1_1_face.html">Face</a></td></tr>
  133. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Class that holds the information of one face. <a href="class_convex_hull_builder_1_1_face.html#details">More...</a><br /></td></tr>
  134. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  135. </table><table class="memberdecls">
  136. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-types" name="pub-types"></a>
  137. Public Types</h2></td></tr>
  138. <tr class="memitem:aa49a23c340decb519ae98cfa2a9e469a" id="r_aa49a23c340decb519ae98cfa2a9e469a"><td class="memItemLeft" align="right" valign="top">enum class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aa49a23c340decb519ae98cfa2a9e469a">EResult</a> { <br />
  139. &#160;&#160;<a class="el" href="#aa49a23c340decb519ae98cfa2a9e469aa505a83f220c02df2f85c3810cd9ceb38">Success</a>
  140. , <a class="el" href="#aa49a23c340decb519ae98cfa2a9e469aa7cc57ee56f4f29991173f4efa7a469e9">MaxVerticesReached</a>
  141. , <a class="el" href="#aa49a23c340decb519ae98cfa2a9e469aa675071632f91d793892ece6ed205483f">TooFewPoints</a>
  142. , <a class="el" href="#aa49a23c340decb519ae98cfa2a9e469aa04477b2749feb6999bd3cb1c9f6fd963">TooFewFaces</a>
  143. , <br />
  144. &#160;&#160;<a class="el" href="#aa49a23c340decb519ae98cfa2a9e469aa24c813faee6d26cc144bec89a984824d">Degenerate</a>
  145. <br />
  146. }</td></tr>
  147. <tr class="memdesc:aa49a23c340decb519ae98cfa2a9e469a"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="class_result.html" title="Helper class that either contains a valid result or an error.">Result</a> enum that indicates how the hull got created. <a href="#aa49a23c340decb519ae98cfa2a9e469a">More...</a><br /></td></tr>
  148. <tr class="separator:aa49a23c340decb519ae98cfa2a9e469a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  149. <tr class="memitem:ace24021747e9c5b273b5ed357622564c" id="r_ace24021747e9c5b273b5ed357622564c"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ace24021747e9c5b273b5ed357622564c">ConflictList</a> = <a class="el" href="class_array.html">Array</a>&lt;int&gt;</td></tr>
  150. <tr class="separator:ace24021747e9c5b273b5ed357622564c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  151. <tr class="memitem:ae813b9da0b02f643f5075e121aa6880b" id="r_ae813b9da0b02f643f5075e121aa6880b"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ae813b9da0b02f643f5075e121aa6880b">Positions</a> = <a class="el" href="class_array.html">Array</a>&lt;<a class="el" href="class_vec3.html">Vec3</a>&gt;</td></tr>
  152. <tr class="separator:ae813b9da0b02f643f5075e121aa6880b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  153. <tr class="memitem:ae9f7a2eb095de53f76a7d3ea9198f7b4" id="r_ae9f7a2eb095de53f76a7d3ea9198f7b4"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ae9f7a2eb095de53f76a7d3ea9198f7b4">Faces</a> = <a class="el" href="class_array.html">Array</a>&lt;<a class="el" href="class_convex_hull_builder_1_1_face.html">Face</a> *&gt;</td></tr>
  154. <tr class="separator:ae9f7a2eb095de53f76a7d3ea9198f7b4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  155. </table><table class="memberdecls">
  156. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
  157. Public Member Functions</h2></td></tr>
  158. <tr class="memitem:a245e3c9f2ac5137c9ee5d66c9f7a7b9d" id="r_a245e3c9f2ac5137c9ee5d66c9f7a7b9d"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a245e3c9f2ac5137c9ee5d66c9f7a7b9d">ConvexHullBuilder</a> (const <a class="el" href="#ae813b9da0b02f643f5075e121aa6880b">Positions</a> &amp;inPositions)</td></tr>
  159. <tr class="memdesc:a245e3c9f2ac5137c9ee5d66c9f7a7b9d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor. <br /></td></tr>
  160. <tr class="separator:a245e3c9f2ac5137c9ee5d66c9f7a7b9d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  161. <tr class="memitem:a3182f05659156aba23773cd1cdb5c0cd" id="r_a3182f05659156aba23773cd1cdb5c0cd"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a3182f05659156aba23773cd1cdb5c0cd">~ConvexHullBuilder</a> ()</td></tr>
  162. <tr class="memdesc:a3182f05659156aba23773cd1cdb5c0cd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor. <br /></td></tr>
  163. <tr class="separator:a3182f05659156aba23773cd1cdb5c0cd"><td class="memSeparator" colspan="2">&#160;</td></tr>
  164. <tr class="memitem:afa4a4a97fc8ae9e58c039b3c36d10c54" id="r_afa4a4a97fc8ae9e58c039b3c36d10c54"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#aa49a23c340decb519ae98cfa2a9e469a">EResult</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#afa4a4a97fc8ae9e58c039b3c36d10c54">Initialize</a> (int inMaxVertices, float inTolerance, const char *&amp;outError)</td></tr>
  165. <tr class="separator:afa4a4a97fc8ae9e58c039b3c36d10c54"><td class="memSeparator" colspan="2">&#160;</td></tr>
  166. <tr class="memitem:af5deecbd010d00845107696af6797e63" id="r_af5deecbd010d00845107696af6797e63"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#af5deecbd010d00845107696af6797e63">GetNumVerticesUsed</a> () const</td></tr>
  167. <tr class="memdesc:af5deecbd010d00845107696af6797e63"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the amount of vertices that are currently used by the hull. <br /></td></tr>
  168. <tr class="separator:af5deecbd010d00845107696af6797e63"><td class="memSeparator" colspan="2">&#160;</td></tr>
  169. <tr class="memitem:a423d9e378746f1e9d6edb19bb2afa11f" id="r_a423d9e378746f1e9d6edb19bb2afa11f"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a423d9e378746f1e9d6edb19bb2afa11f">ContainsFace</a> (const <a class="el" href="class_array.html">Array</a>&lt; int &gt; &amp;inIndices) const</td></tr>
  170. <tr class="memdesc:a423d9e378746f1e9d6edb19bb2afa11f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns true if the hull contains a polygon with inIndices (counter clockwise indices in mPositions) <br /></td></tr>
  171. <tr class="separator:a423d9e378746f1e9d6edb19bb2afa11f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  172. <tr class="memitem:a4e3fbe324250233f9a3d527004d08c09" id="r_a4e3fbe324250233f9a3d527004d08c09"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a4e3fbe324250233f9a3d527004d08c09">GetCenterOfMassAndVolume</a> (<a class="el" href="class_vec3.html">Vec3</a> &amp;outCenterOfMass, float &amp;outVolume) const</td></tr>
  173. <tr class="memdesc:a4e3fbe324250233f9a3d527004d08c09"><td class="mdescLeft">&#160;</td><td class="mdescRight">Calculate the center of mass and the volume of the current convex hull. <br /></td></tr>
  174. <tr class="separator:a4e3fbe324250233f9a3d527004d08c09"><td class="memSeparator" colspan="2">&#160;</td></tr>
  175. <tr class="memitem:aae519c2ae09443413ef0c9e91dd26076" id="r_aae519c2ae09443413ef0c9e91dd26076"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aae519c2ae09443413ef0c9e91dd26076">DetermineMaxError</a> (<a class="el" href="class_convex_hull_builder_1_1_face.html">Face</a> *&amp;outFaceWithMaxError, float &amp;outMaxError, int &amp;outMaxErrorPositionIdx, float &amp;outCoplanarDistance) const</td></tr>
  176. <tr class="separator:aae519c2ae09443413ef0c9e91dd26076"><td class="memSeparator" colspan="2">&#160;</td></tr>
  177. <tr class="memitem:a2eade6ba63e25c3bda4eaf159d1128ce" id="r_a2eade6ba63e25c3bda4eaf159d1128ce"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="#ae9f7a2eb095de53f76a7d3ea9198f7b4">Faces</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a2eade6ba63e25c3bda4eaf159d1128ce">GetFaces</a> () const</td></tr>
  178. <tr class="memdesc:a2eade6ba63e25c3bda4eaf159d1128ce"><td class="mdescLeft">&#160;</td><td class="mdescRight">Access to the created faces. Memory is owned by the convex hull builder. <br /></td></tr>
  179. <tr class="separator:a2eade6ba63e25c3bda4eaf159d1128ce"><td class="memSeparator" colspan="2">&#160;</td></tr>
  180. <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>
  181. <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>
  182. <tr class="separator:a809b6e4ade7ae32f6d248f2a3b783d45 inherit pub_methods_class_non_copyable"><td class="memSeparator" colspan="2">&#160;</td></tr>
  183. <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>
  184. <tr class="separator:a501d34ffcc34b30de6d541887a901057 inherit pub_methods_class_non_copyable"><td class="memSeparator" colspan="2">&#160;</td></tr>
  185. <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>
  186. <tr class="separator:aaf9b12dcaae80c9d304df7a941d4e21f inherit pub_methods_class_non_copyable"><td class="memSeparator" colspan="2">&#160;</td></tr>
  187. </table>
  188. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  189. <div class="textblock"><p>A convex hull builder that tries to create hulls as accurately as possible. Used for offline processing. </p>
  190. </div><h2 class="groupheader">Member Typedef Documentation</h2>
  191. <a id="ace24021747e9c5b273b5ed357622564c" name="ace24021747e9c5b273b5ed357622564c"></a>
  192. <h2 class="memtitle"><span class="permalink"><a href="#ace24021747e9c5b273b5ed357622564c">&#9670;&#160;</a></span>ConflictList</h2>
  193. <div class="memitem">
  194. <div class="memproto">
  195. <table class="memname">
  196. <tr>
  197. <td class="memname">using <a class="el" href="#ace24021747e9c5b273b5ed357622564c">ConvexHullBuilder::ConflictList</a> = <a class="el" href="class_array.html">Array</a>&lt;int&gt;</td>
  198. </tr>
  199. </table>
  200. </div><div class="memdoc">
  201. </div>
  202. </div>
  203. <a id="ae9f7a2eb095de53f76a7d3ea9198f7b4" name="ae9f7a2eb095de53f76a7d3ea9198f7b4"></a>
  204. <h2 class="memtitle"><span class="permalink"><a href="#ae9f7a2eb095de53f76a7d3ea9198f7b4">&#9670;&#160;</a></span>Faces</h2>
  205. <div class="memitem">
  206. <div class="memproto">
  207. <table class="memname">
  208. <tr>
  209. <td class="memname">using <a class="el" href="#ae9f7a2eb095de53f76a7d3ea9198f7b4">ConvexHullBuilder::Faces</a> = <a class="el" href="class_array.html">Array</a>&lt;<a class="el" href="class_convex_hull_builder_1_1_face.html">Face</a> *&gt;</td>
  210. </tr>
  211. </table>
  212. </div><div class="memdoc">
  213. </div>
  214. </div>
  215. <a id="ae813b9da0b02f643f5075e121aa6880b" name="ae813b9da0b02f643f5075e121aa6880b"></a>
  216. <h2 class="memtitle"><span class="permalink"><a href="#ae813b9da0b02f643f5075e121aa6880b">&#9670;&#160;</a></span>Positions</h2>
  217. <div class="memitem">
  218. <div class="memproto">
  219. <table class="memname">
  220. <tr>
  221. <td class="memname">using <a class="el" href="#ae813b9da0b02f643f5075e121aa6880b">ConvexHullBuilder::Positions</a> = <a class="el" href="class_array.html">Array</a>&lt;<a class="el" href="class_vec3.html">Vec3</a>&gt;</td>
  222. </tr>
  223. </table>
  224. </div><div class="memdoc">
  225. </div>
  226. </div>
  227. <h2 class="groupheader">Member Enumeration Documentation</h2>
  228. <a id="aa49a23c340decb519ae98cfa2a9e469a" name="aa49a23c340decb519ae98cfa2a9e469a"></a>
  229. <h2 class="memtitle"><span class="permalink"><a href="#aa49a23c340decb519ae98cfa2a9e469a">&#9670;&#160;</a></span>EResult</h2>
  230. <div class="memitem">
  231. <div class="memproto">
  232. <table class="mlabels">
  233. <tr>
  234. <td class="mlabels-left">
  235. <table class="memname">
  236. <tr>
  237. <td class="memname">enum class <a class="el" href="#aa49a23c340decb519ae98cfa2a9e469a">ConvexHullBuilder::EResult</a></td>
  238. </tr>
  239. </table>
  240. </td>
  241. <td class="mlabels-right">
  242. <span class="mlabels"><span class="mlabel">strong</span></span> </td>
  243. </tr>
  244. </table>
  245. </div><div class="memdoc">
  246. <p><a class="el" href="class_result.html" title="Helper class that either contains a valid result or an error.">Result</a> enum that indicates how the hull got created. </p>
  247. <table class="fieldtable">
  248. <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="aa49a23c340decb519ae98cfa2a9e469aa505a83f220c02df2f85c3810cd9ceb38" name="aa49a23c340decb519ae98cfa2a9e469aa505a83f220c02df2f85c3810cd9ceb38"></a>Success&#160;</td><td class="fielddoc"><p>Hull building finished successfully. </p>
  249. </td></tr>
  250. <tr><td class="fieldname"><a id="aa49a23c340decb519ae98cfa2a9e469aa7cc57ee56f4f29991173f4efa7a469e9" name="aa49a23c340decb519ae98cfa2a9e469aa7cc57ee56f4f29991173f4efa7a469e9"></a>MaxVerticesReached&#160;</td><td class="fielddoc"><p>Hull building finished successfully, but the desired accuracy was not reached because the max vertices limit was reached. </p>
  251. </td></tr>
  252. <tr><td class="fieldname"><a id="aa49a23c340decb519ae98cfa2a9e469aa675071632f91d793892ece6ed205483f" name="aa49a23c340decb519ae98cfa2a9e469aa675071632f91d793892ece6ed205483f"></a>TooFewPoints&#160;</td><td class="fielddoc"><p>Too few points to create a hull. </p>
  253. </td></tr>
  254. <tr><td class="fieldname"><a id="aa49a23c340decb519ae98cfa2a9e469aa04477b2749feb6999bd3cb1c9f6fd963" name="aa49a23c340decb519ae98cfa2a9e469aa04477b2749feb6999bd3cb1c9f6fd963"></a>TooFewFaces&#160;</td><td class="fielddoc"><p>Too few faces in the created hull (signifies precision errors during building) </p>
  255. </td></tr>
  256. <tr><td class="fieldname"><a id="aa49a23c340decb519ae98cfa2a9e469aa24c813faee6d26cc144bec89a984824d" name="aa49a23c340decb519ae98cfa2a9e469aa24c813faee6d26cc144bec89a984824d"></a>Degenerate&#160;</td><td class="fielddoc"><p>Degenerate hull detected. </p>
  257. </td></tr>
  258. </table>
  259. </div>
  260. </div>
  261. <h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  262. <a id="a245e3c9f2ac5137c9ee5d66c9f7a7b9d" name="a245e3c9f2ac5137c9ee5d66c9f7a7b9d"></a>
  263. <h2 class="memtitle"><span class="permalink"><a href="#a245e3c9f2ac5137c9ee5d66c9f7a7b9d">&#9670;&#160;</a></span>ConvexHullBuilder()</h2>
  264. <div class="memitem">
  265. <div class="memproto">
  266. <table class="mlabels">
  267. <tr>
  268. <td class="mlabels-left">
  269. <table class="memname">
  270. <tr>
  271. <td class="memname">ConvexHullBuilder::ConvexHullBuilder </td>
  272. <td>(</td>
  273. <td class="paramtype">const <a class="el" href="#ae813b9da0b02f643f5075e121aa6880b">Positions</a> &amp;</td> <td class="paramname"><span class="paramname"><em>inPositions</em></span></td><td>)</td>
  274. <td></td>
  275. </tr>
  276. </table>
  277. </td>
  278. <td class="mlabels-right">
  279. <span class="mlabels"><span class="mlabel">explicit</span></span> </td>
  280. </tr>
  281. </table>
  282. </div><div class="memdoc">
  283. <p>Constructor. </p>
  284. </div>
  285. </div>
  286. <a id="a3182f05659156aba23773cd1cdb5c0cd" name="a3182f05659156aba23773cd1cdb5c0cd"></a>
  287. <h2 class="memtitle"><span class="permalink"><a href="#a3182f05659156aba23773cd1cdb5c0cd">&#9670;&#160;</a></span>~ConvexHullBuilder()</h2>
  288. <div class="memitem">
  289. <div class="memproto">
  290. <table class="mlabels">
  291. <tr>
  292. <td class="mlabels-left">
  293. <table class="memname">
  294. <tr>
  295. <td class="memname">ConvexHullBuilder::~ConvexHullBuilder </td>
  296. <td>(</td>
  297. <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  298. <td></td>
  299. </tr>
  300. </table>
  301. </td>
  302. <td class="mlabels-right">
  303. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  304. </tr>
  305. </table>
  306. </div><div class="memdoc">
  307. <p>Destructor. </p>
  308. </div>
  309. </div>
  310. <h2 class="groupheader">Member Function Documentation</h2>
  311. <a id="a423d9e378746f1e9d6edb19bb2afa11f" name="a423d9e378746f1e9d6edb19bb2afa11f"></a>
  312. <h2 class="memtitle"><span class="permalink"><a href="#a423d9e378746f1e9d6edb19bb2afa11f">&#9670;&#160;</a></span>ContainsFace()</h2>
  313. <div class="memitem">
  314. <div class="memproto">
  315. <table class="memname">
  316. <tr>
  317. <td class="memname">bool ConvexHullBuilder::ContainsFace </td>
  318. <td>(</td>
  319. <td class="paramtype">const <a class="el" href="class_array.html">Array</a>&lt; int &gt; &amp;</td> <td class="paramname"><span class="paramname"><em>inIndices</em></span></td><td>)</td>
  320. <td> const</td>
  321. </tr>
  322. </table>
  323. </div><div class="memdoc">
  324. <p>Returns true if the hull contains a polygon with inIndices (counter clockwise indices in mPositions) </p>
  325. </div>
  326. </div>
  327. <a id="aae519c2ae09443413ef0c9e91dd26076" name="aae519c2ae09443413ef0c9e91dd26076"></a>
  328. <h2 class="memtitle"><span class="permalink"><a href="#aae519c2ae09443413ef0c9e91dd26076">&#9670;&#160;</a></span>DetermineMaxError()</h2>
  329. <div class="memitem">
  330. <div class="memproto">
  331. <table class="memname">
  332. <tr>
  333. <td class="memname">void ConvexHullBuilder::DetermineMaxError </td>
  334. <td>(</td>
  335. <td class="paramtype"><a class="el" href="class_convex_hull_builder_1_1_face.html">Face</a> *&amp;</td> <td class="paramname"><span class="paramname"><em>outFaceWithMaxError</em></span>, </td>
  336. </tr>
  337. <tr>
  338. <td class="paramkey"></td>
  339. <td></td>
  340. <td class="paramtype">float &amp;</td> <td class="paramname"><span class="paramname"><em>outMaxError</em></span>, </td>
  341. </tr>
  342. <tr>
  343. <td class="paramkey"></td>
  344. <td></td>
  345. <td class="paramtype">int &amp;</td> <td class="paramname"><span class="paramname"><em>outMaxErrorPositionIdx</em></span>, </td>
  346. </tr>
  347. <tr>
  348. <td class="paramkey"></td>
  349. <td></td>
  350. <td class="paramtype">float &amp;</td> <td class="paramname"><span class="paramname"><em>outCoplanarDistance</em></span>&#160;) const</td>
  351. </tr>
  352. </table>
  353. </div><div class="memdoc">
  354. <p>Determines the point that is furthest outside of the hull and reports how far it is outside of the hull (which indicates a failure during hull building) </p><dl class="params"><dt>Parameters</dt><dd>
  355. <table class="params">
  356. <tr><td class="paramname">outFaceWithMaxError</td><td>The face that caused the error </td></tr>
  357. <tr><td class="paramname">outMaxError</td><td>The maximum distance of a point to the hull </td></tr>
  358. <tr><td class="paramname">outMaxErrorPositionIdx</td><td>The index of the point that had this distance </td></tr>
  359. <tr><td class="paramname">outCoplanarDistance</td><td>Points that are less than this distance from the hull are considered on the hull. This should be used as a lowerbound for the allowed error. </td></tr>
  360. </table>
  361. </dd>
  362. </dl>
  363. </div>
  364. </div>
  365. <a id="a4e3fbe324250233f9a3d527004d08c09" name="a4e3fbe324250233f9a3d527004d08c09"></a>
  366. <h2 class="memtitle"><span class="permalink"><a href="#a4e3fbe324250233f9a3d527004d08c09">&#9670;&#160;</a></span>GetCenterOfMassAndVolume()</h2>
  367. <div class="memitem">
  368. <div class="memproto">
  369. <table class="memname">
  370. <tr>
  371. <td class="memname">void ConvexHullBuilder::GetCenterOfMassAndVolume </td>
  372. <td>(</td>
  373. <td class="paramtype"><a class="el" href="class_vec3.html">Vec3</a> &amp;</td> <td class="paramname"><span class="paramname"><em>outCenterOfMass</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>outVolume</em></span>&#160;) const</td>
  379. </tr>
  380. </table>
  381. </div><div class="memdoc">
  382. <p>Calculate the center of mass and the volume of the current convex hull. </p>
  383. </div>
  384. </div>
  385. <a id="a2eade6ba63e25c3bda4eaf159d1128ce" name="a2eade6ba63e25c3bda4eaf159d1128ce"></a>
  386. <h2 class="memtitle"><span class="permalink"><a href="#a2eade6ba63e25c3bda4eaf159d1128ce">&#9670;&#160;</a></span>GetFaces()</h2>
  387. <div class="memitem">
  388. <div class="memproto">
  389. <table class="mlabels">
  390. <tr>
  391. <td class="mlabels-left">
  392. <table class="memname">
  393. <tr>
  394. <td class="memname">const <a class="el" href="#ae9f7a2eb095de53f76a7d3ea9198f7b4">Faces</a> &amp; ConvexHullBuilder::GetFaces </td>
  395. <td>(</td>
  396. <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  397. <td> const</td>
  398. </tr>
  399. </table>
  400. </td>
  401. <td class="mlabels-right">
  402. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  403. </tr>
  404. </table>
  405. </div><div class="memdoc">
  406. <p>Access to the created faces. Memory is owned by the convex hull builder. </p>
  407. </div>
  408. </div>
  409. <a id="af5deecbd010d00845107696af6797e63" name="af5deecbd010d00845107696af6797e63"></a>
  410. <h2 class="memtitle"><span class="permalink"><a href="#af5deecbd010d00845107696af6797e63">&#9670;&#160;</a></span>GetNumVerticesUsed()</h2>
  411. <div class="memitem">
  412. <div class="memproto">
  413. <table class="memname">
  414. <tr>
  415. <td class="memname">int ConvexHullBuilder::GetNumVerticesUsed </td>
  416. <td>(</td>
  417. <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  418. <td> const</td>
  419. </tr>
  420. </table>
  421. </div><div class="memdoc">
  422. <p>Returns the amount of vertices that are currently used by the hull. </p>
  423. </div>
  424. </div>
  425. <a id="afa4a4a97fc8ae9e58c039b3c36d10c54" name="afa4a4a97fc8ae9e58c039b3c36d10c54"></a>
  426. <h2 class="memtitle"><span class="permalink"><a href="#afa4a4a97fc8ae9e58c039b3c36d10c54">&#9670;&#160;</a></span>Initialize()</h2>
  427. <div class="memitem">
  428. <div class="memproto">
  429. <table class="memname">
  430. <tr>
  431. <td class="memname"><a class="el" href="#aa49a23c340decb519ae98cfa2a9e469a">ConvexHullBuilder::EResult</a> ConvexHullBuilder::Initialize </td>
  432. <td>(</td>
  433. <td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>inMaxVertices</em></span>, </td>
  434. </tr>
  435. <tr>
  436. <td class="paramkey"></td>
  437. <td></td>
  438. <td class="paramtype">float</td> <td class="paramname"><span class="paramname"><em>inTolerance</em></span>, </td>
  439. </tr>
  440. <tr>
  441. <td class="paramkey"></td>
  442. <td></td>
  443. <td class="paramtype">const char *&amp;</td> <td class="paramname"><span class="paramname"><em>outError</em></span>&#160;)</td>
  444. </tr>
  445. </table>
  446. </div><div class="memdoc">
  447. <p>Takes all positions as provided by the constructor and use them to build a hull Any points that are closer to the hull than inTolerance will be discarded </p><dl class="params"><dt>Parameters</dt><dd>
  448. <table class="params">
  449. <tr><td class="paramname">inMaxVertices</td><td>Max vertices to allow in the hull. Specify INT_MAX if there is no limit. </td></tr>
  450. <tr><td class="paramname">inTolerance</td><td>Max distance that a point is allowed to be outside of the hull </td></tr>
  451. <tr><td class="paramname">outError</td><td>Error message when building fails </td></tr>
  452. </table>
  453. </dd>
  454. </dl>
  455. <dl class="section return"><dt>Returns</dt><dd>Status code that reports if the hull was created or not </dd></dl>
  456. </div>
  457. </div>
  458. <hr/>The documentation for this class was generated from the following files:<ul>
  459. <li>Jolt/Geometry/<a class="el" href="_convex_hull_builder_8h_source.html">ConvexHullBuilder.h</a></li>
  460. <li>Jolt/Geometry/<a class="el" href="_convex_hull_builder_8cpp.html">ConvexHullBuilder.cpp</a></li>
  461. </ul>
  462. </div><!-- contents -->
  463. </div><!-- doc-content -->
  464. <!-- start footer part -->
  465. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  466. <ul>
  467. <li class="navelem"><a class="el" href="class_convex_hull_builder.html">ConvexHullBuilder</a></li>
  468. <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>
  469. </ul>
  470. </div>
  471. </body>
  472. </html>