blob: 4809fa2481caf7f6359252368e1d10f6594cc95a [file] [log] [blame]
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>BOOST_GEOMETRY_REGISTER_RING</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_get_set.html" title="BOOST_GEOMETRY_REGISTER_POINT_3D_GET_SET">
<link rel="next" href="boost_geometry_register_ring_templated.html" title="BOOST_GEOMETRY_REGISTER_RING_TEMPLATED">
</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_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>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<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>
</h5></div></div></div>
<p>
<a class="indexterm" name="idp105490928"></a>
Macro to register a ring.
</p>
<h6>
<a name="geometry.reference.adapted.register.boost_geometry_register_ring.h0"></a>
<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>
</h6>
<p>
The macro BOOST_GEOMETRY_REGISTER_RING registers a ring such that it
is recognized by Boost.Geometry and that Boost.Geometry functionality
can used with the specified type. The ring may contain template parameters,
which must be specified then.
</p>
<h6>
<a name="geometry.reference.adapted.register.boost_geometry_register_ring.h1"></a>
<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>
</h6>
<p>
</p>
<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>
<p>
</p>
<h6>
<a name="geometry.reference.adapted.register.boost_geometry_register_ring.h2"></a>
<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>
</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>
Ring
</p>
</td>
<td>
<p>
ring type to be registered
</p>
</td>
</tr></tbody>
</table></div>
<h6>
<a name="geometry.reference.adapted.register.boost_geometry_register_ring.h3"></a>
<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>
</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">ring</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span></code>
</p>
<h6>
<a name="geometry.reference.adapted.register.boost_geometry_register_ring.h4"></a>
<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>
</h6>
<p>
Show the use of the macro BOOST_GEOMETRY_REGISTER_RING
</p>
<p>
</p>
<pre class="programlisting"><span class="preprocessor">#include</span> <span class="special">&lt;</span><span class="identifier">iostream</span><span class="special">&gt;</span>
<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>
<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>
<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>
<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>
<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>
<span class="keyword">int</span> <span class="identifier">main</span><span class="special">()</span>
<span class="special">{</span>
<span class="comment">// Normal usage of std::</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> <span class="identifier">ring</span><span class="special">;</span>
<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>
<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>
<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>
<span class="comment">// Usage of Boost.Geometry</span>
<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>
<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>
<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>
<span class="keyword">return</span> <span class="number">0</span><span class="special">;</span>
<span class="special">}</span>
</pre>
<p>
</p>
<div class="calloutlist"><table border="0" summary="Callout list"><tr>
<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>
<td valign="top" align="left"><p>
The magic: adapt vector to Boost.Geometry Ring Concept
</p></td>
</tr></table></div>
<p>
Output:
</p>
<pre class="programlisting">Area: 0.5
WKT: POLYGON((1 1,2 2,2 1,1 1))
</pre>
</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_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>
</div>
</body>
</html>