blob: aea86ff064da91a18daadb9ca22973a6c134e393 [file] [log] [blame]
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>BOOST_GEOMETRY_REGISTER_POINT_2D_GET_SET</title>
<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="../../../../index.html" title="Chapter&#160;1.&#160;Geometry 1.0">
<link rel="up" href="../register.html" title="Macro's for adaption">
<link rel="prev" href="boost_geometry_register_point_2d_const.html" title="BOOST_GEOMETRY_REGISTER_POINT_2D_CONST">
<link rel="next" href="boost_geometry_register_point_3d.html" title="BOOST_GEOMETRY_REGISTER_POINT_3D">
</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_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>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<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>
</h5></div></div></div>
<p>
<a class="indexterm" name="id816337"></a>
Macro to register a 2D point type (having separate get/set methods)
</p>
<a name="geometry.reference.adapted.register.boost_geometry_register_point_2d_get_set.description"></a><h6>
<a name="geometry.reference.adapted.register.boost_geometry_register_point_2d_get_set.description-heading"></a>
<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>
</h6>
<p>
The macro BOOST_GEOMETRY_REGISTER_POINT_2D_GET_SET registers a two-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>
<a name="geometry.reference.adapted.register.boost_geometry_register_point_2d_get_set.synopsis"></a><h6>
<a name="geometry.reference.adapted.register.boost_geometry_register_point_2d_get_set.synopsis-heading"></a>
<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>
</h6>
<p>
</p>
<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> <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> <span class="identifier">Set1</span><span class="special">)</span></pre>
<p>
</p>
<a name="geometry.reference.adapted.register.boost_geometry_register_point_2d_get_set.parameters"></a><h6>
<a name="geometry.reference.adapted.register.boost_geometry_register_point_2d_get_set.parameters-heading"></a>
<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>
</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>
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>
</tbody>
</table></div>
<a name="geometry.reference.adapted.register.boost_geometry_register_point_2d_get_set.header"></a><h6>
<a name="geometry.reference.adapted.register.boost_geometry_register_point_2d_get_set.header-heading"></a>
<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>
</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; 2011 Barend Gehrels, Bruno Lalande, Mateusz Loskot<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_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>
</div>
</body>
</html>