mirror of
https://github.com/boostorg/geometry.git
synced 2025-05-12 14:01:47 +00:00
133 lines
7.1 KiB
HTML
133 lines
7.1 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
||
<html>
|
||
<head>
|
||
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
|
||
<title>Boost.Geometry (aka GGL, Generic Geometry Library)</title>
|
||
<link href="doxygen.css" rel="stylesheet" type="text/css">
|
||
<link href="tabs.css" rel="stylesheet" type="text/css">
|
||
</head>
|
||
|
||
<table cellpadding="2" width="100%">
|
||
<tbody>
|
||
<tr>
|
||
<td valign="top">
|
||
<img alt="Boost.Geometry" src="images/ggl-logo-big.png" height="80" width="200">
|
||
|
||
</td>
|
||
<td valign="top" align="right">
|
||
<a href="http://www.boost.org">
|
||
<img alt="Boost C++ Libraries" src="images/accepted_by_boost.png" height="80" width="230" border="0">
|
||
</a>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<!-- Generated by Doxygen 1.5.9 -->
|
||
<div class="navigation" id="top">
|
||
<div class="tabs">
|
||
<ul>
|
||
<li><a href="index.html"><span>Main Page</span></a></li>
|
||
<li><a href="pages.html"><span>Related Pages</span></a></li>
|
||
<li><a href="modules.html"><span>Modules</span></a></li>
|
||
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
|
||
<li><a href="annotated.html"><span>Classes</span></a></li>
|
||
<li><a href="files.html"><span>Files</span></a></li>
|
||
<li><a href="examples.html"><span>Examples</span></a></li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
<div class="contents">
|
||
<h1>selection: check if a geometry is "selected" by a point</h1><table border="0" cellpadding="0" cellspacing="0">
|
||
<tr><td></td></tr>
|
||
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
|
||
<tr><td class="memTemplParams" nowrap colspan="2">template<typename Geometry , typename Point , typename RadiusType > </td></tr>
|
||
<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__selected.html#gfa35b0560d5c1296cc974b3f477a9f5c">boost::geometry::selected</a> (Geometry const &geometry, Point const &selection_point, RadiusType const &search_radius)</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Checks if one <a class="el" href="namespaceboost_1_1geometry.html">geometry</a> is selected by a <a class="el" href="classboost_1_1geometry_1_1point.html" title="Basic point class, having coordinates defined in a neutral way.">point</a> lying within or in the neighborhood of that <a class="el" href="namespaceboost_1_1geometry.html">geometry</a>. <a href="#gfa35b0560d5c1296cc974b3f477a9f5c"></a><br></td></tr>
|
||
</table>
|
||
<hr><a name="_details"></a><h2>Detailed Description</h2>
|
||
Checks if one geometry is selected by a point lying within or in the neighborhood of that geometry<p>
|
||
<dl class="user" compact><dt><b>Geometries:</b></dt><dd><ul>
|
||
<li>POINT: checks if points are CLOSE TO each other (< search_radius)</li><li>LINESTRING: checks if selection point is CLOSE TO linestring (< search_radius)</li><li>RING: checks if selection point is INSIDE the ring, search radius is ignored</li><li>POLYGON: checks if selection point is INSIDE the polygon, but not inside any of its holes </li></ul>
|
||
</dd></dl>
|
||
<hr><h2>Function Documentation</h2>
|
||
<a class="anchor" name="gfa35b0560d5c1296cc974b3f477a9f5c"></a><!-- doxytag: member="boost::geometry::selected" ref="gfa35b0560d5c1296cc974b3f477a9f5c" args="(Geometry const &geometry, Point const &selection_point, RadiusType const &search_radius)" -->
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<div class="memtemplate">
|
||
template<typename Geometry , typename Point , typename RadiusType > </div>
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">bool boost::geometry::selected </td>
|
||
<td>(</td>
|
||
<td class="paramtype">Geometry const & </td>
|
||
<td class="paramname"> <em>geometry</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype">Point const & </td>
|
||
<td class="paramname"> <em>selection_point</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype">RadiusType const & </td>
|
||
<td class="paramname"> <em>search_radius</em></td><td> </td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td>)</td>
|
||
<td></td><td></td><td></td>
|
||
</tr>
|
||
</table>
|
||
</div>
|
||
<div class="memdoc">
|
||
|
||
<p>
|
||
Checks if one <a class="el" href="namespaceboost_1_1geometry.html">geometry</a> is selected by a <a class="el" href="classboost_1_1geometry_1_1point.html" title="Basic point class, having coordinates defined in a neutral way.">point</a> lying within or in the neighborhood of that <a class="el" href="namespaceboost_1_1geometry.html">geometry</a>.
|
||
<p>
|
||
<dl compact><dt><b>Template Parameters:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td valign="top"></td><td valign="top"><em>Geometry</em> </td><td>type of <a class="el" href="namespaceboost_1_1geometry.html">geometry</a> to check </td></tr>
|
||
<tr><td valign="top"></td><td valign="top"><em>Point</em> </td><td>type of <a class="el" href="classboost_1_1geometry_1_1point.html" title="Basic point class, having coordinates defined in a neutral way.">point</a> to check </td></tr>
|
||
<tr><td valign="top"></td><td valign="top"><em>T</em> </td><td>type of search radius </td></tr>
|
||
</table>
|
||
</dl>
|
||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td valign="top"></td><td valign="top"><em><a class="el" href="namespaceboost_1_1geometry.html">geometry</a></em> </td><td><a class="el" href="namespaceboost_1_1geometry.html">geometry</a> which might be located in the neighborhood </td></tr>
|
||
<tr><td valign="top"></td><td valign="top"><em>selection_point</em> </td><td><a class="el" href="classboost_1_1geometry_1_1point.html" title="Basic point class, having coordinates defined in a neutral way.">point</a> to select the <a class="el" href="namespaceboost_1_1geometry.html">geometry</a> </td></tr>
|
||
<tr><td valign="top"></td><td valign="top"><em>search_radius</em> </td><td>for points/linestrings: defines radius of "neighborhood" to find things in </td></tr>
|
||
</table>
|
||
</dl>
|
||
<dl class="return" compact><dt><b>Returns:</b></dt><dd>true if <a class="el" href="classboost_1_1geometry_1_1point.html" title="Basic point class, having coordinates defined in a neutral way.">point</a> is within or close to the other <a class="el" href="namespaceboost_1_1geometry.html">geometry</a> </dd></dl>
|
||
|
||
<p>Definition at line <a class="el" href="selected_8hpp_source.html#l00266">266</a> of file <a class="el" href="selected_8hpp_source.html">selected.hpp</a>.</p>
|
||
|
||
</div>
|
||
</div><p>
|
||
</div>
|
||
<hr size="1">
|
||
<table width="100%">
|
||
<tbody>
|
||
<tr>
|
||
<td align="left"><small>
|
||
<p>December 1, 2009</p>
|
||
</small></td>
|
||
<td align="right">
|
||
<small>Copyright <20> 1995-2009 Barend Gehrels, Geodan, Amsterdam<br>
|
||
Copyright <20> 2008-2009 Bruno Lalande, Paris<br>
|
||
Copyright <20> 2009 Mateusz Loskot, Cadcorp, London<br>
|
||
</small>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
|
||
<address style="text-align: right;"><small>
|
||
Documentation is generated by <a href="http://www.doxygen.org/index.html">Doxygen</a>
|
||
</small></address>
|
||
</body>
|
||
</html>
|