boost/geometry
2
0
Fork 0
mirror of https://github.com/boostorg/geometry.git synced 2026-02-20 02:42:10 +00:00
Code Issues Projects Releases Wiki Activity
Files
1609ce14ee1ff0e37ea31799c3cd1ea599759d69
geometry/doc/doxygen_output/html/polygon_8hpp_source.html
Barend Gehrels 363580fbf6 Added old doxygen docs 
[SVN r59777]
2010-02-20 15:57:12 +00:00

240 lines
21 KiB
HTML
Raw Blame History

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Boost.Geometry (aka GGL, Generic Geometry Library)</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head>
<table cellpadding="2" width="100%">
<tbody>
<tr>
<td valign="top">
<img alt="Boost.Geometry" src="images/ggl-logo-big.png" height="80" width="200">
&nbsp;&nbsp;
</td>
<td valign="top" align="right">
<a href="http://www.boost.org">
<img alt="Boost C++ Libraries" src="images/accepted_by_boost.png" height="80" width="230" border="0">
</a>
</td>
</tr>
</tbody>
</table>
<!-- Generated by Doxygen 1.5.9 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
<li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="files.html"><span>File&nbsp;List</span></a></li>
<li><a href="globals.html"><span>File&nbsp;Members</span></a></li>
</ul>
</div>
<h1>boost/geometry/geometries/polygon.hpp</h1><a href="polygon_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">// Boost.Geometry (aka GGL, Generic Geometry Library)</span>
<a name="l00002"></a>00002 <span class="comment">//</span>
<a name="l00003"></a>00003 <span class="comment">// Copyright Barend Gehrels 2007-2009, Geodan, Amsterdam, the Netherlands.</span>
<a name="l00004"></a>00004 <span class="comment">// Copyright Bruno Lalande 2008, 2009</span>
<a name="l00005"></a>00005 <span class="comment">// Use, modification and distribution is subject to the Boost Software License,</span>
<a name="l00006"></a>00006 <span class="comment">// Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at</span>
<a name="l00007"></a>00007 <span class="comment">// http://www.boost.org/LICENSE_1_0.txt)</span>
<a name="l00008"></a>00008
<a name="l00009"></a>00009 <span class="preprocessor">#ifndef BOOST_GEOMETRY_GEOMETRIES_POLYGON_HPP</span>
<a name="l00010"></a>00010 <span class="preprocessor"></span><span class="preprocessor">#define BOOST_GEOMETRY_GEOMETRIES_POLYGON_HPP</span>
<a name="l00011"></a>00011 <span class="preprocessor"></span>
<a name="l00012"></a>00012 <span class="preprocessor">#include &lt;memory&gt;</span>
<a name="l00013"></a>00013 <span class="preprocessor">#include &lt;vector&gt;</span>
<a name="l00014"></a>00014
<a name="l00015"></a>00015 <span class="preprocessor">#include &lt;boost/concept/assert.hpp&gt;</span>
<a name="l00016"></a>00016
<a name="l00017"></a>00017 <span class="preprocessor">#include &lt;<a class="code" href="exterior__ring_8hpp.html">boost/geometry/core/exterior_ring.hpp</a>&gt;</span>
<a name="l00018"></a>00018 <span class="preprocessor">#include &lt;<a class="code" href="interior__rings_8hpp.html">boost/geometry/core/interior_rings.hpp</a>&gt;</span>
<a name="l00019"></a>00019 <span class="preprocessor">#include &lt;<a class="code" href="core_2point__type_8hpp.html">boost/geometry/core/point_type.hpp</a>&gt;</span>
<a name="l00020"></a>00020 <span class="preprocessor">#include &lt;<a class="code" href="core_2ring__type_8hpp.html">boost/geometry/core/ring_type.hpp</a>&gt;</span>
<a name="l00021"></a>00021 <span class="preprocessor">#include &lt;<a class="code" href="point__concept_8hpp.html">boost/geometry/geometries/concepts/point_concept.hpp</a>&gt;</span>
<a name="l00022"></a>00022 <span class="preprocessor">#include &lt;<a class="code" href="linear__ring_8hpp.html">boost/geometry/geometries/linear_ring.hpp</a>&gt;</span>
<a name="l00023"></a>00023
<a name="l00024"></a>00024 <span class="keyword">namespace </span>boost { <span class="keyword">namespace </span>geometry
<a name="l00025"></a>00025 {
<a name="l00026"></a>00026
<a name="l00042"></a>00042 <span class="keyword">template</span>
<a name="l00043"></a>00043 &lt;
<a name="l00044"></a>00044 <span class="keyword">typename</span> Point,
<a name="l00045"></a>00045 <span class="keyword">template</span>&lt;<span class="keyword">typename</span>, <span class="keyword">typename</span>&gt; <span class="keyword">class </span><a class="code" href="class_point_list.html">PointList</a> = std::vector,
<a name="l00046"></a>00046 <span class="keyword">template</span>&lt;<span class="keyword">typename</span>, <span class="keyword">typename</span>&gt; <span class="keyword">class </span>RingList = std::vector,
<a name="l00047"></a>00047 <span class="keywordtype">bool</span> ClockWise = <span class="keyword">true</span>,
<a name="l00048"></a>00048 <span class="keyword">template</span>&lt;<span class="keyword">typename</span>&gt; <span class="keyword">class </span>PointAlloc = std::allocator,
<a name="l00049"></a>00049 <span class="keyword">template</span>&lt;<span class="keyword">typename</span>&gt; <span class="keyword">class </span>RingAlloc = std::allocator
<a name="l00050"></a>00050 &gt;
<a name="l00051"></a><a class="code" href="classboost_1_1geometry_1_1polygon.html">00051</a> <span class="keyword">class </span><a class="code" href="classboost_1_1geometry_1_1polygon.html" title="The polygon contains an outer ring and zero or more inner rings.">polygon</a>
<a name="l00052"></a>00052 {
<a name="l00053"></a>00053 BOOST_CONCEPT_ASSERT( (<a class="code" href="classboost_1_1geometry_1_1concept_1_1_point.html" title="Point concept.">concept::Point&lt;Point&gt;</a>) );
<a name="l00054"></a>00054
<a name="l00055"></a>00055 <span class="keyword">public</span>:
<a name="l00056"></a>00056
<a name="l00057"></a>00057 <span class="comment">// Member types</span>
<a name="l00058"></a><a class="code" href="classboost_1_1geometry_1_1polygon.html#c5ef90e2689ef4eb4ca231120e144a00">00058</a> <span class="keyword">typedef</span> Point <a class="code" href="structboost_1_1geometry_1_1point__type.html" title="Meta-function which defines point type of any geometry.">point_type</a>;
<a name="l00059"></a><a class="code" href="classboost_1_1geometry_1_1polygon.html#7d9afee4461ef40b8940aa6652e32785">00059</a> <span class="keyword">typedef</span> <a class="code" href="classboost_1_1geometry_1_1linear__ring.html">linear_ring&lt;Point, PointList, ClockWise, PointAlloc&gt;</a> <a class="code" href="classboost_1_1geometry_1_1linear__ring.html">ring_type</a>;
<a name="l00060"></a><a class="code" href="classboost_1_1geometry_1_1polygon.html#1933b7ecad0bdd523cd2d80f580dc7ce">00060</a> <span class="keyword">typedef</span> RingList&lt;ring_type , RingAlloc&lt;ring_type &gt; &gt; <a class="code" href="classboost_1_1geometry_1_1polygon.html#1933b7ecad0bdd523cd2d80f580dc7ce">inner_container_type</a>;
<a name="l00061"></a>00061
<a name="l00062"></a><a class="code" href="classboost_1_1geometry_1_1polygon.html#a0efb41fda66b78d48cfc45a1753b05a">00062</a> <span class="keyword">inline</span> <a class="code" href="classboost_1_1geometry_1_1linear__ring.html">ring_type</a> <span class="keyword">const</span>&amp; <a class="code" href="classboost_1_1geometry_1_1polygon.html#a0efb41fda66b78d48cfc45a1753b05a">outer</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> m_outer; }
<a name="l00063"></a><a class="code" href="classboost_1_1geometry_1_1polygon.html#f2193847220f83dead7633a9c5ef5833">00063</a> <span class="keyword">inline</span> <a class="code" href="classboost_1_1geometry_1_1polygon.html#1933b7ecad0bdd523cd2d80f580dc7ce">inner_container_type</a> <span class="keyword">const</span>&amp; <a class="code" href="classboost_1_1geometry_1_1polygon.html#f2193847220f83dead7633a9c5ef5833">inners</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> m_inners; }
<a name="l00064"></a>00064
<a name="l00065"></a><a class="code" href="classboost_1_1geometry_1_1polygon.html#9e139947a8a05c6ee344e93bf61f0f38">00065</a> <span class="keyword">inline</span> <a class="code" href="classboost_1_1geometry_1_1linear__ring.html">ring_type</a>&amp; <a class="code" href="classboost_1_1geometry_1_1polygon.html#9e139947a8a05c6ee344e93bf61f0f38">outer</a>() { <span class="keywordflow">return</span> m_outer; }
<a name="l00066"></a><a class="code" href="classboost_1_1geometry_1_1polygon.html#766bf7810096f51e78144b9122a4a91b">00066</a> <span class="keyword">inline</span> <a class="code" href="classboost_1_1geometry_1_1polygon.html#1933b7ecad0bdd523cd2d80f580dc7ce">inner_container_type</a> &amp; <a class="code" href="classboost_1_1geometry_1_1polygon.html#766bf7810096f51e78144b9122a4a91b">inners</a>() { <span class="keywordflow">return</span> m_inners; }
<a name="l00067"></a>00067
<a name="l00069"></a><a class="code" href="classboost_1_1geometry_1_1polygon.html#15ede9231bee210c6f0833cedb319432">00069</a> <span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code" href="classboost_1_1geometry_1_1polygon.html#15ede9231bee210c6f0833cedb319432" title="Utility method, clears outer and inner rings.">clear</a>()
<a name="l00070"></a>00070 {
<a name="l00071"></a>00071 m_outer.clear();
<a name="l00072"></a>00072 m_inners.clear();
<a name="l00073"></a>00073 }
<a name="l00074"></a>00074
<a name="l00075"></a>00075 <span class="keyword">private</span>:
<a name="l00076"></a>00076
<a name="l00077"></a>00077 <a class="code" href="structboost_1_1geometry_1_1ring__type.html" title="Meta-function which defines ring type of (multi)polygon geometry.">ring_type</a> m_outer;
<a name="l00078"></a>00078 <a class="code" href="classboost_1_1geometry_1_1polygon.html#1933b7ecad0bdd523cd2d80f580dc7ce">inner_container_type</a> m_inners;
<a name="l00079"></a>00079 };
<a name="l00080"></a>00080
<a name="l00081"></a>00081
<a name="l00082"></a>00082 <span class="preprocessor">#ifndef DOXYGEN_NO_TRAITS_SPECIALIZATIONS</span>
<a name="l00083"></a>00083 <span class="preprocessor"></span><span class="keyword">namespace </span>traits
<a name="l00084"></a>00084 {
<a name="l00085"></a>00085
<a name="l00086"></a>00086 <span class="keyword">template</span>
<a name="l00087"></a>00087 &lt;
<a name="l00088"></a>00088 <span class="keyword">typename</span> Point,
<a name="l00089"></a>00089 <span class="keyword">template</span>&lt;<span class="keyword">typename</span>, <span class="keyword">typename</span>&gt; <span class="keyword">class </span><a class="code" href="class_point_list.html">PointList</a>,
<a name="l00090"></a>00090 <span class="keyword">template</span>&lt;<span class="keyword">typename</span>, <span class="keyword">typename</span>&gt; <span class="keyword">class </span>RingList,
<a name="l00091"></a>00091 <span class="keywordtype">bool</span> ClockWise,
<a name="l00092"></a>00092 <span class="keyword">template</span>&lt;<span class="keyword">typename</span>&gt; <span class="keyword">class </span>PointAlloc,
<a name="l00093"></a>00093 <span class="keyword">template</span>&lt;<span class="keyword">typename</span>&gt; <span class="keyword">class </span>RingAlloc
<a name="l00094"></a>00094 &gt;
<a name="l00095"></a>00095 <span class="keyword">struct </span>tag&lt;polygon&lt;Point, <a class="code" href="class_point_list.html">PointList</a>, RingList, ClockWise, PointAlloc, RingAlloc&gt; &gt;
<a name="l00096"></a>00096 {
<a name="l00097"></a>00097 <span class="keyword">typedef</span> polygon_tag <a class="code" href="structboost_1_1geometry_1_1traits_1_1tag.html#e1d5ca3f8597416d2838511ed9265e23">type</a>;
<a name="l00098"></a>00098 };
<a name="l00099"></a>00099
<a name="l00100"></a>00100 <span class="keyword">template</span>
<a name="l00101"></a>00101 &lt;
<a name="l00102"></a>00102 <span class="keyword">typename</span> Point,
<a name="l00103"></a>00103 <span class="keyword">template</span>&lt;<span class="keyword">typename</span>, <span class="keyword">typename</span>&gt; <span class="keyword">class </span><a class="code" href="class_point_list.html">PointList</a>,
<a name="l00104"></a>00104 <span class="keyword">template</span>&lt;<span class="keyword">typename</span>, <span class="keyword">typename</span>&gt; <span class="keyword">class </span>RingList,
<a name="l00105"></a>00105 <span class="keywordtype">bool</span> ClockWise,
<a name="l00106"></a>00106 <span class="keyword">template</span>&lt;<span class="keyword">typename</span>&gt; <span class="keyword">class </span>PointAlloc,
<a name="l00107"></a>00107 <span class="keyword">template</span>&lt;<span class="keyword">typename</span>&gt; <span class="keyword">class </span>RingAlloc
<a name="l00108"></a>00108 &gt;
<a name="l00109"></a>00109 <span class="keyword">struct </span>ring_type&lt;polygon&lt;Point, <a class="code" href="class_point_list.html">PointList</a>, RingList, ClockWise, PointAlloc, RingAlloc&gt; &gt;
<a name="l00110"></a>00110 {
<a name="l00111"></a>00111 <span class="keyword">typedef</span> <span class="keyword">typename</span> polygon
<a name="l00112"></a>00112 &lt;
<a name="l00113"></a>00113 Point, <a class="code" href="class_point_list.html">PointList</a>, RingList, ClockWise, PointAlloc, RingAlloc
<a name="l00114"></a>00114 &gt;::ring_type type;
<a name="l00115"></a>00115 };
<a name="l00116"></a>00116
<a name="l00117"></a>00117 <span class="keyword">template</span>
<a name="l00118"></a>00118 &lt;
<a name="l00119"></a>00119 <span class="keyword">typename</span> Point,
<a name="l00120"></a>00120 <span class="keyword">template</span>&lt;<span class="keyword">typename</span>, <span class="keyword">typename</span>&gt; <span class="keyword">class </span><a class="code" href="class_point_list.html">PointList</a>,
<a name="l00121"></a>00121 <span class="keyword">template</span>&lt;<span class="keyword">typename</span>, <span class="keyword">typename</span>&gt; <span class="keyword">class </span>RingList,
<a name="l00122"></a>00122 <span class="keywordtype">bool</span> ClockWise,
<a name="l00123"></a>00123 <span class="keyword">template</span>&lt;<span class="keyword">typename</span>&gt; <span class="keyword">class </span>PointAlloc,
<a name="l00124"></a>00124 <span class="keyword">template</span>&lt;<span class="keyword">typename</span>&gt; <span class="keyword">class </span>RingAlloc
<a name="l00125"></a>00125 &gt;
<a name="l00126"></a>00126 <span class="keyword">struct </span>interior_type&lt; polygon&lt;Point, <a class="code" href="class_point_list.html">PointList</a>, RingList, ClockWise, PointAlloc, RingAlloc&gt; &gt;
<a name="l00127"></a>00127 {
<a name="l00128"></a>00128 <span class="keyword">typedef</span> <span class="keyword">typename</span> polygon
<a name="l00129"></a>00129 &lt;
<a name="l00130"></a>00130 Point, <a class="code" href="class_point_list.html">PointList</a>, RingList, ClockWise, PointAlloc, RingAlloc
<a name="l00131"></a>00131 &gt;::inner_container_type type;
<a name="l00132"></a>00132 };
<a name="l00133"></a>00133
<a name="l00134"></a>00134 <span class="keyword">template</span>
<a name="l00135"></a>00135 &lt;
<a name="l00136"></a>00136 <span class="keyword">typename</span> Point,
<a name="l00137"></a>00137 <span class="keyword">template</span>&lt;<span class="keyword">typename</span>, <span class="keyword">typename</span>&gt; <span class="keyword">class </span><a class="code" href="class_point_list.html">PointList</a>,
<a name="l00138"></a>00138 <span class="keyword">template</span>&lt;<span class="keyword">typename</span>, <span class="keyword">typename</span>&gt; <span class="keyword">class </span>RingList,
<a name="l00139"></a>00139 <span class="keywordtype">bool</span> ClockWise,
<a name="l00140"></a>00140 <span class="keyword">template</span>&lt;<span class="keyword">typename</span>&gt; <span class="keyword">class </span>PointAlloc,
<a name="l00141"></a>00141 <span class="keyword">template</span>&lt;<span class="keyword">typename</span>&gt; <span class="keyword">class </span>RingAlloc
<a name="l00142"></a>00142 &gt;
<a name="l00143"></a>00143 <span class="keyword">struct </span><a class="code" href="group__access.html#gd96ba07cd3c6c3216bd5ab69adc9ccb5" title="Function to get the exterior_ring ring of a polygon.">exterior_ring</a>&lt; polygon&lt;Point, <a class="code" href="class_point_list.html">PointList</a>, RingList, ClockWise, PointAlloc, RingAlloc&gt; &gt;
<a name="l00144"></a>00144 {
<a name="l00145"></a>00145 <span class="keyword">typedef</span> polygon&lt;Point, PointList, RingList, ClockWise, PointAlloc, RingAlloc&gt; polygon_type;
<a name="l00146"></a>00146
<a name="l00147"></a>00147 <span class="keyword">static</span> <span class="keyword">inline</span> <span class="keyword">typename</span> polygon_type::ring_type&amp; <span class="keyword">get</span>(polygon_type&amp; p)
<a name="l00148"></a>00148 {
<a name="l00149"></a>00149 <span class="keywordflow">return</span> p.outer();
<a name="l00150"></a>00150 }
<a name="l00151"></a>00151
<a name="l00152"></a>00152 <span class="keyword">static</span> <span class="keyword">inline</span> <span class="keyword">typename</span> polygon_type::ring_type <span class="keyword">const</span> &amp; <span class="keyword">get</span>(polygon_type <span class="keyword">const</span>&amp; p)
<a name="l00153"></a>00153 {
<a name="l00154"></a>00154 <span class="keywordflow">return</span> p.outer();
<a name="l00155"></a>00155 }
<a name="l00156"></a>00156 };
<a name="l00157"></a>00157
<a name="l00158"></a>00158 <span class="keyword">template</span>
<a name="l00159"></a>00159 &lt;
<a name="l00160"></a>00160 <span class="keyword">typename</span> Point,
<a name="l00161"></a>00161 <span class="keyword">template</span>&lt;<span class="keyword">typename</span>, <span class="keyword">typename</span>&gt; <span class="keyword">class </span><a class="code" href="class_point_list.html">PointList</a>,
<a name="l00162"></a>00162 <span class="keyword">template</span>&lt;<span class="keyword">typename</span>, <span class="keyword">typename</span>&gt; <span class="keyword">class </span>RingList,
<a name="l00163"></a>00163 <span class="keywordtype">bool</span> ClockWise,
<a name="l00164"></a>00164 <span class="keyword">template</span>&lt;<span class="keyword">typename</span>&gt; <span class="keyword">class </span>PointAlloc,
<a name="l00165"></a>00165 <span class="keyword">template</span>&lt;<span class="keyword">typename</span>&gt; <span class="keyword">class </span>RingAlloc
<a name="l00166"></a>00166 &gt;
<a name="l00167"></a>00167 <span class="keyword">struct </span><a class="code" href="group__access.html#g5af585b056bb80bf3dfe7c07ad30d84a" title="Function to get the interior rings of a polygon (non const version).">interior_rings</a>&lt; polygon&lt;Point, <a class="code" href="class_point_list.html">PointList</a>, RingList, ClockWise, PointAlloc, RingAlloc&gt; &gt;
<a name="l00168"></a>00168 {
<a name="l00169"></a>00169 <span class="keyword">typedef</span> polygon&lt;Point, PointList, RingList, ClockWise, PointAlloc, RingAlloc&gt; polygon_type;
<a name="l00170"></a>00170
<a name="l00171"></a>00171 <span class="keyword">static</span> <span class="keyword">inline</span> <span class="keyword">typename</span> polygon_type::inner_container_type&amp; <span class="keyword">get</span>(
<a name="l00172"></a>00172 polygon_type&amp; p)
<a name="l00173"></a>00173 {
<a name="l00174"></a>00174 <span class="keywordflow">return</span> p.inners();
<a name="l00175"></a>00175 }
<a name="l00176"></a>00176
<a name="l00177"></a>00177 <span class="keyword">static</span> <span class="keyword">inline</span> <span class="keyword">typename</span> polygon_type::inner_container_type <span class="keyword">const</span>&amp; <span class="keyword">get</span>(
<a name="l00178"></a>00178 polygon_type <span class="keyword">const</span>&amp; p)
<a name="l00179"></a>00179 {
<a name="l00180"></a>00180 <span class="keywordflow">return</span> p.inners();
<a name="l00181"></a>00181 }
<a name="l00182"></a>00182 };
<a name="l00183"></a>00183
<a name="l00184"></a>00184 } <span class="comment">// namespace traits</span>
<a name="l00185"></a>00185 <span class="preprocessor">#endif // DOXYGEN_NO_TRAITS_SPECIALIZATIONS</span>
<a name="l00186"></a>00186 <span class="preprocessor"></span>
<a name="l00187"></a>00187 }} <span class="comment">// namespace boost::geometry</span>
<a name="l00188"></a>00188
<a name="l00189"></a>00189 <span class="preprocessor">#endif // BOOST_GEOMETRY_GEOMETRIES_POLYGON_HPP</span>
</pre></div></div>
<hr size="1">
<table width="100%">
<tbody>
<tr>
<td align="left"><small>
<p>December 1, 2009</p>
</small></td>
<td align="right">
<small>Copyright <20> 1995-2009 Barend Gehrels, Geodan, Amsterdam<br>
Copyright <20> 2008-2009 Bruno Lalande, Paris<br>
Copyright <20> 2009 Mateusz Loskot, Cadcorp, London<br>
</small>
</td>
</tr>
</tbody>
</table>
<address style="text-align: right;"><small>
Documentation is generated by&nbsp;<a href="http://www.doxygen.org/index.html">Doxygen</a>
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink