geos_390_docs/classgeos_1_1noding_1_1snap...

326 lines
18 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.11"/>
<title>GEOS: geos::noding::snapround::MCIndexPointSnapper 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>
<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 style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">GEOS
&#160;<span id="projectnumber">3.9.1dev</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespacegeos.html">geos</a></li><li class="navelem"><a class="el" href="namespacegeos_1_1noding.html">noding</a></li><li class="navelem"><a class="el" href="namespacegeos_1_1noding_1_1snapround.html">snapround</a></li><li class="navelem"><a class="el" href="classgeos_1_1noding_1_1snapround_1_1MCIndexPointSnapper.html">MCIndexPointSnapper</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pri-methods">Private Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="#pri-static-attribs">Static Private Attributes</a> &#124;
<a href="classgeos_1_1noding_1_1snapround_1_1MCIndexPointSnapper-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">geos::noding::snapround::MCIndexPointSnapper Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>"Snaps" all <a class="el" href="classgeos_1_1noding_1_1SegmentString.html">SegmentStrings</a> in a <a class="el" href="classgeos_1_1index_1_1SpatialIndex.html">SpatialIndex</a> containing <a class="el" href="classgeos_1_1index_1_1chain_1_1MonotoneChain.html">MonotoneChains</a> to a given <a class="el" href="classgeos_1_1noding_1_1snapround_1_1HotPixel.html" title="Implements a &quot;hot pixel&quot; as used in the Snap Rounding algorithm. ">HotPixel</a>.
<a href="classgeos_1_1noding_1_1snapround_1_1MCIndexPointSnapper.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="MCIndexPointSnapper_8h_source.html">MCIndexPointSnapper.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for geos::noding::snapround::MCIndexPointSnapper:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="classgeos_1_1noding_1_1snapround_1_1MCIndexPointSnapper__coll__graph.svg" width="194" height="147"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ae07d45ce9fbd2a568d7aa5288975a501"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1noding_1_1snapround_1_1MCIndexPointSnapper.html#ae07d45ce9fbd2a568d7aa5288975a501">MCIndexPointSnapper</a> (<a class="el" href="classgeos_1_1index_1_1SpatialIndex.html">index::SpatialIndex</a> &amp;nIndex)</td></tr>
<tr class="separator:ae07d45ce9fbd2a568d7aa5288975a501"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abad906dd6d009cef61f1384aa67a9abc"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1noding_1_1snapround_1_1MCIndexPointSnapper.html#abad906dd6d009cef61f1384aa67a9abc">snap</a> (<a class="el" href="classgeos_1_1noding_1_1snapround_1_1HotPixel.html">HotPixel</a> &amp;hotPixel, <a class="el" href="classgeos_1_1noding_1_1SegmentString.html">SegmentString</a> *parentEdge, size_t vertexIndex)</td></tr>
<tr class="memdesc:abad906dd6d009cef61f1384aa67a9abc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Snaps (nodes) all interacting segments to this hot pixel. <a href="#abad906dd6d009cef61f1384aa67a9abc">More...</a><br /></td></tr>
<tr class="separator:abad906dd6d009cef61f1384aa67a9abc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa598a2ad9b554aa939b8d83bd725e5f4"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1noding_1_1snapround_1_1MCIndexPointSnapper.html#aa598a2ad9b554aa939b8d83bd725e5f4">snap</a> (<a class="el" href="classgeos_1_1noding_1_1snapround_1_1HotPixel.html">HotPixel</a> &amp;hotPixel)</td></tr>
<tr class="separator:aa598a2ad9b554aa939b8d83bd725e5f4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1a8c4d1a2fd845bef74284d5f8628dfa"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgeos_1_1geom_1_1Envelope.html">geom::Envelope</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1noding_1_1snapround_1_1MCIndexPointSnapper.html#a1a8c4d1a2fd845bef74284d5f8628dfa">getSafeEnvelope</a> (const <a class="el" href="classgeos_1_1noding_1_1snapround_1_1HotPixel.html">HotPixel</a> &amp;hp) const </td></tr>
<tr class="separator:a1a8c4d1a2fd845bef74284d5f8628dfa"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-methods"></a>
Private Member Functions</h2></td></tr>
<tr class="memitem:ae3f026ca4a62868027480260b407c607"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1noding_1_1snapround_1_1MCIndexPointSnapper.html#ae3f026ca4a62868027480260b407c607">MCIndexPointSnapper</a> (const <a class="el" href="classgeos_1_1noding_1_1snapround_1_1MCIndexPointSnapper.html">MCIndexPointSnapper</a> &amp;other)=delete</td></tr>
<tr class="separator:ae3f026ca4a62868027480260b407c607"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af04f396fe8998342f7c6a41b227467fd"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgeos_1_1noding_1_1snapround_1_1MCIndexPointSnapper.html">MCIndexPointSnapper</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1noding_1_1snapround_1_1MCIndexPointSnapper.html#af04f396fe8998342f7c6a41b227467fd">operator=</a> (const <a class="el" href="classgeos_1_1noding_1_1snapround_1_1MCIndexPointSnapper.html">MCIndexPointSnapper</a> &amp;rhs)=delete</td></tr>
<tr class="separator:af04f396fe8998342f7c6a41b227467fd"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:a8090e010c866eddf6a43226bdb772502"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgeos_1_1index_1_1SpatialIndex.html">index::SpatialIndex</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1noding_1_1snapround_1_1MCIndexPointSnapper.html#a8090e010c866eddf6a43226bdb772502">index</a></td></tr>
<tr class="separator:a8090e010c866eddf6a43226bdb772502"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-static-attribs"></a>
Static Private Attributes</h2></td></tr>
<tr class="memitem:a3d0c4a0fb08fbca251f076186dac43c6"><td class="memItemLeft" align="right" valign="top">static constexpr double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1noding_1_1snapround_1_1MCIndexPointSnapper.html#a3d0c4a0fb08fbca251f076186dac43c6">SAFE_ENV_EXPANSION_FACTOR</a> = 0.75</td></tr>
<tr class="separator:a3d0c4a0fb08fbca251f076186dac43c6"><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>"Snaps" all <a class="el" href="classgeos_1_1noding_1_1SegmentString.html">SegmentStrings</a> in a <a class="el" href="classgeos_1_1index_1_1SpatialIndex.html">SpatialIndex</a> containing <a class="el" href="classgeos_1_1index_1_1chain_1_1MonotoneChain.html">MonotoneChains</a> to a given <a class="el" href="classgeos_1_1noding_1_1snapround_1_1HotPixel.html" title="Implements a &quot;hot pixel&quot; as used in the Snap Rounding algorithm. ">HotPixel</a>. </p>
<p>Definition at line <a class="el" href="MCIndexPointSnapper_8h_source.html#l00052">52</a> of file <a class="el" href="MCIndexPointSnapper_8h_source.html">MCIndexPointSnapper.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="ae07d45ce9fbd2a568d7aa5288975a501"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">geos::noding::snapround::MCIndexPointSnapper::MCIndexPointSnapper </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classgeos_1_1index_1_1SpatialIndex.html">index::SpatialIndex</a> &amp;&#160;</td>
<td class="paramname"><em>nIndex</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="MCIndexPointSnapper_8h_source.html#l00057">57</a> of file <a class="el" href="MCIndexPointSnapper_8h_source.html">MCIndexPointSnapper.h</a>.</p>
</div>
</div>
<a class="anchor" id="ae3f026ca4a62868027480260b407c607"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">geos::noding::snapround::MCIndexPointSnapper::MCIndexPointSnapper </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classgeos_1_1noding_1_1snapround_1_1MCIndexPointSnapper.html">MCIndexPointSnapper</a> &amp;&#160;</td>
<td class="paramname"><em>other</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span><span class="mlabel">delete</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a1a8c4d1a2fd845bef74284d5f8628dfa"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classgeos_1_1geom_1_1Envelope.html">geom::Envelope</a> geos::noding::snapround::MCIndexPointSnapper::getSafeEnvelope </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classgeos_1_1noding_1_1snapround_1_1HotPixel.html">HotPixel</a> &amp;&#160;</td>
<td class="paramname"><em>hp</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="af04f396fe8998342f7c6a41b227467fd"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classgeos_1_1noding_1_1snapround_1_1MCIndexPointSnapper.html">MCIndexPointSnapper</a>&amp; geos::noding::snapround::MCIndexPointSnapper::operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classgeos_1_1noding_1_1snapround_1_1MCIndexPointSnapper.html">MCIndexPointSnapper</a> &amp;&#160;</td>
<td class="paramname"><em>rhs</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span><span class="mlabel">delete</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="abad906dd6d009cef61f1384aa67a9abc"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool geos::noding::snapround::MCIndexPointSnapper::snap </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classgeos_1_1noding_1_1snapround_1_1HotPixel.html">HotPixel</a> &amp;&#160;</td>
<td class="paramname"><em>hotPixel</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classgeos_1_1noding_1_1SegmentString.html">SegmentString</a> *&#160;</td>
<td class="paramname"><em>parentEdge</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>vertexIndex</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Snaps (nodes) all interacting segments to this hot pixel. </p>
<p>The hot pixel may represent a vertex of an edge, in which case this routine uses the optimization of not noding the vertex itself.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">hotPixel</td><td>the hot pixel to snap to </td></tr>
<tr><td class="paramname">parentEdge</td><td>the edge containing the vertex, if applicable, or <code>null</code> </td></tr>
<tr><td class="paramname">vertexIndex</td><td>the index of the vertex, if applicable, or -1 </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><code>true</code> if a node was added for this pixel </dd></dl>
</div>
</div>
<a class="anchor" id="aa598a2ad9b554aa939b8d83bd725e5f4"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool geos::noding::snapround::MCIndexPointSnapper::snap </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classgeos_1_1noding_1_1snapround_1_1HotPixel.html">HotPixel</a> &amp;&#160;</td>
<td class="paramname"><em>hotPixel</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="MCIndexPointSnapper_8h_source.html#l00078">78</a> of file <a class="el" href="MCIndexPointSnapper_8h_source.html">MCIndexPointSnapper.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="a8090e010c866eddf6a43226bdb772502"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classgeos_1_1index_1_1SpatialIndex.html">index::SpatialIndex</a>&amp; geos::noding::snapround::MCIndexPointSnapper::index</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="MCIndexPointSnapper_8h_source.html#l00090">90</a> of file <a class="el" href="MCIndexPointSnapper_8h_source.html">MCIndexPointSnapper.h</a>.</p>
</div>
</div>
<a class="anchor" id="a3d0c4a0fb08fbca251f076186dac43c6"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">constexpr double geos::noding::snapround::MCIndexPointSnapper::SAFE_ENV_EXPANSION_FACTOR = 0.75</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="MCIndexPointSnapper_8h_source.html#l00088">88</a> of file <a class="el" href="MCIndexPointSnapper_8h_source.html">MCIndexPointSnapper.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="MCIndexPointSnapper_8h_source.html">MCIndexPointSnapper.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.11
</small></address>
</body>
</html>