1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>BOOST_GEOMETRY_REGISTER_POINT_2D</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_multi_polygon_templated.html" title="BOOST_GEOMETRY_REGISTER_MULTI_POLYGON_TEMPLATED"> 10<link rel="next" href="boost_geometry_register_point_2d_const.html" title="BOOST_GEOMETRY_REGISTER_POINT_2D_CONST"> 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_multi_polygon_templated.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_2d_const.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"></a><a class="link" href="boost_geometry_register_point_2d.html" title="BOOST_GEOMETRY_REGISTER_POINT_2D">BOOST_GEOMETRY_REGISTER_POINT_2D</a> 28</h5></div></div></div> 29<p> 30 <a class="indexterm" name="idm45635708897280"></a> 31Macro to register a 2D point type. 32 </p> 33<h6> 34<a name="geometry.reference.adapted.register.boost_geometry_register_point_2d.h0"></a> 35 <span class="phrase"><a name="geometry.reference.adapted.register.boost_geometry_register_point_2d.description"></a></span><a class="link" href="boost_geometry_register_point_2d.html#geometry.reference.adapted.register.boost_geometry_register_point_2d.description">Description</a> 36 </h6> 37<p> 38 The macro BOOST_GEOMETRY_REGISTER_POINT_2D 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. 41 </p> 42<h6> 43<a name="geometry.reference.adapted.register.boost_geometry_register_point_2d.h1"></a> 44 <span class="phrase"><a name="geometry.reference.adapted.register.boost_geometry_register_point_2d.synopsis"></a></span><a class="link" href="boost_geometry_register_point_2d.html#geometry.reference.adapted.register.boost_geometry_register_point_2d.synopsis">Synopsis</a> 45 </h6> 46<p> 47</p> 48<pre class="programlisting"><span class="preprocessor">#define</span> <span class="identifier">BOOST_GEOMETRY_REGISTER_POINT_2D</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> 49 <span class="identifier">Field0</span><span class="special">,</span> <span class="identifier">Field1</span><span class="special">)</span></pre> 50<p> 51 </p> 52<h6> 53<a name="geometry.reference.adapted.register.boost_geometry_register_point_2d.h2"></a> 54 <span class="phrase"><a name="geometry.reference.adapted.register.boost_geometry_register_point_2d.parameters"></a></span><a class="link" href="boost_geometry_register_point_2d.html#geometry.reference.adapted.register.boost_geometry_register_point_2d.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> 74<tr> 75<td> 76 <p> 77 Point 78 </p> 79 </td> 80<td> 81 <p> 82 Point type to be registered 83 </p> 84 </td> 85</tr> 86<tr> 87<td> 88 <p> 89 CoordinateType 90 </p> 91 </td> 92<td> 93 <p> 94 Type of the coordinates of the point (e.g. double) 95 </p> 96 </td> 97</tr> 98<tr> 99<td> 100 <p> 101 CoordinateSystem 102 </p> 103 </td> 104<td> 105 <p> 106 Coordinate system (e.g. cs::cartesian) 107 </p> 108 </td> 109</tr> 110<tr> 111<td> 112 <p> 113 Field0 114 </p> 115 </td> 116<td> 117 <p> 118 Member containing first (usually x) coordinate 119 </p> 120 </td> 121</tr> 122<tr> 123<td> 124 <p> 125 Field1 126 </p> 127 </td> 128<td> 129 <p> 130 Member containing second (usually y) coordinate 131 </p> 132 </td> 133</tr> 134</tbody> 135</table></div> 136<h6> 137<a name="geometry.reference.adapted.register.boost_geometry_register_point_2d.h3"></a> 138 <span class="phrase"><a name="geometry.reference.adapted.register.boost_geometry_register_point_2d.header"></a></span><a class="link" href="boost_geometry_register_point_2d.html#geometry.reference.adapted.register.boost_geometry_register_point_2d.header">Header</a> 139 </h6> 140<p> 141 <code class="computeroutput"><span class="preprocessor">#include</span> <span class="special"><</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">></span></code> 142 </p> 143<div class="caution"><table border="0" summary="Caution"> 144<tr> 145<td rowspan="2" align="center" valign="top" width="25"><img alt="[Caution]" src="../../../../../../../../doc/src/images/caution.png"></td> 146<th align="left">Caution</th> 147</tr> 148<tr><td align="left" valign="top"><p> 149 Use the macro outside any namespace 150 </p></td></tr> 151</table></div> 152<div class="note"><table border="0" summary="Note"> 153<tr> 154<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../../../../doc/src/images/note.png"></td> 155<th align="left">Note</th> 156</tr> 157<tr><td align="left" valign="top"><p> 158 A point can include a namespace 159 </p></td></tr> 160</table></div> 161<h6> 162<a name="geometry.reference.adapted.register.boost_geometry_register_point_2d.h4"></a> 163 <span class="phrase"><a name="geometry.reference.adapted.register.boost_geometry_register_point_2d.examples"></a></span><a class="link" href="boost_geometry_register_point_2d.html#geometry.reference.adapted.register.boost_geometry_register_point_2d.examples">Examples</a> 164 </h6> 165<p> 166 Show the use of the macro BOOST_GEOMETRY_REGISTER_POINT_2D 167 </p> 168<p> 169</p> 170<pre class="programlisting"><span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">iostream</span><span class="special">></span> 171<span class="preprocessor">#include</span> <span class="special"><</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">></span> 172<span class="preprocessor">#include</span> <span class="special"><</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">></span> 173 174<a class="co" name="geometry.reference.adapted.register.boost_geometry_register_point_2d.c0" href="boost_geometry_register_point_2d.html#geometry.reference.adapted.register.boost_geometry_register_point_2d.c1"><img src="../../../../../../../../doc/src/images/callouts/1.png" alt="1" border="0"></a> 175<span class="keyword">struct</span> <span class="identifier">legacy_point</span> 176<span class="special">{</span> 177 <span class="keyword">double</span> <span class="identifier">x</span><span class="special">,</span> <span class="identifier">y</span><span class="special">;</span> 178<span class="special">};</span> 179 180<span class="identifier">BOOST_GEOMETRY_REGISTER_POINT_2D</span><span class="special">(</span><span class="identifier">legacy_point</span><span class="special">,</span> <span class="keyword">double</span><span class="special">,</span> <span class="identifier">cs</span><span class="special">::</span><span class="identifier">cartesian</span><span class="special">,</span> <span class="identifier">x</span><span class="special">,</span> <span class="identifier">y</span><span class="special">)</span> <a class="co" name="geometry.reference.adapted.register.boost_geometry_register_point_2d.c2" href="boost_geometry_register_point_2d.html#geometry.reference.adapted.register.boost_geometry_register_point_2d.c3"><img src="../../../../../../../../doc/src/images/callouts/2.png" alt="2" border="0"></a> 181 182<span class="keyword">int</span> <span class="identifier">main</span><span class="special">()</span> 183<span class="special">{</span> 184 <span class="identifier">legacy_point</span> <span class="identifier">p1</span><span class="special">,</span> <span class="identifier">p2</span><span class="special">;</span> 185 186 <span class="keyword">namespace</span> <span class="identifier">bg</span> <span class="special">=</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">geometry</span><span class="special">;</span> 187 188 <a class="co" name="geometry.reference.adapted.register.boost_geometry_register_point_2d.c4" href="boost_geometry_register_point_2d.html#geometry.reference.adapted.register.boost_geometry_register_point_2d.c5"><img src="../../../../../../../../doc/src/images/callouts/3.png" alt="3" border="0"></a> 189 <span class="identifier">bg</span><span class="special">::</span><span class="identifier">assign_values</span><span class="special">(</span><span class="identifier">p1</span><span class="special">,</span> <span class="number">1</span><span class="special">,</span> <span class="number">1</span><span class="special">);</span> 190 <span class="identifier">bg</span><span class="special">::</span><span class="identifier">assign_values</span><span class="special">(</span><span class="identifier">p2</span><span class="special">,</span> <span class="number">2</span><span class="special">,</span> <span class="number">2</span><span class="special">);</span> 191 192 <span class="keyword">double</span> <span class="identifier">d</span> <span class="special">=</span> <span class="identifier">bg</span><span class="special">::</span><span class="identifier">distance</span><span class="special">(</span><span class="identifier">p1</span><span class="special">,</span> <span class="identifier">p2</span><span class="special">);</span> 193 194 <span class="identifier">std</span><span class="special">::</span><span class="identifier">cout</span> <span class="special"><<</span> <span class="string">"Distance: "</span> <span class="special"><<</span> <span class="identifier">d</span> <span class="special"><<</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">endl</span><span class="special">;</span> 195 196 <span class="keyword">return</span> <span class="number">0</span><span class="special">;</span> 197<span class="special">}</span> 198</pre> 199<p> 200 </p> 201<div class="calloutlist"><table border="0" summary="Callout list"> 202<tr> 203<td width="5%" valign="top" align="left"><p><a name="geometry.reference.adapted.register.boost_geometry_register_point_2d.c1"></a><a href="#geometry.reference.adapted.register.boost_geometry_register_point_2d.c0"><img src="../../../../../../../../doc/src/images/callouts/1.png" alt="1" border="0"></a> </p></td> 204<td valign="top" align="left"><p> 205 Somewhere, any legacy point struct is defined 206 </p></td> 207</tr> 208<tr> 209<td width="5%" valign="top" align="left"><p><a name="geometry.reference.adapted.register.boost_geometry_register_point_2d.c3"></a><a href="#geometry.reference.adapted.register.boost_geometry_register_point_2d.c2"><img src="../../../../../../../../doc/src/images/callouts/2.png" alt="2" border="0"></a> </p></td> 210<td valign="top" align="left"><p> 211 The magic: adapt it to Boost.Geometry Point Concept 212 </p></td> 213</tr> 214<tr> 215<td width="5%" valign="top" align="left"><p><a name="geometry.reference.adapted.register.boost_geometry_register_point_2d.c5"></a><a href="#geometry.reference.adapted.register.boost_geometry_register_point_2d.c4"><img src="../../../../../../../../doc/src/images/callouts/3.png" alt="3" border="0"></a> </p></td> 216<td valign="top" align="left"><p> 217 Any Boost.Geometry function can be used for legacy point now. Here: 218 assign_values and distance 219 </p></td> 220</tr> 221</table></div> 222<p> 223 Output: 224 </p> 225<pre class="programlisting">Distance: 1.41421 226</pre> 227</div> 228<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 229<td align="left"></td> 230<td align="right"><div class="copyright-footer">Copyright © 2009-2019 Barend Gehrels, Bruno Lalande, Mateusz Loskot, Adam 231 Wulkiewicz, Oracle and/or its affiliates<p> 232 Distributed under the Boost Software License, Version 1.0. (See accompanying 233 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>) 234 </p> 235</div></td> 236</tr></table> 237<hr> 238<div class="spirit-nav"> 239<a accesskey="p" href="boost_geometry_register_multi_polygon_templated.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_2d_const.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> 240</div> 241</body> 242</html> 243
