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


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338
							<!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: ConvexHullBuilder2D 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_convex_hull_builder2_d.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="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="class_convex_hull_builder2_d-members.html">List of all members</a>  </div>
  <div class="headertitle"><div class="title">ConvexHullBuilder2D Class Reference</div></div>
</div><!--header-->
<div class="contents">

<p>A convex hull builder that tries to create 2D hulls as accurately as possible. Used for offline processing.  
 <a href="#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="_convex_hull_builder2_d_8h_source.html">ConvexHullBuilder2D.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for ConvexHullBuilder2D:</div>
<div class="dyncontent">
 <div class="center">
  <img src="class_convex_hull_builder2_d.png" usemap="#ConvexHullBuilder2D_map" alt=""/>
  <map id="ConvexHullBuilder2D_map" name="ConvexHullBuilder2D_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,133,24"/>
  </map>
</div></div>
<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:a249cc4fd8288bd1cf447d3d820e9dcd0" id="r_a249cc4fd8288bd1cf447d3d820e9dcd0"><td class="memItemLeft" align="right" valign="top">enum class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a249cc4fd8288bd1cf447d3d820e9dcd0">EResult</a> { <a class="el" href="#a249cc4fd8288bd1cf447d3d820e9dcd0a505a83f220c02df2f85c3810cd9ceb38">Success</a>
, <a class="el" href="#a249cc4fd8288bd1cf447d3d820e9dcd0a7cc57ee56f4f29991173f4efa7a469e9">MaxVerticesReached</a>
 }</td></tr>
<tr class="memdesc:a249cc4fd8288bd1cf447d3d820e9dcd0"><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="#a249cc4fd8288bd1cf447d3d820e9dcd0">More...</a><br /></td></tr>
<tr class="separator:a249cc4fd8288bd1cf447d3d820e9dcd0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a73280989dea747d4ec494b260e85222c" id="r_a73280989dea747d4ec494b260e85222c"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a73280989dea747d4ec494b260e85222c">Positions</a> = <a class="el" href="class_array.html">Array</a>&lt;<a class="el" href="class_vec3.html">Vec3</a>&gt;</td></tr>
<tr class="separator:a73280989dea747d4ec494b260e85222c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5827b465379b2d68b9bf2e6968565df5" id="r_a5827b465379b2d68b9bf2e6968565df5"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a5827b465379b2d68b9bf2e6968565df5">Edges</a> = <a class="el" href="class_array.html">Array</a>&lt;int&gt;</td></tr>
<tr class="separator:a5827b465379b2d68b9bf2e6968565df5"><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:ab299706e0b4a473b763116a31ff234c8" id="r_ab299706e0b4a473b763116a31ff234c8"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ab299706e0b4a473b763116a31ff234c8">ConvexHullBuilder2D</a> (const <a class="el" href="#a73280989dea747d4ec494b260e85222c">Positions</a> &amp;inPositions)</td></tr>
<tr class="separator:ab299706e0b4a473b763116a31ff234c8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9fd6172b0d35d0f66114514b6a8a31b0" id="r_a9fd6172b0d35d0f66114514b6a8a31b0"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a9fd6172b0d35d0f66114514b6a8a31b0">~ConvexHullBuilder2D</a> ()</td></tr>
<tr class="memdesc:a9fd6172b0d35d0f66114514b6a8a31b0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor.  <br /></td></tr>
<tr class="separator:a9fd6172b0d35d0f66114514b6a8a31b0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa7047be80b54c2b14497e3d34c3dd956" id="r_aa7047be80b54c2b14497e3d34c3dd956"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#a249cc4fd8288bd1cf447d3d820e9dcd0">EResult</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aa7047be80b54c2b14497e3d34c3dd956">Initialize</a> (int inIdx1, int inIdx2, int inIdx3, int inMaxVertices, float inTolerance, <a class="el" href="#a5827b465379b2d68b9bf2e6968565df5">Edges</a> &amp;outEdges)</td></tr>
<tr class="separator:aa7047be80b54c2b14497e3d34c3dd956"><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>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>A convex hull builder that tries to create 2D hulls as accurately as possible. Used for offline processing. </p>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a id="a5827b465379b2d68b9bf2e6968565df5" name="a5827b465379b2d68b9bf2e6968565df5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5827b465379b2d68b9bf2e6968565df5">&#9670;&#160;</a></span>Edges</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">using <a class="el" href="#a5827b465379b2d68b9bf2e6968565df5">ConvexHullBuilder2D::Edges</a> = <a class="el" href="class_array.html">Array</a>&lt;int&gt;</td>
        </tr>
      </table>
</div><div class="memdoc">

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">using <a class="el" href="#a73280989dea747d4ec494b260e85222c">ConvexHullBuilder2D::Positions</a> = <a class="el" href="class_array.html">Array</a>&lt;<a class="el" href="class_vec3.html">Vec3</a>&gt;</td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<h2 class="groupheader">Member Enumeration Documentation</h2>
<a id="a249cc4fd8288bd1cf447d3d820e9dcd0" name="a249cc4fd8288bd1cf447d3d820e9dcd0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a249cc4fd8288bd1cf447d3d820e9dcd0">&#9670;&#160;</a></span>EResult</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="#a249cc4fd8288bd1cf447d3d820e9dcd0">ConvexHullBuilder2D::EResult</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><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>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a249cc4fd8288bd1cf447d3d820e9dcd0a505a83f220c02df2f85c3810cd9ceb38" name="a249cc4fd8288bd1cf447d3d820e9dcd0a505a83f220c02df2f85c3810cd9ceb38"></a>Success&#160;</td><td class="fielddoc"><p>Hull building finished successfully. </p>
</td></tr>
<tr><td class="fieldname"><a id="a249cc4fd8288bd1cf447d3d820e9dcd0a7cc57ee56f4f29991173f4efa7a469e9" name="a249cc4fd8288bd1cf447d3d820e9dcd0a7cc57ee56f4f29991173f4efa7a469e9"></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>
</td></tr>
</table>

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

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">ConvexHullBuilder2D::ConvexHullBuilder2D </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="#a73280989dea747d4ec494b260e85222c">Positions</a> &amp;</td>          <td class="paramname"><span class="paramname"><em>inPositions</em></span></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">explicit</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Constructor </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">inPositions</td><td>Positions used to make the hull. Uses X and Y component of <a class="el" href="class_vec3.html">Vec3</a> only! </td></tr>
  </table>
  </dd>
</dl>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">ConvexHullBuilder2D::~ConvexHullBuilder2D </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="aa7047be80b54c2b14497e3d34c3dd956" name="aa7047be80b54c2b14497e3d34c3dd956"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa7047be80b54c2b14497e3d34c3dd956">&#9670;&#160;</a></span>Initialize()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="#a249cc4fd8288bd1cf447d3d820e9dcd0">ConvexHullBuilder2D::EResult</a> ConvexHullBuilder2D::Initialize </td>
          <td>(</td>
          <td class="paramtype">int</td>          <td class="paramname"><span class="paramname"><em>inIdx1</em></span>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int</td>          <td class="paramname"><span class="paramname"><em>inIdx2</em></span>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int</td>          <td class="paramname"><span class="paramname"><em>inIdx3</em></span>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int</td>          <td class="paramname"><span class="paramname"><em>inMaxVertices</em></span>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">float</td>          <td class="paramname"><span class="paramname"><em>inTolerance</em></span>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="#a5827b465379b2d68b9bf2e6968565df5">Edges</a> &amp;</td>          <td class="paramname"><span class="paramname"><em>outEdges</em></span>&#160;)</td>
        </tr>
      </table>
</div><div class="memdoc">
<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>
  <table class="params">
    <tr><td class="paramname">inIdx1,inIdx2,inIdx3</td><td>The indices to use as initial hull (in any order) </td></tr>
    <tr><td class="paramname">inMaxVertices</td><td>Max vertices to allow in the hull. Specify INT_MAX if there is no limit. </td></tr>
    <tr><td class="paramname">inTolerance</td><td>Max distance that a point is allowed to be outside of the hull </td></tr>
    <tr><td class="paramname">outEdges</td><td>On success this will contain the list of indices that form the hull (counter clockwise) </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Status code that reports if the hull was created or not </dd></dl>

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>Jolt/Geometry/<a class="el" href="_convex_hull_builder2_d_8h_source.html">ConvexHullBuilder2D.h</a></li>
<li>Jolt/Geometry/<a class="el" href="_convex_hull_builder2_d_8cpp.html">ConvexHullBuilder2D.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_convex_hull_builder2_d.html">ConvexHullBuilder2D</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>