libs/geometry/doc/doxy/doxygen_output/xml/classboost_1_1geometry_1_1model_1_1polygon.xml

   1 <?xml version='1.0' encoding='UTF-8' standalone='no'?>
   2 <doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="1.8.6">
   3   <compounddef id="classboost_1_1geometry_1_1model_1_1polygon" kind="class" prot="public">
   4     <compoundname>boost::geometry::model::polygon</compoundname>
   5     <includes local="no">polygon.hpp</includes>
   6     <templateparamlist>
   7       <param>
   8         <type>typename</type>
   9         <declname>Point</declname>
  10         <defname>Point</defname>
  11       </param>
  12       <param>
  13         <type>bool</type>
  14         <declname>ClockWise</declname>
  15         <defname>ClockWise</defname>
  16         <defval>true</defval>
  17       </param>
  18       <param>
  19         <type>bool</type>
  20         <declname>Closed</declname>
  21         <defname>Closed</defname>
  22         <defval>true</defval>
  23       </param>
  24       <param>
  25         <type>template&lt; typename, typename &gt; class</type>
  26         <declname>PointList</declname>
  27         <defname>PointList</defname>
  28         <defval>std::vector</defval>
  29       </param>
  30       <param>
  31         <type>template&lt; typename, typename &gt; class</type>
  32         <declname>RingList</declname>
  33         <defname>RingList</defname>
  34         <defval>std::vector</defval>
  35       </param>
  36       <param>
  37         <type>template&lt; typename &gt; class</type>
  38         <declname>PointAlloc</declname>
  39         <defname>PointAlloc</defname>
  40         <defval>std::allocator</defval>
  41       </param>
  42       <param>
  43         <type>template&lt; typename &gt; class</type>
  44         <declname>RingAlloc</declname>
  45         <defname>RingAlloc</defname>
  46         <defval>std::allocator</defval>
  47       </param>
  48     </templateparamlist>
  49       <sectiondef kind="public-type">
  50       <memberdef kind="typedef" id="classboost_1_1geometry_1_1model_1_1polygon_1a3333b0b9de742667d84f94706a853ae7" prot="public" static="no">
  51         <type>RingList&lt; <ref refid="classboost_1_1geometry_1_1model_1_1polygon_1a570d62b2dd33ac4269a0b559cb3b18fb" kindref="member">ring_type</ref>, RingAlloc&lt; <ref refid="classboost_1_1geometry_1_1model_1_1polygon_1a570d62b2dd33ac4269a0b559cb3b18fb" kindref="member">ring_type</ref> &gt; &gt;</type>
  52         <definition>typedef RingList&lt;ring_type , RingAlloc&lt;ring_type &gt; &gt; boost::geometry::model::polygon&lt; Point, ClockWise, Closed, PointList, RingList, PointAlloc, RingAlloc &gt;::inner_container_type</definition>
  53         <argsstring></argsstring>
  54         <name>inner_container_type</name>
  55         <briefdescription>
  56         </briefdescription>
  57         <detaileddescription>
  58         </detaileddescription>
  59         <inbodydescription>
  60         </inbodydescription>
  61         <location file="/home/ubuntu/boost/boost/geometry/geometries/polygon.hpp" line="85" column="1" bodyfile="/home/ubuntu/boost/boost/geometry/geometries/polygon.hpp" bodystart="85" bodyend="-1"/>
  62       </memberdef>
  63       <memberdef kind="typedef" id="classboost_1_1geometry_1_1model_1_1polygon_1a2967e76f11d21ce2b51d5e7ba661ec98" prot="public" static="no">
  64         <type>Point</type>
  65         <definition>typedef Point boost::geometry::model::polygon&lt; Point, ClockWise, Closed, PointList, RingList, PointAlloc, RingAlloc &gt;::point_type</definition>
  66         <argsstring></argsstring>
  67         <name>point_type</name>
  68         <briefdescription>
  69         </briefdescription>
  70         <detaileddescription>
  71         </detaileddescription>
  72         <inbodydescription>
  73         </inbodydescription>
  74         <location file="/home/ubuntu/boost/boost/geometry/geometries/polygon.hpp" line="83" column="1" bodyfile="/home/ubuntu/boost/boost/geometry/geometries/polygon.hpp" bodystart="83" bodyend="-1"/>
  75       </memberdef>
  76       <memberdef kind="typedef" id="classboost_1_1geometry_1_1model_1_1polygon_1a570d62b2dd33ac4269a0b559cb3b18fb" prot="public" static="no">
  77         <type><ref refid="classboost_1_1geometry_1_1model_1_1ring" kindref="compound">ring</ref>&lt; Point, ClockWise, Closed, PointList, PointAlloc &gt;</type>
  78         <definition>typedef ring&lt;Point, ClockWise, Closed, PointList, PointAlloc&gt; boost::geometry::model::polygon&lt; Point, ClockWise, Closed, PointList, RingList, PointAlloc, RingAlloc &gt;::ring_type</definition>
  79         <argsstring></argsstring>
  80         <name>ring_type</name>
  81         <briefdescription>
  82         </briefdescription>
  83         <detaileddescription>
  84         </detaileddescription>
  85         <inbodydescription>
  86         </inbodydescription>
  87         <location file="/home/ubuntu/boost/boost/geometry/geometries/polygon.hpp" line="84" column="1" bodyfile="/home/ubuntu/boost/boost/geometry/geometries/polygon.hpp" bodystart="84" bodyend="-1"/>
  88       </memberdef>
  89       </sectiondef>
  90       <sectiondef kind="private-attrib">
  91       <memberdef kind="variable" id="classboost_1_1geometry_1_1model_1_1polygon_1a7ff03febfd9163687b5693a74cef028a" prot="private" static="no" mutable="no">
  92         <type><ref refid="classboost_1_1geometry_1_1model_1_1polygon_1a3333b0b9de742667d84f94706a853ae7" kindref="member">inner_container_type</ref></type>
  93         <definition>inner_container_type boost::geometry::model::polygon&lt; Point, ClockWise, Closed, PointList, RingList, PointAlloc, RingAlloc &gt;::m_inners</definition>
  94         <argsstring></argsstring>
  95         <name>m_inners</name>
  96         <briefdescription>
  97         </briefdescription>
  98         <detaileddescription>
  99         </detaileddescription>
 100         <inbodydescription>
 101         </inbodydescription>
 102         <location file="/home/ubuntu/boost/boost/geometry/geometries/polygon.hpp" line="144" column="1" bodyfile="/home/ubuntu/boost/boost/geometry/geometries/polygon.hpp" bodystart="144" bodyend="-1"/>
 103       </memberdef>
 104       <memberdef kind="variable" id="classboost_1_1geometry_1_1model_1_1polygon_1a92c39346305aa94c89627f771b38fce0" prot="private" static="no" mutable="no">
 105         <type><ref refid="classboost_1_1geometry_1_1model_1_1polygon_1a570d62b2dd33ac4269a0b559cb3b18fb" kindref="member">ring_type</ref></type>
 106         <definition>ring_type boost::geometry::model::polygon&lt; Point, ClockWise, Closed, PointList, RingList, PointAlloc, RingAlloc &gt;::m_outer</definition>
 107         <argsstring></argsstring>
 108         <name>m_outer</name>
 109         <briefdescription>
 110         </briefdescription>
 111         <detaileddescription>
 112         </detaileddescription>
 113         <inbodydescription>
 114         </inbodydescription>
 115         <location file="/home/ubuntu/boost/boost/geometry/geometries/polygon.hpp" line="143" column="1" bodyfile="/home/ubuntu/boost/boost/geometry/geometries/polygon.hpp" bodystart="143" bodyend="-1"/>
 116       </memberdef>
 117       </sectiondef>
 118       <sectiondef kind="private-func">
 119       <memberdef kind="function" id="classboost_1_1geometry_1_1model_1_1polygon_1a4fa0d51f003e50aed24e8dea20418b13" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
 120         <type></type>
 121         <definition>boost::geometry::model::polygon&lt; Point, ClockWise, Closed, PointList, RingList, PointAlloc, RingAlloc &gt;::BOOST_CONCEPT_ASSERT</definition>
 122         <argsstring>((concepts::Point&lt; Point &gt;))</argsstring>
 123         <name>BOOST_CONCEPT_ASSERT</name>
 124         <param>
 125           <type>(<ref refid="classboost_1_1geometry_1_1concepts_1_1_point" kindref="compound">concepts::Point</ref>&lt; Point &gt;)</type>
 126         </param>
 127         <briefdescription>
 128         </briefdescription>
 129         <detaileddescription>
 130         </detaileddescription>
 131         <inbodydescription>
 132         </inbodydescription>
 133         <location file="/home/ubuntu/boost/boost/geometry/geometries/polygon.hpp" line="78" column="1"/>
 134       </memberdef>
 135       </sectiondef>
 136       <sectiondef kind="public-func">
 137       <memberdef kind="function" id="classboost_1_1geometry_1_1model_1_1polygon_1aa1c33952047f12bed22862b634f885d8" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
 138         <type>void</type>
 139         <definition>void boost::geometry::model::polygon&lt; Point, ClockWise, Closed, PointList, RingList, PointAlloc, RingAlloc &gt;::clear</definition>
 140         <argsstring>()</argsstring>
 141         <name>clear</name>
 142         <briefdescription>
 143 <para>Utility method, clears outer and inner rings. </para>        </briefdescription>
 144         <detaileddescription>
 145         </detaileddescription>
 146         <inbodydescription>
 147         </inbodydescription>
 148         <location file="/home/ubuntu/boost/boost/geometry/geometries/polygon.hpp" line="135" column="1" bodyfile="/home/ubuntu/boost/boost/geometry/geometries/polygon.hpp" bodystart="135" bodyend="139"/>
 149       </memberdef>
 150       <memberdef kind="function" id="classboost_1_1geometry_1_1model_1_1polygon_1a06c92c4750c01e9f1ca8994bd4b476ad" prot="public" static="no" const="yes" explicit="no" inline="yes" virt="non-virtual">
 151         <type><ref refid="classboost_1_1geometry_1_1model_1_1polygon_1a3333b0b9de742667d84f94706a853ae7" kindref="member">inner_container_type</ref> const &amp;</type>
 152         <definition>inner_container_type const&amp; boost::geometry::model::polygon&lt; Point, ClockWise, Closed, PointList, RingList, PointAlloc, RingAlloc &gt;::inners</definition>
 153         <argsstring>() const </argsstring>
 154         <name>inners</name>
 155         <briefdescription>
 156         </briefdescription>
 157         <detaileddescription>
 158         </detaileddescription>
 159         <inbodydescription>
 160         </inbodydescription>
 161         <location file="/home/ubuntu/boost/boost/geometry/geometries/polygon.hpp" line="88" column="1" bodyfile="/home/ubuntu/boost/boost/geometry/geometries/polygon.hpp" bodystart="88" bodyend="88"/>
 162       </memberdef>
 163       <memberdef kind="function" id="classboost_1_1geometry_1_1model_1_1polygon_1a9920acd7487ef19f594dabc8cbb575ed" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
 164         <type><ref refid="classboost_1_1geometry_1_1model_1_1polygon_1a3333b0b9de742667d84f94706a853ae7" kindref="member">inner_container_type</ref> &amp;</type>
 165         <definition>inner_container_type&amp; boost::geometry::model::polygon&lt; Point, ClockWise, Closed, PointList, RingList, PointAlloc, RingAlloc &gt;::inners</definition>
 166         <argsstring>()</argsstring>
 167         <name>inners</name>
 168         <briefdescription>
 169         </briefdescription>
 170         <detaileddescription>
 171         </detaileddescription>
 172         <inbodydescription>
 173         </inbodydescription>
 174         <location file="/home/ubuntu/boost/boost/geometry/geometries/polygon.hpp" line="91" column="1" bodyfile="/home/ubuntu/boost/boost/geometry/geometries/polygon.hpp" bodystart="91" bodyend="91"/>
 175       </memberdef>
 176       <memberdef kind="function" id="classboost_1_1geometry_1_1model_1_1polygon_1a277ecfada807f6fc82883ffd6e52c920" prot="public" static="no" const="yes" explicit="no" inline="yes" virt="non-virtual">
 177         <type><ref refid="classboost_1_1geometry_1_1model_1_1polygon_1a570d62b2dd33ac4269a0b559cb3b18fb" kindref="member">ring_type</ref> const &amp;</type>
 178         <definition>ring_type const&amp; boost::geometry::model::polygon&lt; Point, ClockWise, Closed, PointList, RingList, PointAlloc, RingAlloc &gt;::outer</definition>
 179         <argsstring>() const </argsstring>
 180         <name>outer</name>
 181         <briefdescription>
 182         </briefdescription>
 183         <detaileddescription>
 184         </detaileddescription>
 185         <inbodydescription>
 186         </inbodydescription>
 187         <location file="/home/ubuntu/boost/boost/geometry/geometries/polygon.hpp" line="87" column="1" bodyfile="/home/ubuntu/boost/boost/geometry/geometries/polygon.hpp" bodystart="87" bodyend="87"/>
 188       </memberdef>
 189       <memberdef kind="function" id="classboost_1_1geometry_1_1model_1_1polygon_1a85574defd31e3480021cb35dd8546dc3" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
 190         <type><ref refid="classboost_1_1geometry_1_1model_1_1polygon_1a570d62b2dd33ac4269a0b559cb3b18fb" kindref="member">ring_type</ref> &amp;</type>
 191         <definition>ring_type&amp; boost::geometry::model::polygon&lt; Point, ClockWise, Closed, PointList, RingList, PointAlloc, RingAlloc &gt;::outer</definition>
 192         <argsstring>()</argsstring>
 193         <name>outer</name>
 194         <briefdescription>
 195         </briefdescription>
 196         <detaileddescription>
 197         </detaileddescription>
 198         <inbodydescription>
 199         </inbodydescription>
 200         <location file="/home/ubuntu/boost/boost/geometry/geometries/polygon.hpp" line="90" column="1" bodyfile="/home/ubuntu/boost/boost/geometry/geometries/polygon.hpp" bodystart="90" bodyend="90"/>
 201       </memberdef>
 202       <memberdef kind="function" id="classboost_1_1geometry_1_1model_1_1polygon_1a089990a65e206011b56b8b8e2bad9fa1" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
 203         <type></type>
 204         <definition>boost::geometry::model::polygon&lt; Point, ClockWise, Closed, PointList, RingList, PointAlloc, RingAlloc &gt;::polygon</definition>
 205         <argsstring>()</argsstring>
 206         <name>polygon</name>
 207         <briefdescription>
 208 <para>Default constructor, creating an empty polygon. </para>        </briefdescription>
 209         <detaileddescription>
 210         </detaileddescription>
 211         <inbodydescription>
 212         </inbodydescription>
 213         <location file="/home/ubuntu/boost/boost/geometry/geometries/polygon.hpp" line="99" column="1" bodyfile="/home/ubuntu/boost/boost/geometry/geometries/polygon.hpp" bodystart="99" bodyend="102"/>
 214       </memberdef>
 215       <memberdef kind="function" id="classboost_1_1geometry_1_1model_1_1polygon_1a9835cc906e4819930a9ae1ef55af3df1" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
 216         <type></type>
 217         <definition>boost::geometry::model::polygon&lt; Point, ClockWise, Closed, PointList, RingList, PointAlloc, RingAlloc &gt;::polygon</definition>
 218         <argsstring>(std::initializer_list&lt; ring_type &gt; l)</argsstring>
 219         <name>polygon</name>
 220         <param>
 221           <type>std::initializer_list&lt; <ref refid="classboost_1_1geometry_1_1model_1_1polygon_1a570d62b2dd33ac4269a0b559cb3b18fb" kindref="member">ring_type</ref> &gt;</type>
 222           <declname>l</declname>
 223         </param>
 224         <briefdescription>
 225 <para>Constructor taking std::initializer_list, filling the polygon. </para>        </briefdescription>
 226         <detaileddescription>
 227         </detaileddescription>
 228         <inbodydescription>
 229         </inbodydescription>
 230         <location file="/home/ubuntu/boost/boost/geometry/geometries/polygon.hpp" line="105" column="1" bodyfile="/home/ubuntu/boost/boost/geometry/geometries/polygon.hpp" bodystart="105" bodyend="108"/>
 231       </memberdef>
 232       </sectiondef>
 233     <briefdescription>
 234 <para>The polygon contains an outer ring and zero or more inner rings. </para>    </briefdescription>
 235     <detaileddescription>
 236 <para><parameterlist kind="templateparam"><parameteritem>
 237 <parameternamelist>
 238 <parametername>Point</parametername>
 239 </parameternamelist>
 240 <parameterdescription>
 241 <para>point type </para></parameterdescription>
 242 </parameteritem>
 243 <parameteritem>
 244 <parameternamelist>
 245 <parametername>ClockWise</parametername>
 246 </parameternamelist>
 247 <parameterdescription>
 248 <para>true for clockwise direction, false for CounterClockWise direction </para></parameterdescription>
 249 </parameteritem>
 250 <parameteritem>
 251 <parameternamelist>
 252 <parametername>Closed</parametername>
 253 </parameternamelist>
 254 <parameterdescription>
 255 <para>true for closed polygons (last point == first point), false open points </para></parameterdescription>
 256 </parameteritem>
 257 <parameteritem>
 258 <parameternamelist>
 259 <parametername>PointList</parametername>
 260 </parameternamelist>
 261 <parameterdescription>
 262 <para>container type for points, for example std::vector, std::list, std::deque </para></parameterdescription>
 263 </parameteritem>
 264 <parameteritem>
 265 <parameternamelist>
 266 <parametername>RingList</parametername>
 267 </parameternamelist>
 268 <parameterdescription>
 269 <para>container type for inner rings, for example std::vector, std::list, std::deque </para></parameterdescription>
 270 </parameteritem>
 271 <parameteritem>
 272 <parameternamelist>
 273 <parametername>PointAlloc</parametername>
 274 </parameternamelist>
 275 <parameterdescription>
 276 <para>container-allocator-type, for the points </para></parameterdescription>
 277 </parameteritem>
 278 <parameteritem>
 279 <parameternamelist>
 280 <parametername>RingAlloc</parametername>
 281 </parameternamelist>
 282 <parameterdescription>
 283 <para>container-allocator-type, for the rings </para></parameterdescription>
 284 </parameteritem>
 285 </parameterlist>
 286 <simplesect kind="note"><para>The container collecting the points in the rings can be different from the container collecting the inner rings. They all default to vector.</para></simplesect>
 287  <qbk>[include reference/geometries/polygon.qbk]</qbk>   <qbk.before.synopsis>
 288 [heading Model of]
 289 [link geometry.reference.concepts.concept_polygon Polygon Concept]
 290 </qbk.before.synopsis>  </para>    </detaileddescription>
 291     <location file="/home/ubuntu/boost/boost/geometry/geometries/polygon.hpp" line="77" column="1" bodyfile="/home/ubuntu/boost/boost/geometry/geometries/polygon.hpp" bodystart="76" bodyend="145"/>
 292     <listofallmembers>
 293       <member refid="classboost_1_1geometry_1_1model_1_1polygon_1a4fa0d51f003e50aed24e8dea20418b13" prot="private" virt="non-virtual"><scope>boost::geometry::model::polygon</scope><name>BOOST_CONCEPT_ASSERT</name></member>
 294       <member refid="classboost_1_1geometry_1_1model_1_1polygon_1aa1c33952047f12bed22862b634f885d8" prot="public" virt="non-virtual"><scope>boost::geometry::model::polygon</scope><name>clear</name></member>
 295       <member refid="classboost_1_1geometry_1_1model_1_1polygon_1a3333b0b9de742667d84f94706a853ae7" prot="public" virt="non-virtual"><scope>boost::geometry::model::polygon</scope><name>inner_container_type</name></member>
 296       <member refid="classboost_1_1geometry_1_1model_1_1polygon_1a06c92c4750c01e9f1ca8994bd4b476ad" prot="public" virt="non-virtual"><scope>boost::geometry::model::polygon</scope><name>inners</name></member>
 297       <member refid="classboost_1_1geometry_1_1model_1_1polygon_1a9920acd7487ef19f594dabc8cbb575ed" prot="public" virt="non-virtual"><scope>boost::geometry::model::polygon</scope><name>inners</name></member>
 298       <member refid="classboost_1_1geometry_1_1model_1_1polygon_1a7ff03febfd9163687b5693a74cef028a" prot="private" virt="non-virtual"><scope>boost::geometry::model::polygon</scope><name>m_inners</name></member>
 299       <member refid="classboost_1_1geometry_1_1model_1_1polygon_1a92c39346305aa94c89627f771b38fce0" prot="private" virt="non-virtual"><scope>boost::geometry::model::polygon</scope><name>m_outer</name></member>
 300       <member refid="classboost_1_1geometry_1_1model_1_1polygon_1a277ecfada807f6fc82883ffd6e52c920" prot="public" virt="non-virtual"><scope>boost::geometry::model::polygon</scope><name>outer</name></member>
 301       <member refid="classboost_1_1geometry_1_1model_1_1polygon_1a85574defd31e3480021cb35dd8546dc3" prot="public" virt="non-virtual"><scope>boost::geometry::model::polygon</scope><name>outer</name></member>
 302       <member refid="classboost_1_1geometry_1_1model_1_1polygon_1a2967e76f11d21ce2b51d5e7ba661ec98" prot="public" virt="non-virtual"><scope>boost::geometry::model::polygon</scope><name>point_type</name></member>
 303       <member refid="classboost_1_1geometry_1_1model_1_1polygon_1a089990a65e206011b56b8b8e2bad9fa1" prot="public" virt="non-virtual"><scope>boost::geometry::model::polygon</scope><name>polygon</name></member>
 304       <member refid="classboost_1_1geometry_1_1model_1_1polygon_1a9835cc906e4819930a9ae1ef55af3df1" prot="public" virt="non-virtual"><scope>boost::geometry::model::polygon</scope><name>polygon</name></member>
 305       <member refid="classboost_1_1geometry_1_1model_1_1polygon_1a570d62b2dd33ac4269a0b559cb3b18fb" prot="public" virt="non-virtual"><scope>boost::geometry::model::polygon</scope><name>ring_type</name></member>
 306     </listofallmembers>
 307   </compounddef>
 308 </doxygen>