classGeometry.html

<!-- HTML header for doxygen 1.15.0-->
<!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.16.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Hatch Game Engine Documentation: Geometry Class Reference</title>
<link rel="icon" href="favicon.ico" type="image/x-icon" />
<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="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/javascript">
  $(function() { init_search(); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="stylesheet.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="logo.svg" width="55" height="55"/></td>
  <td id="projectalign">
   <div id="projectname">Hatch Game Engine Documentation<span id="projectnumber">&#160;v1.4.0</span>
   </div>
   <div id="projectbrief">The documentation for the Hatch Game Engine</div>
  </td>
    <td>        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <span id="MSearchSelect" class="search-icon" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()"><span class="search-icon-dropdown"></span></span>
          <input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><div id="MSearchCloseImg" class="close-icon"></div></a>
          </span>
        </div>
</td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.16.0 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search/",'.html');
</script>
<script type="text/javascript">
$(function() { codefold.init(); });
</script>
</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">
$(function(){initNavTree('classGeometry.html','','classGeometry-members'); });
</script>
<div id="container">
<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="headertitle"><div class="title">Geometry Class Reference<div class="ingroups"><a class="el" href="group__hsl.html">HSL</a></div></div></div>
</div><!--header-->
<div class="contents">

<p>Geometry intersection functions.  
 <a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 id="header-pub-methods" class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a4f89fc21ace4d9b14268fb3c4ad94d36" id="r_a4f89fc21ace4d9b14268fb3c4ad94d36"><td class="memItemLeft">array&#160;</td><td class="memItemRight"><a class="el" href="#a4f89fc21ace4d9b14268fb3c4ad94d36">Triangulate</a> (array polygon, array holes)</td></tr>
<tr class="memdesc:a4f89fc21ace4d9b14268fb3c4ad94d36"><td class="mdescLeft">&#160;</td><td class="mdescRight">Triangulates a 2D polygon.  <br /></td></tr>
<tr class="memitem:a09a4184d9cdb0021a908316051cb795e" id="r_a09a4184d9cdb0021a908316051cb795e"><td class="memItemLeft">array&#160;</td><td class="memItemRight"><a class="el" href="#a09a4184d9cdb0021a908316051cb795e">Intersect</a> (array subjects, array clips, <a class="el" href="group__hsl.html#ga38beca8c13adaa48f0c062f7d1d4cd3d">GeoBooleanOp</a> booleanOp=&lt; ref <a class="el" href="group__hsl.html#gga38beca8c13adaa48f0c062f7d1d4cd3dafc1474f9291b8f7f2a6804579126dd8e">GeoBooleanOp_Intersection</a> &gt;, <a class="el" href="group__hsl.html#ga64155ca32d939987a888f77dedb6e2a9">GeoFillRule</a> fillRule=&lt; ref <a class="el" href="group__hsl.html#gga64155ca32d939987a888f77dedb6e2a9ab4471429c286dfae25a5d0d50f10d115">GeoFillRule_EvenOdd</a> &gt;)</td></tr>
<tr class="memdesc:a09a4184d9cdb0021a908316051cb795e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Intersects a 2D polygon.  <br /></td></tr>
<tr class="memitem:abe21d90cb7f3cfa24409e178e7f497c3" id="r_abe21d90cb7f3cfa24409e178e7f497c3"><td class="memItemLeft">boolean&#160;</td><td class="memItemRight"><a class="el" href="#abe21d90cb7f3cfa24409e178e7f497c3">IsPointInsidePolygon</a> (array polygon, decimal pointX, decimal pointY)</td></tr>
<tr class="memdesc:abe21d90cb7f3cfa24409e178e7f497c3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks if a point is inside a polygon.  <br /></td></tr>
<tr class="memitem:a06cbf6470f8a9ff55c7f80f4f4faa0ba" id="r_a06cbf6470f8a9ff55c7f80f4f4faa0ba"><td class="memItemLeft">boolean&#160;</td><td class="memItemRight"><a class="el" href="#a06cbf6470f8a9ff55c7f80f4f4faa0ba">IsLineIntersectingPolygon</a> (array polygon, decimal x1, decimal y1, decimal x2, decimal y2)</td></tr>
<tr class="memdesc:a06cbf6470f8a9ff55c7f80f4f4faa0ba"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks if a line segment is intersecting a polygon.  <br /></td></tr>
</table>
<a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Geometry intersection functions. </p>
</div><a name="doc-func-members" id="doc-func-members"></a><h2 id="header-doc-func-members" class="groupheader">Member Function Documentation</h2>
<a id="a09a4184d9cdb0021a908316051cb795e" name="a09a4184d9cdb0021a908316051cb795e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a09a4184d9cdb0021a908316051cb795e">&#9670;&#160;</a></span>Intersect()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">array Geometry.Intersect </td>
          <td>(</td>
          <td class="paramtype">array</td>          <td class="paramname"><span class="paramname"><em>subjects</em></span>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">array</td>          <td class="paramname"><span class="paramname"><em>clips</em></span>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__hsl.html#ga38beca8c13adaa48f0c062f7d1d4cd3d">GeoBooleanOp</a></td>          <td class="paramname"><span class="paramname"><em>booleanOp</em></span><span class="paramdefsep"> = </span><span class="paramdefval">&lt;&#160;ref&#160;<a class="el" href="group__hsl.html#gga38beca8c13adaa48f0c062f7d1d4cd3dafc1474f9291b8f7f2a6804579126dd8e">GeoBooleanOp_Intersection</a>&#160;&gt;</span>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__hsl.html#ga64155ca32d939987a888f77dedb6e2a9">GeoFillRule</a></td>          <td class="paramname"><span class="paramname"><em>fillRule</em></span><span class="paramdefsep"> = </span><span class="paramdefval">&lt;&#160;ref&#160;<a class="el" href="group__hsl.html#gga64155ca32d939987a888f77dedb6e2a9ab4471429c286dfae25a5d0d50f10d115">GeoFillRule_EvenOdd</a>&#160;&gt;</span>&#160;)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Intersects a 2D polygon. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">subjects</td><td>Array of subject polygons. </td></tr>
    <tr><td class="paramname">clips</td><td>Array of clip polygons. </td></tr>
    <tr><td class="paramname">booleanOp</td><td>The boolean operation. </td></tr>
    <tr><td class="paramname">fillRule</td><td>The fill rule. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns an array containing a list of intersected polygons, or <span class="tt">null</span> if the polygon could not be intersected. </dd></dl>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">boolean Geometry.IsLineIntersectingPolygon </td>
          <td>(</td>
          <td class="paramtype">array</td>          <td class="paramname"><span class="paramname"><em>polygon</em></span>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">decimal</td>          <td class="paramname"><span class="paramname"><em>x1</em></span>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">decimal</td>          <td class="paramname"><span class="paramname"><em>y1</em></span>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">decimal</td>          <td class="paramname"><span class="paramname"><em>x2</em></span>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">decimal</td>          <td class="paramname"><span class="paramname"><em>y2</em></span>&#160;)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Checks if a line segment is intersecting a polygon. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">polygon</td><td>The polygon to check. </td></tr>
    <tr><td class="paramname">x1</td><td>The starting X of the segment. </td></tr>
    <tr><td class="paramname">y1</td><td>The starting Y of the segment. </td></tr>
    <tr><td class="paramname">x2</td><td>The ending X of the segment. </td></tr>
    <tr><td class="paramname">y2</td><td>The ending Y of the segment. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns whether the line segment is intersecting the polygon. </dd></dl>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">boolean Geometry.IsPointInsidePolygon </td>
          <td>(</td>
          <td class="paramtype">array</td>          <td class="paramname"><span class="paramname"><em>polygon</em></span>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">decimal</td>          <td class="paramname"><span class="paramname"><em>pointX</em></span>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">decimal</td>          <td class="paramname"><span class="paramname"><em>pointY</em></span>&#160;)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Checks if a point is inside a polygon. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">polygon</td><td>The polygon. </td></tr>
    <tr><td class="paramname">pointX</td><td>The X of the point. </td></tr>
    <tr><td class="paramname">pointY</td><td>The Y of the point. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns whether the point is inside. </dd></dl>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">array Geometry.Triangulate </td>
          <td>(</td>
          <td class="paramtype">array</td>          <td class="paramname"><span class="paramname"><em>polygon</em></span>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">array</td>          <td class="paramname"><span class="paramname"><em>holes</em></span>&#160;)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Triangulates a 2D polygon. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">polygon</td><td>Array of vertices that compromise the polygon to triangulate. </td></tr>
    <tr><td class="paramname">holes</td><td>Array of polygons that compromise the holes to be made in the resulting shape. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns an array containing a list of triangles, or <span class="tt">null</span> if the polygon could not be triangulated. </dd></dl>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="page-nav" class="page-nav-panel">
<div id="page-nav-resize-handle"></div>
<div id="page-nav-tree">
<div id="page-nav-contents">
</div><!-- page-nav-contents -->
</div><!-- page-nav-tree -->
</div><!-- page-nav -->
</div><!-- container -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a href="classGeometry.html">Geometry</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.16.0 </li>
  </ul>
</div>
</body>
</html>