| <html> |
| <head> |
| <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> |
| <title>model::polygon</title> |
| <link rel="stylesheet" href="../../../../../../../doc/src/boostbook.css" type="text/css"> |
| <meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> |
| <link rel="home" href="../../../index.html" title="Chapter 1. Geometry 1.0"> |
| <link rel="up" href="../models.html" title="Models"> |
| <link rel="prev" href="model_linestring.html" title="model::linestring"> |
| <link rel="next" href="model_multi_point.html" title="model::multi_point"> |
| </head> |
| <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> |
| <table cellpadding="2" width="100%"><tr> |
| <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../boost.png"></td> |
| <td align="center"><a href="../../../../../../../index.html">Home</a></td> |
| <td align="center"><a href="../../../../../../../libs/libraries.htm">Libraries</a></td> |
| <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> |
| <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> |
| <td align="center"><a href="../../../../../../../more/index.htm">More</a></td> |
| </tr></table> |
| <hr> |
| <div class="spirit-nav"> |
| <a accesskey="p" href="model_linestring.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../models.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="model_multi_point.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a> |
| </div> |
| <div class="section"> |
| <div class="titlepage"><div><div><h4 class="title"> |
| <a name="geometry.reference.models.model_polygon"></a><a class="link" href="model_polygon.html" title="model::polygon">model::polygon</a> |
| </h4></div></div></div> |
| <p> |
| <a class="indexterm" name="id936921"></a><a class="indexterm" name="id936926"></a> |
| The polygon contains an outer ring and zero or more inner rings. |
| </p> |
| <a name="geometry.reference.models.model_polygon.model_of"></a><h6> |
| <a name="geometry.reference.models.model_polygon.model_of-heading"></a> |
| <a class="link" href="model_polygon.html#geometry.reference.models.model_polygon.model_of">Model |
| of</a> |
| </h6> |
| <p> |
| <a class="link" href="../concepts/concept_polygon.html" title="Polygon Concept">Polygon Concept</a> |
| </p> |
| <a name="geometry.reference.models.model_polygon.synopsis"></a><h6> |
| <a name="geometry.reference.models.model_polygon.synopsis-heading"></a> |
| <a class="link" href="model_polygon.html#geometry.reference.models.model_polygon.synopsis">Synopsis</a> |
| </h6> |
| <p> |
| |
| </p> |
| <pre class="programlisting"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> <span class="identifier">Point</span><span class="special">,</span> <span class="keyword">bool</span> <span class="identifier">ClockWise</span><span class="special">,</span> <span class="keyword">bool</span> <span class="identifier">Closed</span><span class="special">,</span> <span class="keyword">template</span><span class="special"><</span> <span class="keyword">typename</span><span class="special">,</span> <span class="keyword">typename</span> <span class="special">></span> <span class="keyword">class</span> <span class="identifier">PointList</span><span class="special">,</span> <span class="keyword">template</span><span class="special"><</span> <span class="keyword">typename</span><span class="special">,</span> <span class="keyword">typename</span> <span class="special">></span> <span class="keyword">class</span> <span class="identifier">RingList</span><span class="special">,</span> <span class="keyword">template</span><span class="special"><</span> <span class="keyword">typename</span> <span class="special">></span> <span class="keyword">class</span> <span class="identifier">PointAlloc</span><span class="special">,</span> <span class="keyword">template</span><span class="special"><</span> <span class="keyword">typename</span> <span class="special">></span> <span class="keyword">class</span> <span class="identifier">RingAlloc</span><span class="special">></span> |
| <span class="keyword">class</span> <span class="identifier">model</span><span class="special">::</span><span class="identifier">polygon</span> |
| <span class="special">{</span> |
| <span class="comment">// ...</span> |
| <span class="special">};</span> |
| </pre> |
| <p> |
| </p> |
| <a name="geometry.reference.models.model_polygon.template_parameter_s_"></a><h6> |
| <a name="geometry.reference.models.model_polygon.template_parameter_s_-heading"></a> |
| <a class="link" href="model_polygon.html#geometry.reference.models.model_polygon.template_parameter_s_">Template |
| parameter(s)</a> |
| </h6> |
| <div class="informaltable"><table class="table"> |
| <colgroup> |
| <col> |
| <col> |
| <col> |
| </colgroup> |
| <thead><tr> |
| <th> |
| <p> |
| Parameter |
| </p> |
| </th> |
| <th> |
| <p> |
| Default |
| </p> |
| </th> |
| <th> |
| <p> |
| Description |
| </p> |
| </th> |
| </tr></thead> |
| <tbody> |
| <tr> |
| <td> |
| <p> |
| typename Point |
| </p> |
| </td> |
| <td> |
| </td> |
| <td> |
| <p> |
| point type |
| </p> |
| </td> |
| </tr> |
| <tr> |
| <td> |
| <p> |
| bool ClockWise |
| </p> |
| </td> |
| <td> |
| <p> |
| true |
| </p> |
| </td> |
| <td> |
| <p> |
| true for clockwise direction, false for CounterClockWise direction |
| </p> |
| </td> |
| </tr> |
| <tr> |
| <td> |
| <p> |
| bool Closed |
| </p> |
| </td> |
| <td> |
| <p> |
| true |
| </p> |
| </td> |
| <td> |
| <p> |
| true for closed polygons (last point == first point), false open |
| points |
| </p> |
| </td> |
| </tr> |
| <tr> |
| <td> |
| <p> |
| template< typename, typename > class PointList |
| </p> |
| </td> |
| <td> |
| <p> |
| std::vector |
| </p> |
| </td> |
| <td> |
| <p> |
| container type for points, for example std::vector, std::list, |
| std::deque |
| </p> |
| </td> |
| </tr> |
| <tr> |
| <td> |
| <p> |
| template< typename, typename > class RingList |
| </p> |
| </td> |
| <td> |
| <p> |
| std::vector |
| </p> |
| </td> |
| <td> |
| <p> |
| container type for inner rings, for example std::vector, std::list, |
| std::deque |
| </p> |
| </td> |
| </tr> |
| <tr> |
| <td> |
| <p> |
| template< typename > class PointAlloc |
| </p> |
| </td> |
| <td> |
| <p> |
| std::allocator |
| </p> |
| </td> |
| <td> |
| <p> |
| container-allocator-type, for the points |
| </p> |
| </td> |
| </tr> |
| <tr> |
| <td> |
| <p> |
| template< typename > class RingAlloc |
| </p> |
| </td> |
| <td> |
| <p> |
| std::allocator |
| </p> |
| </td> |
| <td> |
| <p> |
| container-allocator-type, for the rings |
| </p> |
| </td> |
| </tr> |
| </tbody> |
| </table></div> |
| <a name="geometry.reference.models.model_polygon.member_function_s_"></a><h6> |
| <a name="geometry.reference.models.model_polygon.member_function_s_-heading"></a> |
| <a class="link" href="model_polygon.html#geometry.reference.models.model_polygon.member_function_s_">Member |
| Function(s)</a> |
| </h6> |
| <div class="informaltable"><table class="table"> |
| <colgroup> |
| <col> |
| <col> |
| <col> |
| </colgroup> |
| <thead><tr> |
| <th> |
| <p> |
| Function |
| </p> |
| </th> |
| <th> |
| <p> |
| Description |
| </p> |
| </th> |
| <th> |
| <p> |
| Parameters |
| </p> |
| </th> |
| <th> |
| <p> |
| Returns |
| </p> |
| </th> |
| </tr></thead> |
| <tbody> |
| <tr> |
| <td> |
| <p> |
| |
| </p> |
| <pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting"><span class="identifier">ring_type</span> <span class="keyword">const</span> <span class="special">&</span> <span class="identifier">outer</span><span class="special">()</span></pre> |
| <p> |
| </p> |
| </td> |
| <td> |
| </td> |
| <td> |
| </td> |
| </tr> |
| <tr> |
| <td> |
| <p> |
| |
| </p> |
| <pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting"><span class="identifier">inner_container_type</span> <span class="keyword">const</span> <span class="special">&</span> <span class="identifier">inners</span><span class="special">()</span></pre> |
| <p> |
| </p> |
| </td> |
| <td> |
| </td> |
| <td> |
| </td> |
| </tr> |
| <tr> |
| <td> |
| <p> |
| |
| </p> |
| <pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting"><span class="identifier">ring_type</span> <span class="special">&</span> <span class="identifier">outer</span><span class="special">()</span></pre> |
| <p> |
| </p> |
| </td> |
| <td> |
| </td> |
| <td> |
| </td> |
| </tr> |
| <tr> |
| <td> |
| <p> |
| |
| </p> |
| <pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting"><span class="identifier">inner_container_type</span> <span class="special">&</span> <span class="identifier">inners</span><span class="special">()</span></pre> |
| <p> |
| </p> |
| </td> |
| <td> |
| </td> |
| <td> |
| </td> |
| </tr> |
| <tr> |
| <td> |
| <p> |
| |
| </p> |
| <pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting"><span class="keyword">void</span> <span class="identifier">clear</span><span class="special">()</span></pre> |
| <p> |
| </p> |
| </td> |
| <td> |
| <p> |
| Utility method, clears outer and inner rings. |
| </p> |
| </td> |
| <td> |
| </td> |
| </tr> |
| </tbody> |
| </table></div> |
| <a name="geometry.reference.models.model_polygon.header"></a><h6> |
| <a name="geometry.reference.models.model_polygon.header-heading"></a> |
| <a class="link" href="model_polygon.html#geometry.reference.models.model_polygon.header">Header</a> |
| </h6> |
| <p> |
| Either |
| </p> |
| <p> |
| <code class="computeroutput"><span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">geometry</span><span class="special">/</span><span class="identifier">geometries</span><span class="special">/</span><span class="identifier">geometries</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> |
| </p> |
| <p> |
| Or |
| </p> |
| <p> |
| <code class="computeroutput"><span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">geometry</span><span class="special">/</span><span class="identifier">geometries</span><span class="special">/</span><span class="identifier">polygon</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> |
| </p> |
| </div> |
| <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> |
| <td align="left"></td> |
| <td align="right"><div class="copyright-footer">Copyright © 2011 Barend Gehrels, Bruno Lalande, Mateusz Loskot<p> |
| Distributed under the Boost Software License, Version 1.0. (See accompanying |
| 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>) |
| </p> |
| </div></td> |
| </tr></table> |
| <hr> |
| <div class="spirit-nav"> |
| <a accesskey="p" href="model_linestring.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../models.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="model_multi_point.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a> |
| </div> |
| </body> |
| </html> |