1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>return_envelope</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="../envelope.html" title="envelope"> 9<link rel="prev" href="return_envelope_2_with_strategy.html" title="return_envelope (with strategy)"> 10<link rel="next" href="../equals.html" title="equals"> 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="return_envelope_2_with_strategy.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../envelope.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="../equals.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.algorithms.envelope.return_envelope_1"></a><a class="link" href="return_envelope_1.html" title="return_envelope">return_envelope</a> 28</h5></div></div></div> 29<p> 30 <a class="indexterm" name="idm45635697981680"></a> 31Calculates the envelope of a geometry. 32 </p> 33<h6> 34<a name="geometry.reference.algorithms.envelope.return_envelope_1.h0"></a> 35 <span class="phrase"><a name="geometry.reference.algorithms.envelope.return_envelope_1.description"></a></span><a class="link" href="return_envelope_1.html#geometry.reference.algorithms.envelope.return_envelope_1.description">Description</a> 36 </h6> 37<p> 38 The free function return_envelope calculates the envelope (also known 39 as axis aligned bounding box, aabb, or minimum bounding rectangle, mbr) 40 of a geometry. This version with the return_ prefix returns the envelope, 41 and a template parameter must therefore be specified in the call. 42 </p> 43<h6> 44<a name="geometry.reference.algorithms.envelope.return_envelope_1.h1"></a> 45 <span class="phrase"><a name="geometry.reference.algorithms.envelope.return_envelope_1.synopsis"></a></span><a class="link" href="return_envelope_1.html#geometry.reference.algorithms.envelope.return_envelope_1.synopsis">Synopsis</a> 46 </h6> 47<p> 48</p> 49<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> <span class="identifier">Box</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">Geometry</span><span class="special">></span> 50<span class="identifier">Box</span> <span class="identifier">return_envelope</span><span class="special">(</span><span class="identifier">Geometry</span> <span class="keyword">const</span> <span class="special">&</span> <span class="identifier">geometry</span><span class="special">)</span></pre> 51<p> 52 </p> 53<h6> 54<a name="geometry.reference.algorithms.envelope.return_envelope_1.h2"></a> 55 <span class="phrase"><a name="geometry.reference.algorithms.envelope.return_envelope_1.parameters"></a></span><a class="link" href="return_envelope_1.html#geometry.reference.algorithms.envelope.return_envelope_1.parameters">Parameters</a> 56 </h6> 57<div class="informaltable"><table class="table"> 58<colgroup> 59<col> 60<col> 61<col> 62<col> 63</colgroup> 64<thead><tr> 65<th> 66 <p> 67 Type 68 </p> 69 </th> 70<th> 71 <p> 72 Concept 73 </p> 74 </th> 75<th> 76 <p> 77 Name 78 </p> 79 </th> 80<th> 81 <p> 82 Description 83 </p> 84 </th> 85</tr></thead> 86<tbody> 87<tr> 88<td> 89 <p> 90 Box 91 </p> 92 </td> 93<td> 94 <p> 95 Any type fulfilling a Box Concept 96 </p> 97 </td> 98<td> 99 <p> 100 - 101 </p> 102 </td> 103<td> 104 <p> 105 Must be specified 106 </p> 107 </td> 108</tr> 109<tr> 110<td> 111 <p> 112 Geometry const & 113 </p> 114 </td> 115<td> 116 <p> 117 Any type fulfilling a Geometry Concept 118 </p> 119 </td> 120<td> 121 <p> 122 geometry 123 </p> 124 </td> 125<td> 126 <p> 127 A model of the specified concept 128 </p> 129 </td> 130</tr> 131</tbody> 132</table></div> 133<h6> 134<a name="geometry.reference.algorithms.envelope.return_envelope_1.h3"></a> 135 <span class="phrase"><a name="geometry.reference.algorithms.envelope.return_envelope_1.returns"></a></span><a class="link" href="return_envelope_1.html#geometry.reference.algorithms.envelope.return_envelope_1.returns">Returns</a> 136 </h6> 137<p> 138 The calculated envelope 139 </p> 140<h6> 141<a name="geometry.reference.algorithms.envelope.return_envelope_1.h4"></a> 142 <span class="phrase"><a name="geometry.reference.algorithms.envelope.return_envelope_1.header"></a></span><a class="link" href="return_envelope_1.html#geometry.reference.algorithms.envelope.return_envelope_1.header">Header</a> 143 </h6> 144<p> 145 Either 146 </p> 147<p> 148 <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">hpp</span><span class="special">></span></code> 149 </p> 150<p> 151 Or 152 </p> 153<p> 154 <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">algorithms</span><span class="special">/</span><span class="identifier">envelope</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> 155 </p> 156<h6> 157<a name="geometry.reference.algorithms.envelope.return_envelope_1.h5"></a> 158 <span class="phrase"><a name="geometry.reference.algorithms.envelope.return_envelope_1.conformance"></a></span><a class="link" href="return_envelope_1.html#geometry.reference.algorithms.envelope.return_envelope_1.conformance">Conformance</a> 159 </h6> 160<p> 161 The function envelope implements function Envelope from the <a href="http://www.opengeospatial.org/standards/sfa" target="_top">OGC 162 Simple Feature Specification</a>. 163 </p> 164<h6> 165<a name="geometry.reference.algorithms.envelope.return_envelope_1.h6"></a> 166 <span class="phrase"><a name="geometry.reference.algorithms.envelope.return_envelope_1.example"></a></span><a class="link" href="return_envelope_1.html#geometry.reference.algorithms.envelope.return_envelope_1.example">Example</a> 167 </h6> 168<p> 169 Shows how to return the envelope of a ring 170 </p> 171<p> 172</p> 173<pre class="programlisting"><span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">iostream</span><span class="special">></span> 174 175 176<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> 177<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="identifier">box</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span> 178<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="identifier">point_xy</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span> 179<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="identifier">ring</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span> 180 181<span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">assign</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span> 182 183 184 185<span class="keyword">int</span> <span class="identifier">main</span><span class="special">()</span> 186<span class="special">{</span> 187 <span class="keyword">using</span> <span class="keyword">namespace</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">assign</span><span class="special">;</span> 188 189 <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"><</span><span class="keyword">double</span><span class="special">></span> <span class="identifier">point</span><span class="special">;</span> 190 191 <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">ring</span><span class="special"><</span><span class="identifier">point</span><span class="special">></span> <span class="identifier">ring</span><span class="special">;</span> 192 <span class="identifier">ring</span> <span class="special">+=</span> 193 <span class="identifier">point</span><span class="special">(</span><span class="number">4.0</span><span class="special">,</span> <span class="special">-</span><span class="number">0.5</span><span class="special">),</span> <span class="identifier">point</span><span class="special">(</span><span class="number">3.5</span><span class="special">,</span> <span class="number">1.0</span><span class="special">),</span> 194 <span class="identifier">point</span><span class="special">(</span><span class="number">2.0</span><span class="special">,</span> <span class="number">1.5</span><span class="special">),</span> <span class="identifier">point</span><span class="special">(</span><span class="number">3.5</span><span class="special">,</span> <span class="number">2.0</span><span class="special">),</span> 195 <span class="identifier">point</span><span class="special">(</span><span class="number">4.0</span><span class="special">,</span> <span class="number">3.5</span><span class="special">),</span> <span class="identifier">point</span><span class="special">(</span><span class="number">4.5</span><span class="special">,</span> <span class="number">2.0</span><span class="special">),</span> 196 <span class="identifier">point</span><span class="special">(</span><span class="number">6.0</span><span class="special">,</span> <span class="number">1.5</span><span class="special">),</span> <span class="identifier">point</span><span class="special">(</span><span class="number">4.5</span><span class="special">,</span> <span class="number">1.0</span><span class="special">),</span> 197 <span class="identifier">point</span><span class="special">(</span><span class="number">4.0</span><span class="special">,</span> <span class="special">-</span><span class="number">0.5</span><span class="special">);</span> 198 199 <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">box</span><span class="special"><</span><span class="identifier">point</span><span class="special">></span> <span class="identifier">box</span><span class="special">;</span> 200 201 <span class="identifier">std</span><span class="special">::</span><span class="identifier">cout</span> 202 <span class="special"><<</span> <span class="string">"return_envelope:"</span> 203 <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">dsv</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">return_envelope</span><span class="special"><</span><span class="identifier">box</span><span class="special">>(</span><span class="identifier">ring</span><span class="special">))</span> 204 <span class="special"><<</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">endl</span><span class="special">;</span> 205 206 207 <span class="keyword">return</span> <span class="number">0</span><span class="special">;</span> 208<span class="special">}</span> 209</pre> 210<p> 211 </p> 212<p> 213 Output: 214 </p> 215<pre class="programlisting">return_envelope:((2, -0.5), (6, 3.5)) 216 217<img src="../../../../img/algorithms/return_envelope.png" alt="return_envelope"> 218</pre> 219</div> 220<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 221<td align="left"></td> 222<td align="right"><div class="copyright-footer">Copyright © 2009-2019 Barend Gehrels, Bruno Lalande, Mateusz Loskot, Adam 223 Wulkiewicz, Oracle and/or its affiliates<p> 224 Distributed under the Boost Software License, Version 1.0. (See accompanying 225 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>) 226 </p> 227</div></td> 228</tr></table> 229<hr> 230<div class="spirit-nav"> 231<a accesskey="p" href="return_envelope_2_with_strategy.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../envelope.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="../equals.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> 232</div> 233</body> 234</html> 235
