blob: d5814e28ea2d6034db9879b9d158c6b4c3ce1f5f [file] [log] [blame]
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>closeable_view</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="../views.html" title="Views">
<link rel="prev" href="segment_view.html" title="segment_view">
<link rel="next" href="reversible_view.html" title="reversible_view">
</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="segment_view.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../views.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="reversible_view.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
<a name="geometry.reference.views.closeable_view"></a><a class="link" href="closeable_view.html" title="closeable_view">closeable_view</a>
</h4></div></div></div>
<p>
<a class="indexterm" name="id963268"></a>
View on a range, either closing it or leaving it as it is.
</p>
<a name="geometry.reference.views.closeable_view.description"></a><h6>
<a name="geometry.reference.views.closeable_view.description-heading"></a>
<a class="link" href="closeable_view.html#geometry.reference.views.closeable_view.description">Description</a>
</h6>
<p>
The closeable_view is used internally by the library to handle all rings,
either closed or open, the same way. The default method is closed, all
algorithms process rings as if they are closed. Therefore, if they are
opened, a view is created which closes them. The closeable_view might be
used by library users, but its main purpose is internally.
</p>
<a name="geometry.reference.views.closeable_view.synopsis"></a><h6>
<a name="geometry.reference.views.closeable_view.synopsis-heading"></a>
<a class="link" href="closeable_view.html#geometry.reference.views.closeable_view.synopsis">Synopsis</a>
</h6>
<p>
</p>
<pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">Range</span><span class="special">,</span> <span class="identifier">closure_selector</span> <span class="identifier">Close</span><span class="special">&gt;</span>
<span class="keyword">struct</span> <span class="identifier">closeable_view</span>
<span class="special">{</span>
<span class="comment">// ...</span>
<span class="special">};</span>
</pre>
<p>
</p>
<a name="geometry.reference.views.closeable_view.template_parameter_s_"></a><h6>
<a name="geometry.reference.views.closeable_view.template_parameter_s_-heading"></a>
<a class="link" href="closeable_view.html#geometry.reference.views.closeable_view.template_parameter_s_">Template
parameter(s)</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>
<p>
Parameter
</p>
</th>
<th>
<p>
Description
</p>
</th>
</tr></thead>
<tbody>
<tr>
<td>
<p>
typename Range
</p>
</td>
<td>
<p>
Original range
</p>
</td>
</tr>
<tr>
<td>
<p>
closure_selector Close
</p>
</td>
<td>
<p>
Specifies if it the range is closed, if so, nothing will happen.
If it is open, it will iterate the first point after the last
point.
</p>
</td>
</tr>
</tbody>
</table></div>
<a name="geometry.reference.views.closeable_view.header"></a><h6>
<a name="geometry.reference.views.closeable_view.header-heading"></a>
<a class="link" href="closeable_view.html#geometry.reference.views.closeable_view.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">views</span><span class="special">/</span><span class="identifier">closeable_view</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="segment_view.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../views.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="reversible_view.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>