summaryrefslogtreecommitdiff
path: root/libs/geometry/doc/html/geometry/reference/adapted/register/boost_geometry_register_point_3d_get_set.html
blob: e3b46b68a97704a4df903d3603e5ca5e2ca67409 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>BOOST_GEOMETRY_REGISTER_POINT_3D_GET_SET</title>
<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="../../../../index.html" title="Chapter&#160;1.&#160;Geometry">
<link rel="up" href="../register.html" title="Macro's for adaption">
<link rel="prev" href="boost_geometry_register_point_3d_const.html" title="BOOST_GEOMETRY_REGISTER_POINT_3D_CONST">
<link rel="next" href="boost_geometry_register_ring.html" title="BOOST_GEOMETRY_REGISTER_RING">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td>
<td align="center"><a href="../../../../../../../../index.html">Home</a></td>
<td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
<td align="center"><a href="../../../../../../../../more/index.htm">More</a></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="boost_geometry_register_point_3d_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_ring.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry.reference.adapted.register.boost_geometry_register_point_3d_get_set"></a><a class="link" href="boost_geometry_register_point_3d_get_set.html" title="BOOST_GEOMETRY_REGISTER_POINT_3D_GET_SET">BOOST_GEOMETRY_REGISTER_POINT_3D_GET_SET</a>
</h5></div></div></div>
<p>
            <a class="indexterm" name="idp105428832"></a>
Macro to register a 3D point type (having separate get/set methods)
          </p>
<h6>
<a name="geometry.reference.adapted.register.boost_geometry_register_point_3d_get_set.h0"></a>
            <span class="phrase"><a name="geometry.reference.adapted.register.boost_geometry_register_point_3d_get_set.description"></a></span><a class="link" href="boost_geometry_register_point_3d_get_set.html#geometry.reference.adapted.register.boost_geometry_register_point_3d_get_set.description">Description</a>
          </h6>
<p>
            The macro BOOST_GEOMETRY_REGISTER_POINT_3D_GET_SET registers a three-dimensional
            point type such that it is recognized by Boost.Geometry and that Boost.Geometry
            functionality can used with the specified type.. The get/set version
            registers get and set methods separately and can be used for classes
            with protected member variables and get/set methods to change coordinates
          </p>
<h6>
<a name="geometry.reference.adapted.register.boost_geometry_register_point_3d_get_set.h1"></a>
            <span class="phrase"><a name="geometry.reference.adapted.register.boost_geometry_register_point_3d_get_set.synopsis"></a></span><a class="link" href="boost_geometry_register_point_3d_get_set.html#geometry.reference.adapted.register.boost_geometry_register_point_3d_get_set.synopsis">Synopsis</a>
          </h6>
<p>
</p>
<pre class="programlisting"><span class="preprocessor">#define</span> <span class="identifier">BOOST_GEOMETRY_REGISTER_POINT_3D_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>
                                          <span class="identifier">Get0</span><span class="special">,</span> <span class="identifier">Get1</span><span class="special">,</span> <span class="identifier">Get2</span><span class="special">,</span>
                                          <span class="identifier">Set0</span><span class="special">,</span> <span class="identifier">Set1</span><span class="special">,</span> <span class="identifier">Set2</span><span class="special">)</span></pre>
<p>
          </p>
<h6>
<a name="geometry.reference.adapted.register.boost_geometry_register_point_3d_get_set.h2"></a>
            <span class="phrase"><a name="geometry.reference.adapted.register.boost_geometry_register_point_3d_get_set.parameters"></a></span><a class="link" href="boost_geometry_register_point_3d_get_set.html#geometry.reference.adapted.register.boost_geometry_register_point_3d_get_set.parameters">Parameters</a>
          </h6>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>
                    <p>
                      Name
                    </p>
                  </th>
<th>
                    <p>
                      Description
                    </p>
                  </th>
</tr></thead>
<tbody>
<tr>
<td>
                    <p>
                      Point
                    </p>
                  </td>
<td>
                    <p>
                      Point type to be registered
                    </p>
                  </td>
</tr>
<tr>
<td>
                    <p>
                      CoordinateType
                    </p>
                  </td>
<td>
                    <p>
                      Type of the coordinates of the point (e.g. double)
                    </p>
                  </td>
</tr>
<tr>
<td>
                    <p>
                      CoordinateSystem
                    </p>
                  </td>
<td>
                    <p>
                      Coordinate system (e.g. cs::cartesian)
                    </p>
                  </td>
</tr>
<tr>
<td>
                    <p>
                      Get0
                    </p>
                  </td>
<td>
                    <p>
                      Method to get the first (usually x) coordinate
                    </p>
                  </td>
</tr>
<tr>
<td>
                    <p>
                      Get1
                    </p>
                  </td>
<td>
                    <p>
                      Method to get the second (usually y) coordinate
                    </p>
                  </td>
</tr>
<tr>
<td>
                    <p>
                      Get2
                    </p>
                  </td>
<td>
                    <p>
                      Method to get the third (usually z) coordinate
                    </p>
                  </td>
</tr>
<tr>
<td>
                    <p>
                      Set0
                    </p>
                  </td>
<td>
                    <p>
                      Method to set the first (usually x) coordinate
                    </p>
                  </td>
</tr>
<tr>
<td>
                    <p>
                      Set1
                    </p>
                  </td>
<td>
                    <p>
                      Method to set the second (usually y) coordinate
                    </p>
                  </td>
</tr>
<tr>
<td>
                    <p>
                      Set2
                    </p>
                  </td>
<td>
                    <p>
                      Method to set the third (usually z) coordinate
                    </p>
                  </td>
</tr>
</tbody>
</table></div>
<h6>
<a name="geometry.reference.adapted.register.boost_geometry_register_point_3d_get_set.h3"></a>
            <span class="phrase"><a name="geometry.reference.adapted.register.boost_geometry_register_point_3d_get_set.header"></a></span><a class="link" href="boost_geometry_register_point_3d_get_set.html#geometry.reference.adapted.register.boost_geometry_register_point_3d_get_set.header">Header</a>
          </h6>
<p>
            <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>
          </p>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright &#169; 2009-2015 Barend Gehrels, Bruno Lalande,
      Mateusz Loskot, Adam Wulkiewicz, Oracle and/or its affiliates<p>
        Distributed under the Boost Software License, Version 1.0. (See accompanying
        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>)
      </p>
</div></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="boost_geometry_register_point_3d_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_ring.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>