libs/geometry/doc/doxy/doxygen_output/html_by_doxygen/group__covered__by.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html>
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
   5 <title>Boost.Geometry (aka GGL, Generic Geometry Library)</title>
   6 <link href="doxygen.css" rel="stylesheet" type="text/css">
   7 <link href="tabs.css" rel="stylesheet" type="text/css">
   8 </head>
   9 <table cellpadding="2" width="100%">
  10 <tbody>
  11 <tr>
  12 <td valign="top">
  13 <img alt="Boost.Geometry" src="images/ggl-logo-big.png" height="80" width="200">
  14 &nbsp;&nbsp;
  15 </td>
  16 <td valign="top" align="right">
  17 <a href="http://www.boost.org">
  18 <img alt="Boost C++ Libraries" src="images/accepted_by_boost.png" height="80" width="230" border="0">
  19 </a>
  20 </td>
  21 </tr>
  22 </tbody>
  23 </table>
  24 <!-- Generated by Doxygen 1.8.6 -->
  25   <div id="navrow1" class="tabs">
  26     <ul class="tablist">
  27       <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  28       <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
  29       <li><a href="modules.html"><span>Modules</span></a></li>
  30       <li><a href="namespaces.html"><span>Namespaces</span></a></li>
  31       <li><a href="annotated.html"><span>Classes</span></a></li>
  32       <li><a href="files.html"><span>Files</span></a></li>
  33       <li><a href="examples.html"><span>Examples</span></a></li>
  34     </ul>
  35   </div>
  36 </div><!-- top -->
  37 <div class="header">
  38   <div class="summary">
  39 <a href="#nested-classes">Classes</a> &#124;
  40 <a href="#func-members">Functions</a>  </div>
  41   <div class="headertitle">
  42 <div class="title">covered_by: detect if a geometry is inside or on the border of another geometry, a.o. point-in-polygon (border included)</div>  </div>
  43 </div><!--header-->
  44 <div class="contents">
  45 <table class="memberdecls">
  46 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
  47 Classes</h2></td></tr>
  48 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structboost_1_1geometry_1_1strategy_1_1covered__by_1_1services_1_1default__strategy.html">boost::geometry::strategy::covered_by::services::default_strategy&lt; TagContained, TagContaining, CastedTagContained, CastedTagContaining, CsTagContained, CsTagContaining, GeometryContained, GeometryContaining &gt;</a></td></tr>
  49 <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Traits class binding a <a class="el" href="namespaceboost_1_1geometry_1_1strategy_1_1covered__by.html">covered_by</a> determination strategy to a coordinate system.  <a href="structboost_1_1geometry_1_1strategy_1_1covered__by_1_1services_1_1default__strategy.html#details">More...</a><br/></td></tr>
  50 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  51 </table><table class="memberdecls">
  52 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  53 Functions</h2></td></tr>
  54 <tr class="memitem:ga83cfa260c6a4f3bcba5a99da6113d19c"><td class="memTemplParams" colspan="2">template&lt;typename Geometry1 , typename Geometry2 &gt; </td></tr>
  55 <tr class="memitem:ga83cfa260c6a4f3bcba5a99da6113d19c"><td class="memTemplItemLeft" align="right" valign="top">bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__covered__by.html#ga83cfa260c6a4f3bcba5a99da6113d19c">boost::geometry::covered_by</a> (Geometry1 const &amp;geometry1, Geometry2 const &amp;geometry2)</td></tr>
  56 <tr class="memdesc:ga83cfa260c6a4f3bcba5a99da6113d19c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks if the first geometry is inside or on border the second geometry.  <a href="#ga83cfa260c6a4f3bcba5a99da6113d19c">More...</a><br/></td></tr>
  57 <tr class="separator:ga83cfa260c6a4f3bcba5a99da6113d19c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  58 <tr class="memitem:ga4db6801730953629ec9eb040a5ccc1ad"><td class="memTemplParams" colspan="2">template&lt;typename Geometry1 , typename Geometry2 , typename Strategy &gt; </td></tr>
  59 <tr class="memitem:ga4db6801730953629ec9eb040a5ccc1ad"><td class="memTemplItemLeft" align="right" valign="top">bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__covered__by.html#ga4db6801730953629ec9eb040a5ccc1ad">boost::geometry::covered_by</a> (Geometry1 const &amp;geometry1, Geometry2 const &amp;geometry2, Strategy const &amp;strategy)</td></tr>
  60 <tr class="memdesc:ga4db6801730953629ec9eb040a5ccc1ad"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks if the first geometry is inside or on border the second geometry using the specified strategy.  <a href="#ga4db6801730953629ec9eb040a5ccc1ad">More...</a><br/></td></tr>
  61 <tr class="separator:ga4db6801730953629ec9eb040a5ccc1ad"><td class="memSeparator" colspan="2">&#160;</td></tr>
  62 </table>
  63 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  64 <h2 class="groupheader">Function Documentation</h2>
  65 <a class="anchor" id="ga83cfa260c6a4f3bcba5a99da6113d19c"></a>
  66 <div class="memitem">
  67 <div class="memproto">
  68 <div class="memtemplate">
  69 template&lt;typename Geometry1 , typename Geometry2 &gt; </div>
  70       <table class="memname">
  71         <tr>
  72           <td class="memname">bool boost::geometry::covered_by </td>
  73           <td>(</td>
  74           <td class="paramtype">Geometry1 const &amp;&#160;</td>
  75           <td class="paramname"><em>geometry1</em>, </td>
  76         </tr>
  77         <tr>
  78           <td class="paramkey"></td>
  79           <td></td>
  80           <td class="paramtype">Geometry2 const &amp;&#160;</td>
  81           <td class="paramname"><em>geometry2</em>&#160;</td>
  82         </tr>
  83         <tr>
  84           <td></td>
  85           <td>)</td>
  86           <td></td><td></td>
  87         </tr>
  88       </table>
  89 </div><div class="memdoc">
  90
  91 <p>Checks if the first geometry is inside or on border the second geometry. </p>
  92 <p>The free function covered_by checks if the first geometry is inside or on border the second geometry. </p>
  93 <dl class="tparams"><dt>Template Parameters</dt><dd>
  94   <table class="tparams">
  95     <tr><td class="paramname">Geometry1</td><td>Any type fulfilling a Geometry Concept </td></tr>
  96     <tr><td class="paramname">Geometry2</td><td>Any type fulfilling a Geometry Concept </td></tr>
  97   </table>
  98   </dd>
  99 </dl>
 100 <dl class="params"><dt>Parameters</dt><dd>
 101   <table class="params">
 102     <tr><td class="paramname">geometry1</td><td>A model of the specified concept which might be inside or on the border of the second geometry </td></tr>
 103     <tr><td class="paramname">geometry2</td><td>A model of the specified concept which might cover the first geometry </td></tr>
 104   </table>
 105   </dd>
 106 </dl>
 107 <dl class="section return"><dt>Returns</dt><dd>true if geometry1 is inside of or on the border of geometry2, else false </dd></dl>
 108 <dl class="section note"><dt>Note</dt><dd>The default strategy is used for covered_by detection</dd></dl>
 109
 110 </div>
 111 </div>
 112 <a class="anchor" id="ga4db6801730953629ec9eb040a5ccc1ad"></a>
 113 <div class="memitem">
 114 <div class="memproto">
 115 <div class="memtemplate">
 116 template&lt;typename Geometry1 , typename Geometry2 , typename Strategy &gt; </div>
 117       <table class="memname">
 118         <tr>
 119           <td class="memname">bool boost::geometry::covered_by </td>
 120           <td>(</td>
 121           <td class="paramtype">Geometry1 const &amp;&#160;</td>
 122           <td class="paramname"><em>geometry1</em>, </td>
 123         </tr>
 124         <tr>
 125           <td class="paramkey"></td>
 126           <td></td>
 127           <td class="paramtype">Geometry2 const &amp;&#160;</td>
 128           <td class="paramname"><em>geometry2</em>, </td>
 129         </tr>
 130         <tr>
 131           <td class="paramkey"></td>
 132           <td></td>
 133           <td class="paramtype">Strategy const &amp;&#160;</td>
 134           <td class="paramname"><em>strategy</em>&#160;</td>
 135         </tr>
 136         <tr>
 137           <td></td>
 138           <td>)</td>
 139           <td></td><td></td>
 140         </tr>
 141       </table>
 142 </div><div class="memdoc">
 143
 144 <p>Checks if the first geometry is inside or on border the second geometry using the specified strategy. </p>
 145 <p>The free function covered_by checks if the first geometry is inside or on border the second geometry, using the specified strategy. Reasons to specify a strategy include: use another coordinate system for calculations; construct the strategy beforehand (e.g. with the radius of the Earth); select a strategy when there are more than one available for a calculation. </p>
 146 <dl class="tparams"><dt>Template Parameters</dt><dd>
 147   <table class="tparams">
 148     <tr><td class="paramname">Geometry1</td><td>Any type fulfilling a Geometry Concept </td></tr>
 149     <tr><td class="paramname">Geometry2</td><td>Any type fulfilling a Geometry Concept </td></tr>
 150   </table>
 151   </dd>
 152 </dl>
 153 <dl class="params"><dt>Parameters</dt><dd>
 154   <table class="params">
 155     <tr><td class="paramname">geometry1</td><td>A model of the specified concept which might be inside or on the border of the second geometry </td></tr>
 156     <tr><td class="paramname">geometry2</td><td>A model of the specified concept which might cover the first geometry </td></tr>
 157     <tr><td class="paramname">strategy</td><td>strategy to be used </td></tr>
 158   </table>
 159   </dd>
 160 </dl>
 161 <dl class="section return"><dt>Returns</dt><dd>true if geometry1 is inside of or on the border of geometry2, else false</dd></dl>
 162
 163 </div>
 164 </div>
 165 </div><!-- contents -->
 166 <hr size="1">
 167 <table width="100%">
 168 <tbody>
 169 <tr>
 170 <td align="left"><small>
 171 <p>April 2, 2011</p>
 172 </small></td>
 173 <td align="right">
 174 <small>
 175 Copyright &copy; 2007-2011 Barend Gehrels, Amsterdam, the Netherlands<br>
 176 Copyright &copy; 2008-2011 Bruno Lalande, Paris, France<br>
 177 Copyright &copy; 2009-2010 Mateusz Loskot, London, UK<br>
 178 </small>
 179 </td>
 180 </tr>
 181 </tbody>
 182 </table>
 183 <address style="text-align: right;"><small>
 184 Documentation is generated by&nbsp;<a href="http://www.doxygen.org/index.html">Doxygen</a>
 185 </small></address>
 186 </body>
 187 </html>