3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
4 <title>model::polygon</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 1. Geometry">
8 <link rel="up" href="../models.html" title="Models">
9 <link rel="prev" href="model_linestring.html" title="model::linestring">
10 <link rel="next" href="model_multi_point.html" title="model::multi_point">
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>
22 <div class="spirit-nav">
23 <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>
26 <div class="titlepage"><div><div><h4 class="title">
27 <a name="geometry.reference.models.model_polygon"></a><a class="link" href="model_polygon.html" title="model::polygon">model::polygon</a>
28 </h4></div></div></div>
30 <a class="indexterm" name="idm46186983184912"></a><a class="indexterm" name="idm46186983184224"></a>
31 The polygon contains an outer ring and zero or more inner rings.
34 <a name="geometry.reference.models.model_polygon.h0"></a>
35 <span class="phrase"><a name="geometry.reference.models.model_polygon.model_of"></a></span><a class="link" href="model_polygon.html#geometry.reference.models.model_polygon.model_of">Model
39 <a class="link" href="../concepts/concept_polygon.html" title="Polygon Concept">Polygon Concept</a>
42 <a name="geometry.reference.models.model_polygon.h1"></a>
43 <span class="phrase"><a name="geometry.reference.models.model_polygon.synopsis"></a></span><a class="link" href="model_polygon.html#geometry.reference.models.model_polygon.synopsis">Synopsis</a>
47 <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>
48 <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>
49 <span class="keyword">class</span> <span class="identifier">model</span><span class="special">::</span><span class="identifier">polygon</span>
50 <span class="special">{</span>
51 <span class="comment">// ...</span>
52 <span class="special">};</span>
57 <a name="geometry.reference.models.model_polygon.h2"></a>
58 <span class="phrase"><a name="geometry.reference.models.model_polygon.template_parameter_s_"></a></span><a class="link" href="model_polygon.html#geometry.reference.models.model_polygon.template_parameter_s_">Template
61 <div class="informaltable"><table class="table">
112 true for clockwise direction, false for CounterClockWise direction
129 true for closed polygons (last point == first point), false open
137 template< typename, typename > class PointList
147 container type for points, for example std::vector, std::deque
154 template< typename, typename > class RingList
164 container type for inner rings, for example std::vector, std::deque
171 template< typename > class PointAlloc
181 container-allocator-type, for the points
188 template< typename > class RingAlloc
198 container-allocator-type, for the rings
205 <a name="geometry.reference.models.model_polygon.h3"></a>
206 <span class="phrase"><a name="geometry.reference.models.model_polygon.constructor_s_"></a></span><a class="link" href="model_polygon.html#geometry.reference.models.model_polygon.constructor_s_">Constructor(s)</a>
208 <div class="informaltable"><table class="table">
236 <pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting"><span class="identifier">polygon</span><span class="special">()</span></pre>
242 Default constructor, creating an empty polygon.
252 <pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting"><span class="identifier">polygon</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">initializer_list</span><span class="special"><</span> <span class="identifier">ring_type</span> <span class="special">></span> <span class="identifier">l</span><span class="special">)</span></pre>
258 Constructor taking std::initializer_list, filling the polygon.
263 <span class="bold"><strong>std::initializer_list< ring_type ></strong></span>:
264 <span class="emphasis"><em>l</em></span>:
271 <a name="geometry.reference.models.model_polygon.h4"></a>
272 <span class="phrase"><a name="geometry.reference.models.model_polygon.member_function_s_"></a></span><a class="link" href="model_polygon.html#geometry.reference.models.model_polygon.member_function_s_">Member
275 <div class="informaltable"><table class="table">
309 <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>
324 <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>
339 <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>
354 <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>
369 <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>
375 Utility method, clears outer and inner rings.
386 <a name="geometry.reference.models.model_polygon.h5"></a>
387 <span class="phrase"><a name="geometry.reference.models.model_polygon.header"></a></span><a class="link" href="model_polygon.html#geometry.reference.models.model_polygon.header">Header</a>
393 <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>
399 <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>
402 <a name="geometry.reference.models.model_polygon.h6"></a>
403 <span class="phrase"><a name="geometry.reference.models.model_polygon.examples"></a></span><a class="link" href="model_polygon.html#geometry.reference.models.model_polygon.examples">Examples</a>
406 Declaration and use of the Boost.Geometry model::polygon, modelling the
411 <pre class="programlisting"><span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">iostream</span><span class="special">></span>
412 <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">hpp</span><span class="special">></span>
413 <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>
415 <span class="keyword">namespace</span> <span class="identifier">bg</span> <span class="special">=</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">geometry</span><span class="special">;</span>
417 <span class="keyword">int</span> <span class="identifier">main</span><span class="special">()</span>
418 <span class="special">{</span>
419 <span class="keyword">typedef</span> <span class="identifier">bg</span><span class="special">::</span><span class="identifier">model</span><span class="special">::</span><span class="identifier">point</span><span class="special"><</span><span class="keyword">double</span><span class="special">,</span> <span class="number">2</span><span class="special">,</span> <span class="identifier">bg</span><span class="special">::</span><span class="identifier">cs</span><span class="special">::</span><span class="identifier">cartesian</span><span class="special">></span> <span class="identifier">point_t</span><span class="special">;</span>
420 <span class="keyword">typedef</span> <span class="identifier">bg</span><span class="special">::</span><span class="identifier">model</span><span class="special">::</span><span class="identifier">polygon</span><span class="special"><</span><span class="identifier">point_t</span><span class="special">></span> <span class="identifier">polygon_t</span><span class="special">;</span> <a class="co" name="geometry.reference.models.model_polygon.c0" href="model_polygon.html#geometry.reference.models.model_polygon.c1"><img src="../../../../../../../doc/src/images/callouts/1.png" alt="1" border="0"></a>
422 <span class="identifier">polygon_t</span> <span class="identifier">poly1</span><span class="special">;</span> <a class="co" name="geometry.reference.models.model_polygon.c2" href="model_polygon.html#geometry.reference.models.model_polygon.c3"><img src="../../../../../../../doc/src/images/callouts/2.png" alt="2" border="0"></a>
424 <span class="preprocessor">#if</span> <span class="special">!</span><span class="identifier">defined</span><span class="special">(</span><span class="identifier">BOOST_NO_CXX11_UNIFIED_INITIALIZATION_SYNTAX</span><span class="special">)</span> <span class="special">\</span>
425 <span class="special">&&</span> <span class="special">!</span><span class="identifier">defined</span><span class="special">(</span><span class="identifier">BOOST_NO_CXX11_HDR_INITIALIZER_LIST</span><span class="special">)</span>
427 <span class="identifier">polygon_t</span> <span class="identifier">polygon2</span><span class="special">{{{</span><span class="number">0.0</span><span class="special">,</span> <span class="number">0.0</span><span class="special">},</span> <span class="special">{</span><span class="number">0.0</span><span class="special">,</span> <span class="number">5.0</span><span class="special">},</span> <span class="special">{</span><span class="number">5.0</span><span class="special">,</span> <span class="number">5.0</span><span class="special">},</span> <span class="special">{</span><span class="number">5.0</span><span class="special">,</span> <span class="number">0.0</span><span class="special">},</span> <span class="special">{</span><span class="number">0.0</span><span class="special">,</span> <span class="number">0.0</span><span class="special">}},</span>
428 <span class="special">{{</span><span class="number">1.0</span><span class="special">,</span> <span class="number">1.0</span><span class="special">},</span> <span class="special">{</span><span class="number">4.0</span><span class="special">,</span> <span class="number">1.0</span><span class="special">},</span> <span class="special">{</span><span class="number">4.0</span><span class="special">,</span> <span class="number">4.0</span><span class="special">},</span> <span class="special">{</span><span class="number">1.0</span><span class="special">,</span> <span class="number">4.0</span><span class="special">},</span> <span class="special">{</span><span class="number">1.0</span><span class="special">,</span> <span class="number">1.0</span><span class="special">}}};</span> <a class="co" name="geometry.reference.models.model_polygon.c4" href="model_polygon.html#geometry.reference.models.model_polygon.c5"><img src="../../../../../../../doc/src/images/callouts/3.png" alt="3" border="0"></a>
430 <span class="preprocessor">#endif</span>
432 <span class="identifier">bg</span><span class="special">::</span><span class="identifier">append</span><span class="special">(</span><span class="identifier">poly1</span><span class="special">.</span><span class="identifier">outer</span><span class="special">(),</span> <span class="identifier">point_t</span><span class="special">(</span><span class="number">0.0</span><span class="special">,</span> <span class="number">0.0</span><span class="special">));</span> <a class="co" name="geometry.reference.models.model_polygon.c6" href="model_polygon.html#geometry.reference.models.model_polygon.c7"><img src="../../../../../../../doc/src/images/callouts/4.png" alt="4" border="0"></a>
433 <span class="identifier">bg</span><span class="special">::</span><span class="identifier">append</span><span class="special">(</span><span class="identifier">poly1</span><span class="special">.</span><span class="identifier">outer</span><span class="special">(),</span> <span class="identifier">point_t</span><span class="special">(</span><span class="number">0.0</span><span class="special">,</span> <span class="number">5.0</span><span class="special">));</span>
434 <span class="identifier">bg</span><span class="special">::</span><span class="identifier">append</span><span class="special">(</span><span class="identifier">poly1</span><span class="special">.</span><span class="identifier">outer</span><span class="special">(),</span> <span class="identifier">point_t</span><span class="special">(</span><span class="number">5.0</span><span class="special">,</span> <span class="number">5.0</span><span class="special">));</span>
435 <span class="identifier">bg</span><span class="special">::</span><span class="identifier">append</span><span class="special">(</span><span class="identifier">poly1</span><span class="special">.</span><span class="identifier">outer</span><span class="special">(),</span> <span class="identifier">point_t</span><span class="special">(</span><span class="number">5.0</span><span class="special">,</span> <span class="number">0.0</span><span class="special">));</span>
436 <span class="identifier">bg</span><span class="special">::</span><span class="identifier">append</span><span class="special">(</span><span class="identifier">poly1</span><span class="special">.</span><span class="identifier">outer</span><span class="special">(),</span> <span class="identifier">point_t</span><span class="special">(</span><span class="number">0.0</span><span class="special">,</span> <span class="number">0.0</span><span class="special">));</span>
438 <span class="identifier">poly1</span><span class="special">.</span><span class="identifier">inners</span><span class="special">().</span><span class="identifier">resize</span><span class="special">(</span><span class="number">1</span><span class="special">);</span> <a class="co" name="geometry.reference.models.model_polygon.c8" href="model_polygon.html#geometry.reference.models.model_polygon.c9"><img src="../../../../../../../doc/src/images/callouts/5.png" alt="5" border="0"></a>
439 <span class="identifier">bg</span><span class="special">::</span><span class="identifier">append</span><span class="special">(</span><span class="identifier">poly1</span><span class="special">.</span><span class="identifier">inners</span><span class="special">()[</span><span class="number">0</span><span class="special">],</span> <span class="identifier">point_t</span><span class="special">(</span><span class="number">1.0</span><span class="special">,</span> <span class="number">1.0</span><span class="special">));</span> <a class="co" name="geometry.reference.models.model_polygon.c10" href="model_polygon.html#geometry.reference.models.model_polygon.c11"><img src="../../../../../../../doc/src/images/callouts/6.png" alt="6" border="0"></a>
440 <span class="identifier">bg</span><span class="special">::</span><span class="identifier">append</span><span class="special">(</span><span class="identifier">poly1</span><span class="special">.</span><span class="identifier">inners</span><span class="special">()[</span><span class="number">0</span><span class="special">],</span> <span class="identifier">point_t</span><span class="special">(</span><span class="number">4.0</span><span class="special">,</span> <span class="number">1.0</span><span class="special">));</span>
441 <span class="identifier">bg</span><span class="special">::</span><span class="identifier">append</span><span class="special">(</span><span class="identifier">poly1</span><span class="special">.</span><span class="identifier">inners</span><span class="special">()[</span><span class="number">0</span><span class="special">],</span> <span class="identifier">point_t</span><span class="special">(</span><span class="number">4.0</span><span class="special">,</span> <span class="number">4.0</span><span class="special">));</span>
442 <span class="identifier">bg</span><span class="special">::</span><span class="identifier">append</span><span class="special">(</span><span class="identifier">poly1</span><span class="special">.</span><span class="identifier">inners</span><span class="special">()[</span><span class="number">0</span><span class="special">],</span> <span class="identifier">point_t</span><span class="special">(</span><span class="number">1.0</span><span class="special">,</span> <span class="number">4.0</span><span class="special">));</span>
443 <span class="identifier">bg</span><span class="special">::</span><span class="identifier">append</span><span class="special">(</span><span class="identifier">poly1</span><span class="special">.</span><span class="identifier">inners</span><span class="special">()[</span><span class="number">0</span><span class="special">],</span> <span class="identifier">point_t</span><span class="special">(</span><span class="number">1.0</span><span class="special">,</span> <span class="number">1.0</span><span class="special">));</span>
445 <span class="keyword">double</span> <span class="identifier">a</span> <span class="special">=</span> <span class="identifier">bg</span><span class="special">::</span><span class="identifier">area</span><span class="special">(</span><span class="identifier">poly1</span><span class="special">);</span>
447 <span class="identifier">std</span><span class="special">::</span><span class="identifier">cout</span> <span class="special"><<</span> <span class="identifier">a</span> <span class="special"><<</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">endl</span><span class="special">;</span>
449 <span class="keyword">return</span> <span class="number">0</span><span class="special">;</span>
450 <span class="special">}</span>
454 <div class="calloutlist"><table border="0" summary="Callout list">
456 <td width="5%" valign="top" align="left"><p><a name="geometry.reference.models.model_polygon.c1"></a><a href="#geometry.reference.models.model_polygon.c0"><img src="../../../../../../../doc/src/images/callouts/1.png" alt="1" border="0"></a> </p></td>
457 <td valign="top" align="left"><p>
458 Default parameters, clockwise, closed polygon.
462 <td width="5%" valign="top" align="left"><p><a name="geometry.reference.models.model_polygon.c3"></a><a href="#geometry.reference.models.model_polygon.c2"><img src="../../../../../../../doc/src/images/callouts/2.png" alt="2" border="0"></a> </p></td>
463 <td valign="top" align="left"><p>
464 Default-construct a polygon.
468 <td width="5%" valign="top" align="left"><p><a name="geometry.reference.models.model_polygon.c5"></a><a href="#geometry.reference.models.model_polygon.c4"><img src="../../../../../../../doc/src/images/callouts/3.png" alt="3" border="0"></a> </p></td>
469 <td valign="top" align="left"><p>
470 Construct a polygon containing an exterior and interior ring, using
471 C++11 unified initialization syntax.
475 <td width="5%" valign="top" align="left"><p><a name="geometry.reference.models.model_polygon.c7"></a><a href="#geometry.reference.models.model_polygon.c6"><img src="../../../../../../../doc/src/images/callouts/4.png" alt="4" border="0"></a> </p></td>
476 <td valign="top" align="left"><p>
477 Append point to the exterior ring.
481 <td width="5%" valign="top" align="left"><p><a name="geometry.reference.models.model_polygon.c9"></a><a href="#geometry.reference.models.model_polygon.c8"><img src="../../../../../../../doc/src/images/callouts/5.png" alt="5" border="0"></a> </p></td>
482 <td valign="top" align="left"><p>
483 Resize a container of interior rings.
487 <td width="5%" valign="top" align="left"><p><a name="geometry.reference.models.model_polygon.c11"></a><a href="#geometry.reference.models.model_polygon.c10"><img src="../../../../../../../doc/src/images/callouts/6.png" alt="6" border="0"></a> </p></td>
488 <td valign="top" align="left"><p>
489 Append point to the interior ring.
496 <pre class="programlisting">16
499 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
500 <td align="left"></td>
501 <td align="right"><div class="copyright-footer">Copyright © 2009-2019 Barend Gehrels, Bruno Lalande, Mateusz Loskot, Adam
502 Wulkiewicz, Oracle and/or its affiliates<p>
503 Distributed under the Boost Software License, Version 1.0. (See accompanying
504 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>)
509 <div class="spirit-nav">
510 <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>