libs/geometry/doc/doxy/doxygen_output/html_by_doxygen/group__envelope.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><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><!-- top -->
  37 <div class="header">
  38   <div class="summary">
  39 <a href="#func-members">Functions</a>  </div>
  40   <div class="headertitle">
  41 <div class="title">envelope: calculate envelope (minimum bounding rectangle) of a geometry</div>  </div>
  42 </div><!--header-->
  43 <div class="contents">
  44 <table class="memberdecls">
  45 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  46 Functions</h2></td></tr>
  47 <tr class="memitem:gac1f1865a7b36047d44949e17266d8f5a"><td class="memTemplParams" colspan="2">template&lt;typename Geometry , typename Box &gt; </td></tr>
  48 <tr class="memitem:gac1f1865a7b36047d44949e17266d8f5a"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__envelope.html#gac1f1865a7b36047d44949e17266d8f5a">boost::geometry::envelope</a> (Geometry const &amp;geometry, Box &amp;mbr)</td></tr>
  49 <tr class="memdesc:gac1f1865a7b36047d44949e17266d8f5a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Calculates the envelope of a geometry.  <a href="#gac1f1865a7b36047d44949e17266d8f5a">More...</a><br/></td></tr>
  50 <tr class="separator:gac1f1865a7b36047d44949e17266d8f5a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  51 <tr class="memitem:ga4afb45ba6fb41e732a008a9e1e104347"><td class="memTemplParams" colspan="2">template&lt;typename Box , typename Geometry &gt; </td></tr>
  52 <tr class="memitem:ga4afb45ba6fb41e732a008a9e1e104347"><td class="memTemplItemLeft" align="right" valign="top">Box&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__envelope.html#ga4afb45ba6fb41e732a008a9e1e104347">boost::geometry::return_envelope</a> (Geometry const &amp;geometry)</td></tr>
  53 <tr class="memdesc:ga4afb45ba6fb41e732a008a9e1e104347"><td class="mdescLeft">&#160;</td><td class="mdescRight">Calculates the envelope of a geometry.  <a href="#ga4afb45ba6fb41e732a008a9e1e104347">More...</a><br/></td></tr>
  54 <tr class="separator:ga4afb45ba6fb41e732a008a9e1e104347"><td class="memSeparator" colspan="2">&#160;</td></tr>
  55 </table>
  56 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  57 <h2 class="groupheader">Function Documentation</h2>
  58 <a class="anchor" id="gac1f1865a7b36047d44949e17266d8f5a"></a>
  59 <div class="memitem">
  60 <div class="memproto">
  61 <div class="memtemplate">
  62 template&lt;typename Geometry , typename Box &gt; </div>
  63       <table class="memname">
  64         <tr>
  65           <td class="memname">void boost::geometry::envelope </td>
  66           <td>(</td>
  67           <td class="paramtype">Geometry const &amp;&#160;</td>
  68           <td class="paramname"><em>geometry</em>, </td>
  69         </tr>
  70         <tr>
  71           <td class="paramkey"></td>
  72           <td></td>
  73           <td class="paramtype">Box &amp;&#160;</td>
  74           <td class="paramname"><em>mbr</em>&#160;</td>
  75         </tr>
  76         <tr>
  77           <td></td>
  78           <td>)</td>
  79           <td></td><td></td>
  80         </tr>
  81       </table>
  82 </div><div class="memdoc">
  83
  84 <p>Calculates the envelope of a geometry. </p>
  85 <p>The free function envelope calculates the envelope (also known as axis aligned bounding box, aabb, or minimum bounding rectangle, mbr) of a geometry. </p>
  86 <dl class="tparams"><dt>Template Parameters</dt><dd>
  87   <table class="tparams">
  88     <tr><td class="paramname">Geometry</td><td>Any type fulfilling a Geometry Concept </td></tr>
  89     <tr><td class="paramname">Box</td><td>Any type fulfilling a Box Concept </td></tr>
  90   </table>
  91   </dd>
  92 </dl>
  93 <dl class="params"><dt>Parameters</dt><dd>
  94   <table class="params">
  95     <tr><td class="paramname">geometry</td><td>A model of the specified concept </td></tr>
  96     <tr><td class="paramname">mbr</td><td>A model of the specified Box Concept which is set to the envelope</td></tr>
  97   </table>
  98   </dd>
  99 </dl>
 100   <dl><dt><b>Examples: </b></dt><dd><a class="el" href="02_linestring_example_8cpp-example.html#a7">02_linestring_example.cpp</a>, and <a class="el" href="03_polygon_example_8cpp-example.html#a6">03_polygon_example.cpp</a>.</dd>
 101 </dl>
 102 </div>
 103 </div>
 104 <a class="anchor" id="ga4afb45ba6fb41e732a008a9e1e104347"></a>
 105 <div class="memitem">
 106 <div class="memproto">
 107 <div class="memtemplate">
 108 template&lt;typename Box , typename Geometry &gt; </div>
 109       <table class="memname">
 110         <tr>
 111           <td class="memname">Box boost::geometry::return_envelope </td>
 112           <td>(</td>
 113           <td class="paramtype">Geometry const &amp;&#160;</td>
 114           <td class="paramname"><em>geometry</em></td><td>)</td>
 115           <td></td>
 116         </tr>
 117       </table>
 118 </div><div class="memdoc">
 119
 120 <p>Calculates the envelope of a geometry. </p>
 121 <p>The free function return_envelope calculates the envelope (also known as axis aligned bounding box, aabb, or minimum bounding rectangle, mbr) of a geometry. This version with the return_ prefix returns the envelope, and a template parameter must therefore be specified in the call. </p>
 122 <dl class="tparams"><dt>Template Parameters</dt><dd>
 123   <table class="tparams">
 124     <tr><td class="paramname">Box</td><td>Any type fulfilling a Box Concept </td></tr>
 125     <tr><td class="paramname">Geometry</td><td>Any type fulfilling a Geometry Concept </td></tr>
 126   </table>
 127   </dd>
 128 </dl>
 129 <dl class="params"><dt>Parameters</dt><dd>
 130   <table class="params">
 131     <tr><td class="paramname">geometry</td><td>A model of the specified concept </td></tr>
 132   </table>
 133   </dd>
 134 </dl>
 135 <dl class="section return"><dt>Returns</dt><dd>The calculated envelope</dd></dl>
 136
 137 </div>
 138 </div>
 139 </div><!-- contents -->
 140 <hr size="1">
 141 <table width="100%">
 142 <tbody>
 143 <tr>
 144 <td align="left"><small>
 145 <p>April 2, 2011</p>
 146 </small></td>
 147 <td align="right">
 148 <small>
 149 Copyright &copy; 2007-2011 Barend Gehrels, Amsterdam, the Netherlands<br>
 150 Copyright &copy; 2008-2011 Bruno Lalande, Paris, France<br>
 151 Copyright &copy; 2009-2010 Mateusz Loskot, London, UK<br>
 152 </small>
 153 </td>
 154 </tr>
 155 </tbody>
 156 </table>
 157 <address style="text-align: right;"><small>
 158 Documentation is generated by&nbsp;<a href="http://www.doxygen.org/index.html">Doxygen</a>
 159 </small></address>
 160 </body>
 161 </html>