libs/geometry/doc/html/geometry/reference/enumerations/order_selector.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>order_selector</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="../enumerations.html" title="Enumerations">
   9 <link rel="prev" href="join_selector.html" title="join_selector">
  10 <link rel="next" href="piece_type.html" title="piece_type">
  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="join_selector.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../enumerations.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="piece_type.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.enumerations.order_selector"></a><a class="link" href="order_selector.html" title="order_selector">order_selector</a>
  28 </h4></div></div></div>
  29 <p>
  30           <a class="indexterm" name="idp110592032"></a>
  31 <a class="indexterm" name="idp110592848"></a>
  32 <a class="indexterm" name="idp110593664"></a>
  33 <a class="indexterm" name="idp110594480"></a>
  34 Enumerates options for the order of points within polygons.
  35         </p>
  36 <h6>
  37 <a name="geometry.reference.enumerations.order_selector.h0"></a>
  38           <span class="phrase"><a name="geometry.reference.enumerations.order_selector.description"></a></span><a class="link" href="order_selector.html#geometry.reference.enumerations.order_selector.description">Description</a>
  39         </h6>
  40 <p>
  41           The enumeration order_selector describes options for the order of points
  42           within a polygon. Polygons can be ordered either clockwise or counterclockwise.
  43           The specific order of a polygon type is defined by the point_order metafunction.
  44           The point_order metafunction defines a value, which is one of the values
  45           enumerated in the order_selector
  46         </p>
  47 <h6>
  48 <a name="geometry.reference.enumerations.order_selector.h1"></a>
  49           <span class="phrase"><a name="geometry.reference.enumerations.order_selector.synopsis"></a></span><a class="link" href="order_selector.html#geometry.reference.enumerations.order_selector.synopsis">Synopsis</a>
  50         </h6>
  51 <p>
  52 </p>
  53 <pre class="programlisting"><span class="keyword">enum</span> <span class="identifier">order_selector</span> <span class="special">{</span><span class="identifier">clockwise</span> <span class="special">=</span> <span class="number">1</span><span class="special">,</span> <span class="identifier">counterclockwise</span> <span class="special">=</span> <span class="number">2</span><span class="special">,</span> <span class="identifier">order_undetermined</span> <span class="special">=</span> <span class="number">0</span><span class="special">};</span></pre>
  54 <p>
  55         </p>
  56 <h6>
  57 <a name="geometry.reference.enumerations.order_selector.h2"></a>
  58           <span class="phrase"><a name="geometry.reference.enumerations.order_selector.values"></a></span><a class="link" href="order_selector.html#geometry.reference.enumerations.order_selector.values">Values</a>
  59         </h6>
  60 <div class="informaltable"><table class="table">
  61 <colgroup>
  62 <col>
  63 <col>
  64 </colgroup>
  65 <thead><tr>
  66 <th>
  67                   <p>
  68                     Value
  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                     clockwise
  82                   </p>
  83                 </td>
  84 <td>
  85                   <p>
  86                     Points are ordered clockwise.
  87                   </p>
  88                 </td>
  89 </tr>
  90 <tr>
  91 <td>
  92                   <p>
  93                     counterclockwise
  94                   </p>
  95                 </td>
  96 <td>
  97                   <p>
  98                     Points are ordered counter clockwise.
  99                   </p>
 100                 </td>
 101 </tr>
 102 <tr>
 103 <td>
 104                   <p>
 105                     order_undetermined
 106                   </p>
 107                 </td>
 108 <td>
 109                   <p>
 110                     Points might be stored in any order, algorithms will determine
 111                     it on the fly (not yet supported)
 112                   </p>
 113                 </td>
 114 </tr>
 115 </tbody>
 116 </table></div>
 117 <h6>
 118 <a name="geometry.reference.enumerations.order_selector.h3"></a>
 119           <span class="phrase"><a name="geometry.reference.enumerations.order_selector.header"></a></span><a class="link" href="order_selector.html#geometry.reference.enumerations.order_selector.header">Header</a>
 120         </h6>
 121 <p>
 122           Either
 123         </p>
 124 <p>
 125           <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">hpp</span><span class="special">&gt;</span></code>
 126         </p>
 127 <p>
 128           Or
 129         </p>
 130 <p>
 131           <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">core</span><span class="special">/</span><span class="identifier">point_order</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span></code>
 132         </p>
 133 <h6>
 134 <a name="geometry.reference.enumerations.order_selector.h4"></a>
 135           <span class="phrase"><a name="geometry.reference.enumerations.order_selector.see_also"></a></span><a class="link" href="order_selector.html#geometry.reference.enumerations.order_selector.see_also">See also</a>
 136         </h6>
 137 <p>
 138           <a class="link" href="../core/point_order.html" title="point_order">The point_order metafunction</a>
 139         </p>
 140 </div>
 141 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 142 <td align="left"></td>
 143 <td align="right"><div class="copyright-footer">Copyright &#169; 2009-2017 Barend
 144       Gehrels, Bruno Lalande, Mateusz Loskot, Adam Wulkiewicz, Oracle and/or its
 145       affiliates<p>
 146         Distributed under the Boost Software License, Version 1.0. (See accompanying
 147         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>)
 148       </p>
 149 </div></td>
 150 </tr></table>
 151 <hr>
 152 <div class="spirit-nav">
 153 <a accesskey="p" href="join_selector.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../enumerations.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="piece_type.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
 154 </div>
 155 </body>
 156 </html>