• 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_POINT_2D_GET_SET</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_2d_const.html" title="BOOST_GEOMETRY_REGISTER_POINT_2D_CONST">
10<link rel="next" href="boost_geometry_register_point_3d.html" title="BOOST_GEOMETRY_REGISTER_POINT_3D">
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_2d_const.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_point_3d.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_point_2d_get_set"></a><a class="link" href="boost_geometry_register_point_2d_get_set.html" title="BOOST_GEOMETRY_REGISTER_POINT_2D_GET_SET">BOOST_GEOMETRY_REGISTER_POINT_2D_GET_SET</a>
28</h5></div></div></div>
29<p>
30            <a class="indexterm" name="idm45635708715984"></a>
31Macro to register a 2D point type (having separate get/set methods)
32          </p>
33<h6>
34<a name="geometry.reference.adapted.register.boost_geometry_register_point_2d_get_set.h0"></a>
35            <span class="phrase"><a name="geometry.reference.adapted.register.boost_geometry_register_point_2d_get_set.description"></a></span><a class="link" href="boost_geometry_register_point_2d_get_set.html#geometry.reference.adapted.register.boost_geometry_register_point_2d_get_set.description">Description</a>
36          </h6>
37<p>
38            The macro BOOST_GEOMETRY_REGISTER_POINT_2D_GET_SET registers a two-dimensional
39            point type such that it is recognized by Boost.Geometry and that Boost.Geometry
40            functionality can used with the specified type.. The get/set version
41            registers get and set methods separately and can be used for classes
42            with protected member variables and get/set methods to change coordinates
43          </p>
44<h6>
45<a name="geometry.reference.adapted.register.boost_geometry_register_point_2d_get_set.h1"></a>
46            <span class="phrase"><a name="geometry.reference.adapted.register.boost_geometry_register_point_2d_get_set.synopsis"></a></span><a class="link" href="boost_geometry_register_point_2d_get_set.html#geometry.reference.adapted.register.boost_geometry_register_point_2d_get_set.synopsis">Synopsis</a>
47          </h6>
48<p>
49</p>
50<pre class="programlisting"><span class="preprocessor">#define</span> <span class="identifier">BOOST_GEOMETRY_REGISTER_POINT_2D_GET_SET</span><span class="special">(</span><span class="identifier">Point</span><span class="special">,</span> <span class="identifier">CoordinateType</span><span class="special">,</span> <span class="identifier">CoordinateSystem</span><span class="special">,</span>
51                                          <span class="identifier">Get0</span><span class="special">,</span> <span class="identifier">Get1</span><span class="special">,</span> <span class="identifier">Set0</span><span class="special">,</span>
52                                          <span class="identifier">Set1</span><span class="special">)</span></pre>
53<p>
54          </p>
55<h6>
56<a name="geometry.reference.adapted.register.boost_geometry_register_point_2d_get_set.h2"></a>
57            <span class="phrase"><a name="geometry.reference.adapted.register.boost_geometry_register_point_2d_get_set.parameters"></a></span><a class="link" href="boost_geometry_register_point_2d_get_set.html#geometry.reference.adapted.register.boost_geometry_register_point_2d_get_set.parameters">Parameters</a>
58          </h6>
59<div class="informaltable"><table class="table">
60<colgroup>
61<col>
62<col>
63</colgroup>
64<thead><tr>
65<th>
66                    <p>
67                      Name
68                    </p>
69                  </th>
70<th>
71                    <p>
72                      Description
73                    </p>
74                  </th>
75</tr></thead>
76<tbody>
77<tr>
78<td>
79                    <p>
80                      Point
81                    </p>
82                  </td>
83<td>
84                    <p>
85                      Point type to be registered
86                    </p>
87                  </td>
88</tr>
89<tr>
90<td>
91                    <p>
92                      CoordinateType
93                    </p>
94                  </td>
95<td>
96                    <p>
97                      Type of the coordinates of the point (e.g. double)
98                    </p>
99                  </td>
100</tr>
101<tr>
102<td>
103                    <p>
104                      CoordinateSystem
105                    </p>
106                  </td>
107<td>
108                    <p>
109                      Coordinate system (e.g. cs::cartesian)
110                    </p>
111                  </td>
112</tr>
113<tr>
114<td>
115                    <p>
116                      Get0
117                    </p>
118                  </td>
119<td>
120                    <p>
121                      Method to get the first (usually x) coordinate
122                    </p>
123                  </td>
124</tr>
125<tr>
126<td>
127                    <p>
128                      Get1
129                    </p>
130                  </td>
131<td>
132                    <p>
133                      Method to get the second (usually y) coordinate
134                    </p>
135                  </td>
136</tr>
137<tr>
138<td>
139                    <p>
140                      Set0
141                    </p>
142                  </td>
143<td>
144                    <p>
145                      Method to set the first (usually x) coordinate
146                    </p>
147                  </td>
148</tr>
149<tr>
150<td>
151                    <p>
152                      Set1
153                    </p>
154                  </td>
155<td>
156                    <p>
157                      Method to set the second (usually y) coordinate
158                    </p>
159                  </td>
160</tr>
161</tbody>
162</table></div>
163<h6>
164<a name="geometry.reference.adapted.register.boost_geometry_register_point_2d_get_set.h3"></a>
165            <span class="phrase"><a name="geometry.reference.adapted.register.boost_geometry_register_point_2d_get_set.header"></a></span><a class="link" href="boost_geometry_register_point_2d_get_set.html#geometry.reference.adapted.register.boost_geometry_register_point_2d_get_set.header">Header</a>
166          </h6>
167<p>
168            <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">point</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span></code>
169          </p>
170</div>
171<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
172<td align="left"></td>
173<td align="right"><div class="copyright-footer">Copyright © 2009-2019 Barend Gehrels, Bruno Lalande, Mateusz Loskot, Adam
174      Wulkiewicz, Oracle and/or its affiliates<p>
175        Distributed under the Boost Software License, Version 1.0. (See accompanying
176        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>)
177      </p>
178</div></td>
179</tr></table>
180<hr>
181<div class="spirit-nav">
182<a accesskey="p" href="boost_geometry_register_point_2d_const.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_point_3d.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
183</div>
184</body>
185</html>
186