libs/geometry/doc/html/geometry/reference/strategies/strategy_within_winding.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>strategy::within::winding</title>
   5 <link rel="stylesheet" href="../../../../../../../doc/src/boostbook.css" type="text/css">
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
   7 <link rel="home" href="../../../index.html" title="Chapter&#160;1.&#160;Geometry">
   8 <link rel="up" href="../strategies.html" title="Strategies">
   9 <link rel="prev" href="strategy_transform_matrix_transformer.html" title="strategy::transform::matrix_transformer">
  10 <link rel="next" href="strategy_within_franklin.html" title="strategy::within::franklin">
  11 </head>
  12 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  13 <table cellpadding="2" width="100%"><tr>
  14 <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../boost.png"></td>
  15 <td align="center"><a href="../../../../../../../index.html">Home</a></td>
  16 <td align="center"><a href="../../../../../../../libs/libraries.htm">Libraries</a></td>
  17 <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
  18 <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
  19 <td align="center"><a href="../../../../../../../more/index.htm">More</a></td>
  20 </tr></table>
  21 <hr>
  22 <div class="spirit-nav">
  23 <a accesskey="p" href="strategy_transform_matrix_transformer.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../strategies.html"><img src="../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="strategy_within_franklin.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="section">
  26 <div class="titlepage"><div><div><h4 class="title">
  27 <a name="geometry.reference.strategies.strategy_within_winding"></a><a class="link" href="strategy_within_winding.html" title="strategy::within::winding">strategy::within::winding</a>
  28 </h4></div></div></div>
  29 <p>
  30           <a class="indexterm" name="idm46186970951904"></a><a class="indexterm" name="idm46186970951216"></a><a class="indexterm" name="idm46186970950528"></a>
  31 Within detection using winding rule. Side strategy used internally is choosen
  32           based on Point's coordinate system.
  33         </p>
  34 <h6>
  35 <a name="geometry.reference.strategies.strategy_within_winding.h0"></a>
  36           <span class="phrase"><a name="geometry.reference.strategies.strategy_within_winding.synopsis"></a></span><a class="link" href="strategy_within_winding.html#geometry.reference.strategies.strategy_within_winding.synopsis">Synopsis</a>
  37         </h6>
  38 <p>
  39 </p>
  40 <pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">Point</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">PointOfSegment</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">CalculationType</span><span class="special">&gt;</span>
  41 <span class="keyword">class</span> <span class="identifier">strategy</span><span class="special">::</span><span class="identifier">within</span><span class="special">::</span><span class="identifier">winding</span>
  42       <span class="special">:</span> <span class="keyword">public</span> <span class="identifier">within</span><span class="special">::</span><span class="identifier">detail</span><span class="special">::</span><span class="identifier">winding_base_type</span><span class="special">::</span><span class="identifier">type</span><span class="special">&lt;</span> <span class="identifier">Point</span><span class="special">,</span> <span class="identifier">PointOfSegment</span><span class="special">,</span> <span class="identifier">CalculationType</span> <span class="special">&gt;</span>
  43 <span class="special">{</span>
  44   <span class="comment">// ...</span>
  45 <span class="special">};</span>
  46 </pre>
  47 <p>
  48         </p>
  49 <h6>
  50 <a name="geometry.reference.strategies.strategy_within_winding.h1"></a>
  51           <span class="phrase"><a name="geometry.reference.strategies.strategy_within_winding.template_parameter_s_"></a></span><a class="link" href="strategy_within_winding.html#geometry.reference.strategies.strategy_within_winding.template_parameter_s_">Template
  52           parameter(s)</a>
  53         </h6>
  54 <div class="informaltable"><table class="table">
  55 <colgroup>
  56 <col>
  57 <col>
  58 <col>
  59 </colgroup>
  60 <thead><tr>
  61 <th>
  62                   <p>
  63                     Parameter
  64                   </p>
  65                 </th>
  66 <th>
  67                   <p>
  68                     Default
  69                   </p>
  70                 </th>
  71 <th>
  72                   <p>
  73                     Description
  74                   </p>
  75                 </th>
  76 </tr></thead>
  77 <tbody>
  78 <tr>
  79 <td>
  80                   <p>
  81                     typename Point
  82                   </p>
  83                 </td>
  84 <td>
  85                 </td>
  86 <td>
  87                   <p>
  88                     Any type fulfilling a Point Concept
  89                   </p>
  90                 </td>
  91 </tr>
  92 <tr>
  93 <td>
  94                   <p>
  95                     typename PointOfSegment
  96                   </p>
  97                 </td>
  98 <td>
  99                   <p>
 100                     Point
 101                   </p>
 102                 </td>
 103 <td>
 104                   <p>
 105                     segment point type
 106                   </p>
 107                 </td>
 108 </tr>
 109 <tr>
 110 <td>
 111                   <p>
 112                     typename CalculationType
 113                   </p>
 114                 </td>
 115 <td>
 116                   <p>
 117                     void
 118                   </p>
 119                 </td>
 120 <td>
 121                   <p>
 122                     numeric type for calculation (e.g. high precision); if <span class="bold"><strong>void</strong></span> then it is extracted automatically
 123                     from the coordinate type and (if necessary) promoted to floating
 124                     point
 125                   </p>
 126                 </td>
 127 </tr>
 128 </tbody>
 129 </table></div>
 130 <h6>
 131 <a name="geometry.reference.strategies.strategy_within_winding.h2"></a>
 132           <span class="phrase"><a name="geometry.reference.strategies.strategy_within_winding.constructor_s_"></a></span><a class="link" href="strategy_within_winding.html#geometry.reference.strategies.strategy_within_winding.constructor_s_">Constructor(s)</a>
 133         </h6>
 134 <div class="informaltable"><table class="table">
 135 <colgroup>
 136 <col>
 137 <col>
 138 <col>
 139 </colgroup>
 140 <thead><tr>
 141 <th>
 142                   <p>
 143                     Function
 144                   </p>
 145                 </th>
 146 <th>
 147                   <p>
 148                     Description
 149                   </p>
 150                 </th>
 151 <th>
 152                   <p>
 153                     Parameters
 154                   </p>
 155                 </th>
 156 </tr></thead>
 157 <tbody>
 158 <tr>
 159 <td>
 160                   <p>
 161 </p>
 162 <pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting"><span class="identifier">winding</span><span class="special">()</span></pre>
 163 <p>
 164                   </p>
 165                 </td>
 166 <td>
 167                 </td>
 168 <td>
 169                 </td>
 170 </tr>
 171 <tr>
 172 <td>
 173                   <p>
 174 </p>
 175 <pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">Model</span><span class="special">&gt;</span>
 176 <span class="identifier">winding</span><span class="special">(</span><span class="identifier">Model</span> <span class="keyword">const</span> <span class="special">&amp;</span> <span class="identifier">model</span><span class="special">)</span></pre>
 177 <p>
 178                   </p>
 179                 </td>
 180 <td>
 181                 </td>
 182 <td>
 183                   <p>
 184                     <span class="bold"><strong>Model const &amp;</strong></span>: <span class="emphasis"><em>model</em></span>:
 185                   </p>
 186                 </td>
 187 </tr>
 188 </tbody>
 189 </table></div>
 190 <h6>
 191 <a name="geometry.reference.strategies.strategy_within_winding.h3"></a>
 192           <span class="phrase"><a name="geometry.reference.strategies.strategy_within_winding.header"></a></span><a class="link" href="strategy_within_winding.html#geometry.reference.strategies.strategy_within_winding.header">Header</a>
 193         </h6>
 194 <p>
 195           <code class="computeroutput"><span class="preprocessor">#include</span> <span class="special">&lt;</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">geometry</span><span class="special">/</span><span class="identifier">strategies</span><span class="special">/</span><span class="identifier">agnostic</span><span class="special">/</span><span class="identifier">point_in_poly_winding</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span></code>
 196         </p>
 197 <h6>
 198 <a name="geometry.reference.strategies.strategy_within_winding.h4"></a>
 199           <span class="phrase"><a name="geometry.reference.strategies.strategy_within_winding.see_also"></a></span><a class="link" href="strategy_within_winding.html#geometry.reference.strategies.strategy_within_winding.see_also">See
 200           also</a>
 201         </h6>
 202 <p>
 203           <a class="link" href="../algorithms/within/within_3_with_strategy.html" title="within (with strategy)">within
 204           (with strategy)</a>
 205         </p>
 206 </div>
 207 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 208 <td align="left"></td>
 209 <td align="right"><div class="copyright-footer">Copyright &#169; 2009-2019 Barend Gehrels, Bruno Lalande, Mateusz Loskot, Adam
 210       Wulkiewicz, Oracle and/or its affiliates<p>
 211         Distributed under the Boost Software License, Version 1.0. (See accompanying
 212         file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
 213       </p>
 214 </div></td>
 215 </tr></table>
 216 <hr>
 217 <div class="spirit-nav">
 218 <a accesskey="p" href="strategy_transform_matrix_transformer.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../strategies.html"><img src="../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="strategy_within_franklin.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
 219 </div>
 220 </body>
 221 </html>