libs/geometry/doc/doxy/doxygen_output/html_by_doxygen/classboost_1_1geometry_1_1model_1_1box.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html>
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
   5 <title>Boost.Geometry (aka GGL, Generic Geometry Library)</title>
   6 <link href="doxygen.css" rel="stylesheet" type="text/css">
   7 <link href="tabs.css" rel="stylesheet" type="text/css">
   8 </head>
   9 <table cellpadding="2" width="100%">
  10 <tbody>
  11 <tr>
  12 <td valign="top">
  13 <img alt="Boost.Geometry" src="images/ggl-logo-big.png" height="80" width="200">
  14 &nbsp;&nbsp;
  15 </td>
  16 <td valign="top" align="right">
  17 <a href="http://www.boost.org">
  18 <img alt="Boost C++ Libraries" src="images/accepted_by_boost.png" height="80" width="230" border="0">
  19 </a>
  20 </td>
  21 </tr>
  22 </tbody>
  23 </table>
  24 <!-- Generated by Doxygen 1.8.6 -->
  25   <div id="navrow1" class="tabs">
  26     <ul class="tablist">
  27       <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  28       <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
  29       <li><a href="modules.html"><span>Modules</span></a></li>
  30       <li><a href="namespaces.html"><span>Namespaces</span></a></li>
  31       <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
  32       <li><a href="files.html"><span>Files</span></a></li>
  33       <li><a href="examples.html"><span>Examples</span></a></li>
  34     </ul>
  35   </div>
  36   <div id="navrow2" class="tabs2">
  37     <ul class="tablist">
  38       <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
  39       <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
  40       <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
  41       <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
  42     </ul>
  43   </div>
  44 <div id="nav-path" class="navpath">
  45   <ul>
  46 <li class="navelem"><a class="el" href="namespaceboost.html">boost</a></li><li class="navelem"><a class="el" href="namespaceboost_1_1geometry.html">geometry</a></li><li class="navelem"><a class="el" href="namespaceboost_1_1geometry_1_1model.html">model</a></li><li class="navelem"><a class="el" href="classboost_1_1geometry_1_1model_1_1box.html">box</a></li>  </ul>
  47 </div>
  48 </div><!-- top -->
  49 <div class="header">
  50   <div class="summary">
  51 <a href="#pub-methods">Public Member Functions</a> &#124;
  52 <a href="classboost_1_1geometry_1_1model_1_1box-members.html">List of all members</a>  </div>
  53   <div class="headertitle">
  54 <div class="title">boost::geometry::model::box&lt; Point &gt; Class Template Reference<div class="ingroups"><a class="el" href="group__geometries.html">geometries: geometries provided by default</a></div></div>  </div>
  55 </div><!--header-->
  56 <div class="contents">
  57
  58 <p>Class box: defines a box made of two describing points.
  59  <a href="classboost_1_1geometry_1_1model_1_1box.html#details">More...</a></p>
  60 <table class="memberdecls">
  61 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  62 Public Member Functions</h2></td></tr>
  63 <tr class="memitem:abc7fbd3ef09e4fde188f8ad4179015a1"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1geometry_1_1model_1_1box.html#abc7fbd3ef09e4fde188f8ad4179015a1">box</a> ()=default</td></tr>
  64 <tr class="memdesc:abc7fbd3ef09e4fde188f8ad4179015a1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructor, no initialization.  <a href="#abc7fbd3ef09e4fde188f8ad4179015a1">More...</a><br/></td></tr>
  65 <tr class="separator:abc7fbd3ef09e4fde188f8ad4179015a1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  66 <tr class="memitem:ad13d0a268701c33627f6e5a4c3ae20d0"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1geometry_1_1model_1_1box.html#ad13d0a268701c33627f6e5a4c3ae20d0">box</a> (Point const &amp;<a class="el" href="classboost_1_1geometry_1_1model_1_1box.html#a2e90ba7321cbea9b47690d32e5da4a25">min_corner</a>, Point const &amp;<a class="el" href="classboost_1_1geometry_1_1model_1_1box.html#abb5bd8205c3530d22fd9449bdb0477fc">max_corner</a>)</td></tr>
  67 <tr class="memdesc:ad13d0a268701c33627f6e5a4c3ae20d0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor taking the minimum corner point and the maximum corner point.  <a href="#ad13d0a268701c33627f6e5a4c3ae20d0">More...</a><br/></td></tr>
  68 <tr class="separator:ad13d0a268701c33627f6e5a4c3ae20d0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  69 <tr class="memitem:abb5bd8205c3530d22fd9449bdb0477fc"><td class="memItemLeft" align="right" valign="top">Point const &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1geometry_1_1model_1_1box.html#abb5bd8205c3530d22fd9449bdb0477fc">max_corner</a> () const </td></tr>
  70 <tr class="separator:abb5bd8205c3530d22fd9449bdb0477fc"><td class="memSeparator" colspan="2">&#160;</td></tr>
  71 <tr class="memitem:a62014bea25cbad5583136e6fc2665ad3"><td class="memItemLeft" align="right" valign="top">Point &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1geometry_1_1model_1_1box.html#a62014bea25cbad5583136e6fc2665ad3">max_corner</a> ()</td></tr>
  72 <tr class="separator:a62014bea25cbad5583136e6fc2665ad3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  73 <tr class="memitem:a2e90ba7321cbea9b47690d32e5da4a25"><td class="memItemLeft" align="right" valign="top">Point const &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1geometry_1_1model_1_1box.html#a2e90ba7321cbea9b47690d32e5da4a25">min_corner</a> () const </td></tr>
  74 <tr class="separator:a2e90ba7321cbea9b47690d32e5da4a25"><td class="memSeparator" colspan="2">&#160;</td></tr>
  75 <tr class="memitem:aaaedfffca974e18df1a7337d8eeb9bc3"><td class="memItemLeft" align="right" valign="top">Point &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1geometry_1_1model_1_1box.html#aaaedfffca974e18df1a7337d8eeb9bc3">min_corner</a> ()</td></tr>
  76 <tr class="separator:aaaedfffca974e18df1a7337d8eeb9bc3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  77 </table>
  78 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  79 <div class="textblock"><h3>template&lt;typename Point&gt;<br/>
  80 class boost::geometry::model::box&lt; Point &gt;</h3>
  81
  82 <p>Class box: defines a box made of two describing points. </p>
  83 <p>Box is always described by a <a class="el" href="classboost_1_1geometry_1_1model_1_1box.html#aaaedfffca974e18df1a7337d8eeb9bc3">min_corner()</a> and a <a class="el" href="classboost_1_1geometry_1_1model_1_1box.html#a62014bea25cbad5583136e6fc2665ad3">max_corner()</a> point. If another rectangle is used, use linear_ring or polygon. </p>
  84 <dl class="section note"><dt>Note</dt><dd>Boxes are for selections and for calculating the envelope of geometries. Not all algorithms are implemented for box. Boxes are also used in Spatial Indexes. </dd></dl>
  85 <dl class="tparams"><dt>Template Parameters</dt><dd>
  86   <table class="tparams">
  87     <tr><td class="paramname">Point</td><td>point type. The box takes a point type as template parameter. The point type can be any point type. It can be 2D but can also be 3D or more dimensional. The box can also take a latlong point type as template parameter.</td></tr>
  88   </table>
  89   </dd>
  90 </dl>
  91    <dl><dt><b>Examples: </b></dt><dd><a class="el" href="02_linestring_example_8cpp-example.html#_a6">02_linestring_example.cpp</a>, <a class="el" href="03_polygon_example_8cpp-example.html#_a3">03_polygon_example.cpp</a>, <a class="el" href="07_a_graph_route_example_8cpp-example.html#_a13">07_a_graph_route_example.cpp</a>, <a class="el" href="07_b_graph_route_example_8cpp-example.html#_a12">07_b_graph_route_example.cpp</a>, and <a class="el" href="c05_custom_point_pointer_example_8cpp-example.html#_a5">c05_custom_point_pointer_example.cpp</a>.</dd>
  92 </dl></div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  93 <a class="anchor" id="abc7fbd3ef09e4fde188f8ad4179015a1"></a>
  94 <div class="memitem">
  95 <div class="memproto">
  96 <div class="memtemplate">
  97 template&lt;typename Point&gt; </div>
  98 <table class="mlabels">
  99   <tr>
 100   <td class="mlabels-left">
 101       <table class="memname">
 102         <tr>
 103           <td class="memname"><a class="el" href="classboost_1_1geometry_1_1model_1_1box.html">boost::geometry::model::box</a>&lt; Point &gt;::<a class="el" href="classboost_1_1geometry_1_1model_1_1box.html">box</a> </td>
 104           <td>(</td>
 105           <td class="paramname"></td><td>)</td>
 106           <td></td>
 107         </tr>
 108       </table>
 109   </td>
 110   <td class="mlabels-right">
 111 <span class="mlabels"><span class="mlabel">default</span></span>  </td>
 112   </tr>
 113 </table>
 114 </div><div class="memdoc">
 115
 116 <p>Default constructor, no initialization. </p>
 117
 118 </div>
 119 </div>
 120 <a class="anchor" id="ad13d0a268701c33627f6e5a4c3ae20d0"></a>
 121 <div class="memitem">
 122 <div class="memproto">
 123 <div class="memtemplate">
 124 template&lt;typename Point&gt; </div>
 125       <table class="memname">
 126         <tr>
 127           <td class="memname"><a class="el" href="classboost_1_1geometry_1_1model_1_1box.html">boost::geometry::model::box</a>&lt; Point &gt;::<a class="el" href="classboost_1_1geometry_1_1model_1_1box.html">box</a> </td>
 128           <td>(</td>
 129           <td class="paramtype">Point const &amp;&#160;</td>
 130           <td class="paramname"><em>min_corner</em>, </td>
 131         </tr>
 132         <tr>
 133           <td class="paramkey"></td>
 134           <td></td>
 135           <td class="paramtype">Point const &amp;&#160;</td>
 136           <td class="paramname"><em>max_corner</em>&#160;</td>
 137         </tr>
 138         <tr>
 139           <td></td>
 140           <td>)</td>
 141           <td></td><td></td>
 142         </tr>
 143       </table>
 144 </div><div class="memdoc">
 145
 146 <p>Constructor taking the minimum corner point and the maximum corner point. </p>
 147
 148 </div>
 149 </div>
 150 <h2 class="groupheader">Member Function Documentation</h2>
 151 <a class="anchor" id="a2e90ba7321cbea9b47690d32e5da4a25"></a>
 152 <div class="memitem">
 153 <div class="memproto">
 154 <div class="memtemplate">
 155 template&lt;typename Point&gt; </div>
 156       <table class="memname">
 157         <tr>
 158           <td class="memname">Point const&amp; <a class="el" href="classboost_1_1geometry_1_1model_1_1box.html">boost::geometry::model::box</a>&lt; Point &gt;::min_corner </td>
 159           <td>(</td>
 160           <td class="paramname"></td><td>)</td>
 161           <td> const</td>
 162         </tr>
 163       </table>
 164 </div><div class="memdoc">
 165
 166 </div>
 167 </div>
 168 <a class="anchor" id="abb5bd8205c3530d22fd9449bdb0477fc"></a>
 169 <div class="memitem">
 170 <div class="memproto">
 171 <div class="memtemplate">
 172 template&lt;typename Point&gt; </div>
 173       <table class="memname">
 174         <tr>
 175           <td class="memname">Point const&amp; <a class="el" href="classboost_1_1geometry_1_1model_1_1box.html">boost::geometry::model::box</a>&lt; Point &gt;::max_corner </td>
 176           <td>(</td>
 177           <td class="paramname"></td><td>)</td>
 178           <td> const</td>
 179         </tr>
 180       </table>
 181 </div><div class="memdoc">
 182
 183 </div>
 184 </div>
 185 <a class="anchor" id="aaaedfffca974e18df1a7337d8eeb9bc3"></a>
 186 <div class="memitem">
 187 <div class="memproto">
 188 <div class="memtemplate">
 189 template&lt;typename Point&gt; </div>
 190       <table class="memname">
 191         <tr>
 192           <td class="memname">Point&amp; <a class="el" href="classboost_1_1geometry_1_1model_1_1box.html">boost::geometry::model::box</a>&lt; Point &gt;::min_corner </td>
 193           <td>(</td>
 194           <td class="paramname"></td><td>)</td>
 195           <td></td>
 196         </tr>
 197       </table>
 198 </div><div class="memdoc">
 199
 200 </div>
 201 </div>
 202 <a class="anchor" id="a62014bea25cbad5583136e6fc2665ad3"></a>
 203 <div class="memitem">
 204 <div class="memproto">
 205 <div class="memtemplate">
 206 template&lt;typename Point&gt; </div>
 207       <table class="memname">
 208         <tr>
 209           <td class="memname">Point&amp; <a class="el" href="classboost_1_1geometry_1_1model_1_1box.html">boost::geometry::model::box</a>&lt; Point &gt;::max_corner </td>
 210           <td>(</td>
 211           <td class="paramname"></td><td>)</td>
 212           <td></td>
 213         </tr>
 214       </table>
 215 </div><div class="memdoc">
 216
 217 </div>
 218 </div>
 219 </div><!-- contents -->
 220 <hr size="1">
 221 <table width="100%">
 222 <tbody>
 223 <tr>
 224 <td align="left"><small>
 225 <p>April 2, 2011</p>
 226 </small></td>
 227 <td align="right">
 228 <small>
 229 Copyright &copy; 2007-2011 Barend Gehrels, Amsterdam, the Netherlands<br>
 230 Copyright &copy; 2008-2011 Bruno Lalande, Paris, France<br>
 231 Copyright &copy; 2009-2010 Mateusz Loskot, London, UK<br>
 232 </small>
 233 </td>
 234 </tr>
 235 </tbody>
 236 </table>
 237 <address style="text-align: right;"><small>
 238 Documentation is generated by&nbsp;<a href="http://www.doxygen.org/index.html">Doxygen</a>
 239 </small></address>
 240 </body>
 241 </html>