• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<html>
2<head>
3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
4<title>BOOST_GEOMETRY_REGISTER_RING</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="../register.html" title="Macro's for adaption">
9<link rel="prev" href="boost_geometry_register_point_3d_get_set.html" title="BOOST_GEOMETRY_REGISTER_POINT_3D_GET_SET">
10<link rel="next" href="boost_geometry_register_ring_templated.html" title="BOOST_GEOMETRY_REGISTER_RING_TEMPLATED">
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="boost_geometry_register_point_3d_get_set.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../register.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="boost_geometry_register_ring_templated.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
24</div>
25<div class="section">
26<div class="titlepage"><div><div><h5 class="title">
27<a name="geometry.reference.adapted.register.boost_geometry_register_ring"></a><a class="link" href="boost_geometry_register_ring.html" title="BOOST_GEOMETRY_REGISTER_RING">BOOST_GEOMETRY_REGISTER_RING</a>
28</h5></div></div></div>
29<p>
30            <a class="indexterm" name="idm45635708496112"></a>
31Macro to register a ring.
32          </p>
33<h6>
34<a name="geometry.reference.adapted.register.boost_geometry_register_ring.h0"></a>
35            <span class="phrase"><a name="geometry.reference.adapted.register.boost_geometry_register_ring.description"></a></span><a class="link" href="boost_geometry_register_ring.html#geometry.reference.adapted.register.boost_geometry_register_ring.description">Description</a>
36          </h6>
37<p>
38            The macro BOOST_GEOMETRY_REGISTER_RING registers a ring such that it
39            is recognized by Boost.Geometry and that Boost.Geometry functionality
40            can used with the specified type. The ring may contain template parameters,
41            which must be specified then.
42          </p>
43<h6>
44<a name="geometry.reference.adapted.register.boost_geometry_register_ring.h1"></a>
45            <span class="phrase"><a name="geometry.reference.adapted.register.boost_geometry_register_ring.synopsis"></a></span><a class="link" href="boost_geometry_register_ring.html#geometry.reference.adapted.register.boost_geometry_register_ring.synopsis">Synopsis</a>
46          </h6>
47<p>
48</p>
49<pre class="programlisting"><span class="preprocessor">#define</span> <span class="identifier">BOOST_GEOMETRY_REGISTER_RING</span><span class="special">(</span><span class="identifier">Ring</span><span class="special">)</span></pre>
50<p>
51          </p>
52<h6>
53<a name="geometry.reference.adapted.register.boost_geometry_register_ring.h2"></a>
54            <span class="phrase"><a name="geometry.reference.adapted.register.boost_geometry_register_ring.parameters"></a></span><a class="link" href="boost_geometry_register_ring.html#geometry.reference.adapted.register.boost_geometry_register_ring.parameters">Parameters</a>
55          </h6>
56<div class="informaltable"><table class="table">
57<colgroup>
58<col>
59<col>
60</colgroup>
61<thead><tr>
62<th>
63                    <p>
64                      Name
65                    </p>
66                  </th>
67<th>
68                    <p>
69                      Description
70                    </p>
71                  </th>
72</tr></thead>
73<tbody><tr>
74<td>
75                    <p>
76                      Ring
77                    </p>
78                  </td>
79<td>
80                    <p>
81                      ring type to be registered
82                    </p>
83                  </td>
84</tr></tbody>
85</table></div>
86<h6>
87<a name="geometry.reference.adapted.register.boost_geometry_register_ring.h3"></a>
88            <span class="phrase"><a name="geometry.reference.adapted.register.boost_geometry_register_ring.header"></a></span><a class="link" href="boost_geometry_register_ring.html#geometry.reference.adapted.register.boost_geometry_register_ring.header">Header</a>
89          </h6>
90<p>
91            <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">geometries</span><span class="special">/</span><span class="keyword">register</span><span class="special">/</span><span class="identifier">ring</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span></code>
92          </p>
93<h6>
94<a name="geometry.reference.adapted.register.boost_geometry_register_ring.h4"></a>
95            <span class="phrase"><a name="geometry.reference.adapted.register.boost_geometry_register_ring.example"></a></span><a class="link" href="boost_geometry_register_ring.html#geometry.reference.adapted.register.boost_geometry_register_ring.example">Example</a>
96          </h6>
97<p>
98            Show the use of the macro BOOST_GEOMETRY_REGISTER_RING
99          </p>
100<p>
101</p>
102<pre class="programlisting"><span class="preprocessor">#include</span> <span class="special">&lt;</span><span class="identifier">iostream</span><span class="special">&gt;</span>
103
104<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>
105<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">geometries</span><span class="special">/</span><span class="identifier">point_xy</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
106<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">geometries</span><span class="special">/</span><span class="keyword">register</span><span class="special">/</span><span class="identifier">ring</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
107
108<span class="keyword">typedef</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">geometry</span><span class="special">::</span><span class="identifier">model</span><span class="special">::</span><span class="identifier">d2</span><span class="special">::</span><span class="identifier">point_xy</span><span class="special">&lt;</span><span class="keyword">double</span><span class="special">&gt;</span> <span class="identifier">point_2d</span><span class="special">;</span>
109
110<span class="identifier">BOOST_GEOMETRY_REGISTER_RING</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special">&lt;</span><span class="identifier">point_2d</span><span class="special">&gt;)</span> <a class="co" name="geometry.reference.adapted.register.boost_geometry_register_ring.c0" href="boost_geometry_register_ring.html#geometry.reference.adapted.register.boost_geometry_register_ring.c1"><img src="../../../../../../../../doc/src/images/callouts/1.png" alt="1" border="0"></a>
111
112<span class="keyword">int</span> <span class="identifier">main</span><span class="special">()</span>
113<span class="special">{</span>
114    <span class="comment">// Normal usage of std::</span>
115    <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special">&lt;</span><span class="identifier">point_2d</span><span class="special">&gt;</span> <span class="identifier">ring</span><span class="special">;</span>
116    <span class="identifier">ring</span><span class="special">.</span><span class="identifier">push_back</span><span class="special">(</span><span class="identifier">point_2d</span><span class="special">(</span><span class="number">1</span><span class="special">,</span> <span class="number">1</span><span class="special">));</span>
117    <span class="identifier">ring</span><span class="special">.</span><span class="identifier">push_back</span><span class="special">(</span><span class="identifier">point_2d</span><span class="special">(</span><span class="number">2</span><span class="special">,</span> <span class="number">2</span><span class="special">));</span>
118    <span class="identifier">ring</span><span class="special">.</span><span class="identifier">push_back</span><span class="special">(</span><span class="identifier">point_2d</span><span class="special">(</span><span class="number">2</span><span class="special">,</span> <span class="number">1</span><span class="special">));</span>
119
120
121    <span class="comment">// Usage of Boost.Geometry</span>
122    <span class="identifier">boost</span><span class="special">::</span><span class="identifier">geometry</span><span class="special">::</span><span class="identifier">correct</span><span class="special">(</span><span class="identifier">ring</span><span class="special">);</span>
123    <span class="identifier">std</span><span class="special">::</span><span class="identifier">cout</span> <span class="special">&lt;&lt;</span> <span class="string">"Area: "</span>  <span class="special">&lt;&lt;</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">geometry</span><span class="special">::</span><span class="identifier">area</span><span class="special">(</span><span class="identifier">ring</span><span class="special">)</span> <span class="special">&lt;&lt;</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">endl</span><span class="special">;</span>
124    <span class="identifier">std</span><span class="special">::</span><span class="identifier">cout</span> <span class="special">&lt;&lt;</span> <span class="string">"WKT: "</span>  <span class="special">&lt;&lt;</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">geometry</span><span class="special">::</span><span class="identifier">wkt</span><span class="special">(</span><span class="identifier">ring</span><span class="special">)</span> <span class="special">&lt;&lt;</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">endl</span><span class="special">;</span>
125
126    <span class="keyword">return</span> <span class="number">0</span><span class="special">;</span>
127<span class="special">}</span>
128</pre>
129<p>
130          </p>
131<div class="calloutlist"><table border="0" summary="Callout list"><tr>
132<td width="5%" valign="top" align="left"><p><a name="geometry.reference.adapted.register.boost_geometry_register_ring.c1"></a><a href="#geometry.reference.adapted.register.boost_geometry_register_ring.c0"><img src="../../../../../../../../doc/src/images/callouts/1.png" alt="1" border="0"></a> </p></td>
133<td valign="top" align="left"><p>
134                The magic: adapt vector to Boost.Geometry Ring Concept
135              </p></td>
136</tr></table></div>
137<p>
138            Output:
139          </p>
140<pre class="programlisting">Area: 0.5
141WKT: POLYGON((1 1,2 2,2 1,1 1))
142</pre>
143</div>
144<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
145<td align="left"></td>
146<td align="right"><div class="copyright-footer">Copyright © 2009-2019 Barend Gehrels, Bruno Lalande, Mateusz Loskot, Adam
147      Wulkiewicz, Oracle and/or its affiliates<p>
148        Distributed under the Boost Software License, Version 1.0. (See accompanying
149        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>)
150      </p>
151</div></td>
152</tr></table>
153<hr>
154<div class="spirit-nav">
155<a accesskey="p" href="boost_geometry_register_point_3d_get_set.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../register.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="boost_geometry_register_ring_templated.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
156</div>
157</body>
158</html>
159