libs/geometry/doc/doxy/doxygen_output/html_by_doxygen/classboost_1_1geometry_1_1strategy_1_1within_1_1oriented__winding.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 class="current"><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 id="navrow2" class="tabs2">
  37     <ul class="tablist">
  38       <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
  39       <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
  40       <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
  41       <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
  42     </ul>
  43   </div>
  44 <div id="nav-path" class="navpath">
  45   <ul>
  46 <li class="navelem"><a class="el" href="namespaceboost.html">boost</a></li><li class="navelem"><a class="el" href="namespaceboost_1_1geometry.html">geometry</a></li><li class="navelem"><a class="el" href="namespaceboost_1_1geometry_1_1strategy.html">strategy</a></li><li class="navelem"><a class="el" href="namespaceboost_1_1geometry_1_1strategy_1_1within.html">within</a></li><li class="navelem"><a class="el" href="classboost_1_1geometry_1_1strategy_1_1within_1_1oriented__winding.html">oriented_winding</a></li>  </ul>
  47 </div>
  48 </div><!-- top -->
  49 <div class="header">
  50   <div class="summary">
  51 <a href="#nested-classes">Classes</a> &#124;
  52 <a href="#pub-types">Public Types</a> &#124;
  53 <a href="#pub-static-methods">Static Public Member Functions</a> &#124;
  54 <a href="classboost_1_1geometry_1_1strategy_1_1within_1_1oriented__winding-members.html">List of all members</a>  </div>
  55   <div class="headertitle">
  56 <div class="title">boost::geometry::strategy::within::oriented_winding&lt; Reverse, Point, PointOfSegment, CalculationType &gt; Class Template Reference<div class="ingroups"><a class="el" href="group__strategies.html">strategies: strategies</a></div></div>  </div>
  57 </div><!--header-->
  58 <div class="contents">
  59
  60 <p>Within detection using winding rule, but checking if enclosing ring is counter clockwise and, if so, reverses the result.
  61  <a href="classboost_1_1geometry_1_1strategy_1_1within_1_1oriented__winding.html#details">More...</a></p>
  62 <table class="memberdecls">
  63 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
  64 Public Types</h2></td></tr>
  65 <tr class="memitem:a1a9990ce7f34e7f9fb067ae787b70aaf"><td class="memItemLeft" align="right" valign="top">typedef Point&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1geometry_1_1strategy_1_1within_1_1oriented__winding.html#a1a9990ce7f34e7f9fb067ae787b70aaf">point_type</a></td></tr>
  66 <tr class="separator:a1a9990ce7f34e7f9fb067ae787b70aaf"><td class="memSeparator" colspan="2">&#160;</td></tr>
  67 <tr class="memitem:a6d13eff63c68a31615cef239196ecfbd"><td class="memItemLeft" align="right" valign="top">typedef PointOfSegment&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1geometry_1_1strategy_1_1within_1_1oriented__winding.html#a6d13eff63c68a31615cef239196ecfbd">segment_point_type</a></td></tr>
  68 <tr class="separator:a6d13eff63c68a31615cef239196ecfbd"><td class="memSeparator" colspan="2">&#160;</td></tr>
  69 <tr class="memitem:a907a009e6a246cb3a9354782c8fd4917"><td class="memItemLeft" align="right" valign="top">typedef counter&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1geometry_1_1strategy_1_1within_1_1oriented__winding.html#a907a009e6a246cb3a9354782c8fd4917">state_type</a></td></tr>
  70 <tr class="separator:a907a009e6a246cb3a9354782c8fd4917"><td class="memSeparator" colspan="2">&#160;</td></tr>
  71 </table><table class="memberdecls">
  72 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
  73 Static Public Member Functions</h2></td></tr>
  74 <tr class="memitem:a7dd9a2108e9f4794e619391c2745f44e"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1geometry_1_1strategy_1_1within_1_1oriented__winding.html#a7dd9a2108e9f4794e619391c2745f44e">apply</a> (Point const &amp;point, PointOfSegment const &amp;s1, PointOfSegment const &amp;s2, counter &amp;state)</td></tr>
  75 <tr class="separator:a7dd9a2108e9f4794e619391c2745f44e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  76 <tr class="memitem:a974c60d5af7c7521b8d98e797ef9a1be"><td class="memItemLeft" align="right" valign="top">static int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1geometry_1_1strategy_1_1within_1_1oriented__winding.html#a974c60d5af7c7521b8d98e797ef9a1be">result</a> (counter const &amp;state)</td></tr>
  77 <tr class="separator:a974c60d5af7c7521b8d98e797ef9a1be"><td class="memSeparator" colspan="2">&#160;</td></tr>
  78 </table>
  79 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  80 <div class="textblock"><h3>template&lt;bool Reverse, typename Point, typename PointOfSegment = Point, typename CalculationType = void&gt;<br/>
  81 class boost::geometry::strategy::within::oriented_winding&lt; Reverse, Point, PointOfSegment, CalculationType &gt;</h3>
  82
  83 <p>Within detection using winding rule, but checking if enclosing ring is counter clockwise and, if so, reverses the result. </p>
  84 <dl class="tparams"><dt>Template Parameters</dt><dd>
  85   <table class="tparams">
  86     <tr><td class="paramname">Point</td><td>Any type fulfilling a Point Concept </td></tr>
  87     <tr><td class="paramname">Reverse</td><td>True if parameter should be reversed </td></tr>
  88     <tr><td class="paramname">PointOfSegment</td><td>segment point type </td></tr>
  89     <tr><td class="paramname">CalculationType</td><td>numeric type for calculation (e.g. high precision); if [*void] then it is extracted automatically from the coordinate type and (if necessary) promoted to floating point </td></tr>
  90   </table>
  91   </dd>
  92 </dl>
  93 <dl class="section author"><dt>Author</dt><dd>Barend Gehrels </dd></dl>
  94 <dl class="section note"><dt>Note</dt><dd>The implementation is inspired by terralib <a href="http://www.terralib.org">http://www.terralib.org</a> (LGPL) </dd>
  95 <dd>
  96 but totally revised afterwards, especially for cases on segments </dd>
  97 <dd>
  98 Only dependant on "side", -&gt; agnostic, suitable for spherical/latlong</dd></dl>
  99  </div><h2 class="groupheader">Member Typedef Documentation</h2>
 100 <a class="anchor" id="a1a9990ce7f34e7f9fb067ae787b70aaf"></a>
 101 <div class="memitem">
 102 <div class="memproto">
 103 <div class="memtemplate">
 104 template&lt;bool Reverse, typename Point , typename PointOfSegment  = Point, typename CalculationType  = void&gt; </div>
 105       <table class="memname">
 106         <tr>
 107           <td class="memname">typedef Point <a class="el" href="classboost_1_1geometry_1_1strategy_1_1within_1_1oriented__winding.html">boost::geometry::strategy::within::oriented_winding</a>&lt; Reverse, Point, PointOfSegment, CalculationType &gt;::<a class="el" href="classboost_1_1geometry_1_1strategy_1_1within_1_1oriented__winding.html#a1a9990ce7f34e7f9fb067ae787b70aaf">point_type</a></td>
 108         </tr>
 109       </table>
 110 </div><div class="memdoc">
 111
 112 </div>
 113 </div>
 114 <a class="anchor" id="a6d13eff63c68a31615cef239196ecfbd"></a>
 115 <div class="memitem">
 116 <div class="memproto">
 117 <div class="memtemplate">
 118 template&lt;bool Reverse, typename Point , typename PointOfSegment  = Point, typename CalculationType  = void&gt; </div>
 119       <table class="memname">
 120         <tr>
 121           <td class="memname">typedef PointOfSegment <a class="el" href="classboost_1_1geometry_1_1strategy_1_1within_1_1oriented__winding.html">boost::geometry::strategy::within::oriented_winding</a>&lt; Reverse, Point, PointOfSegment, CalculationType &gt;::<a class="el" href="classboost_1_1geometry_1_1strategy_1_1within_1_1oriented__winding.html#a6d13eff63c68a31615cef239196ecfbd">segment_point_type</a></td>
 122         </tr>
 123       </table>
 124 </div><div class="memdoc">
 125
 126 </div>
 127 </div>
 128 <a class="anchor" id="a907a009e6a246cb3a9354782c8fd4917"></a>
 129 <div class="memitem">
 130 <div class="memproto">
 131 <div class="memtemplate">
 132 template&lt;bool Reverse, typename Point , typename PointOfSegment  = Point, typename CalculationType  = void&gt; </div>
 133       <table class="memname">
 134         <tr>
 135           <td class="memname">typedef counter <a class="el" href="classboost_1_1geometry_1_1strategy_1_1within_1_1oriented__winding.html">boost::geometry::strategy::within::oriented_winding</a>&lt; Reverse, Point, PointOfSegment, CalculationType &gt;::<a class="el" href="classboost_1_1geometry_1_1strategy_1_1within_1_1oriented__winding.html#a907a009e6a246cb3a9354782c8fd4917">state_type</a></td>
 136         </tr>
 137       </table>
 138 </div><div class="memdoc">
 139
 140 </div>
 141 </div>
 142 <h2 class="groupheader">Member Function Documentation</h2>
 143 <a class="anchor" id="a7dd9a2108e9f4794e619391c2745f44e"></a>
 144 <div class="memitem">
 145 <div class="memproto">
 146 <div class="memtemplate">
 147 template&lt;bool Reverse, typename Point , typename PointOfSegment  = Point, typename CalculationType  = void&gt; </div>
 148 <table class="mlabels">
 149   <tr>
 150   <td class="mlabels-left">
 151       <table class="memname">
 152         <tr>
 153           <td class="memname">static bool <a class="el" href="classboost_1_1geometry_1_1strategy_1_1within_1_1oriented__winding.html">boost::geometry::strategy::within::oriented_winding</a>&lt; Reverse, Point, PointOfSegment, CalculationType &gt;::apply </td>
 154           <td>(</td>
 155           <td class="paramtype">Point const &amp;&#160;</td>
 156           <td class="paramname"><em>point</em>, </td>
 157         </tr>
 158         <tr>
 159           <td class="paramkey"></td>
 160           <td></td>
 161           <td class="paramtype">PointOfSegment const &amp;&#160;</td>
 162           <td class="paramname"><em>s1</em>, </td>
 163         </tr>
 164         <tr>
 165           <td class="paramkey"></td>
 166           <td></td>
 167           <td class="paramtype">PointOfSegment const &amp;&#160;</td>
 168           <td class="paramname"><em>s2</em>, </td>
 169         </tr>
 170         <tr>
 171           <td class="paramkey"></td>
 172           <td></td>
 173           <td class="paramtype">counter &amp;&#160;</td>
 174           <td class="paramname"><em>state</em>&#160;</td>
 175         </tr>
 176         <tr>
 177           <td></td>
 178           <td>)</td>
 179           <td></td><td></td>
 180         </tr>
 181       </table>
 182   </td>
 183   <td class="mlabels-right">
 184 <span class="mlabels"><span class="mlabel">static</span></span>  </td>
 185   </tr>
 186 </table>
 187 </div><div class="memdoc">
 188
 189 </div>
 190 </div>
 191 <a class="anchor" id="a974c60d5af7c7521b8d98e797ef9a1be"></a>
 192 <div class="memitem">
 193 <div class="memproto">
 194 <div class="memtemplate">
 195 template&lt;bool Reverse, typename Point , typename PointOfSegment  = Point, typename CalculationType  = void&gt; </div>
 196 <table class="mlabels">
 197   <tr>
 198   <td class="mlabels-left">
 199       <table class="memname">
 200         <tr>
 201           <td class="memname">static int <a class="el" href="classboost_1_1geometry_1_1strategy_1_1within_1_1oriented__winding.html">boost::geometry::strategy::within::oriented_winding</a>&lt; Reverse, Point, PointOfSegment, CalculationType &gt;::result </td>
 202           <td>(</td>
 203           <td class="paramtype">counter const &amp;&#160;</td>
 204           <td class="paramname"><em>state</em></td><td>)</td>
 205           <td></td>
 206         </tr>
 207       </table>
 208   </td>
 209   <td class="mlabels-right">
 210 <span class="mlabels"><span class="mlabel">static</span></span>  </td>
 211   </tr>
 212 </table>
 213 </div><div class="memdoc">
 214
 215 </div>
 216 </div>
 217 </div><!-- contents -->
 218 <hr size="1">
 219 <table width="100%">
 220 <tbody>
 221 <tr>
 222 <td align="left"><small>
 223 <p>April 2, 2011</p>
 224 </small></td>
 225 <td align="right">
 226 <small>
 227 Copyright &copy; 2007-2011 Barend Gehrels, Amsterdam, the Netherlands<br>
 228 Copyright &copy; 2008-2011 Bruno Lalande, Paris, France<br>
 229 Copyright &copy; 2009-2010 Mateusz Loskot, London, UK<br>
 230 </small>
 231 </td>
 232 </tr>
 233 </tbody>
 234 </table>
 235 <address style="text-align: right;"><small>
 236 Documentation is generated by&nbsp;<a href="http://www.doxygen.org/index.html">Doxygen</a>
 237 </small></address>
 238 </body>
 239 </html>