libs/geometry/doc/doxy/doxygen_output/xml/group__envelope.xml

   1 <?xml version='1.0' encoding='UTF-8' standalone='no'?>
   2 <doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="1.8.6">
   3   <compounddef id="group__envelope" kind="group">
   4     <compoundname>envelope</compoundname>
   5     <title>envelope: calculate envelope (minimum bounding rectangle) of a geometry</title>
   6       <sectiondef kind="func">
   7       <memberdef kind="function" id="group__envelope_1gac1f1865a7b36047d44949e17266d8f5a" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
   8         <templateparamlist>
   9           <param>
  10             <type>typename Geometry</type>
  11           </param>
  12           <param>
  13             <type>typename Box</type>
  14           </param>
  15         </templateparamlist>
  16         <type>void</type>
  17         <definition>void boost::geometry::envelope</definition>
  18         <argsstring>(Geometry const &amp;geometry, Box &amp;mbr)</argsstring>
  19         <name>envelope</name>
  20         <param>
  21           <type>Geometry const &amp;</type>
  22           <declname>geometry</declname>
  23         </param>
  24         <param>
  25           <type>Box &amp;</type>
  26           <declname>mbr</declname>
  27         </param>
  28         <briefdescription>
  29 <para>Calculates the envelope of a geometry. </para>        </briefdescription>
  30         <detaileddescription>
  31 <para>The free function envelope calculates the envelope (also known as axis aligned bounding box, aabb, or minimum bounding rectangle, mbr) of a geometry. <parameterlist kind="templateparam"><parameteritem>
  32 <parameternamelist>
  33 <parametername>Geometry</parametername>
  34 </parameternamelist>
  35 <parameterdescription>
  36 <para>Any type fulfilling a Geometry Concept </para></parameterdescription>
  37 </parameteritem>
  38 <parameteritem>
  39 <parameternamelist>
  40 <parametername>Box</parametername>
  41 </parameternamelist>
  42 <parameterdescription>
  43 <para>Any type fulfilling a Box Concept </para></parameterdescription>
  44 </parameteritem>
  45 </parameterlist>
  46 <parameterlist kind="param"><parameteritem>
  47 <parameternamelist>
  48 <parametername>geometry</parametername>
  49 </parameternamelist>
  50 <parameterdescription>
  51 <para>A model of the specified concept </para></parameterdescription>
  52 </parameteritem>
  53 <parameteritem>
  54 <parameternamelist>
  55 <parametername>mbr</parametername>
  56 </parameternamelist>
  57 <parameterdescription>
  58 <para>A model of the specified Box Concept which is set to the envelope</para></parameterdescription>
  59 </parameteritem>
  60 </parameterlist>
  61  <qbk>[include reference/algorithms/envelope.qbk]</qbk>   <qbk>
  62 [heading Example]
  63 [envelope] [envelope_output]
  64 </qbk>  </para>        </detaileddescription>
  65         <inbodydescription>
  66         </inbodydescription>
  67         <location file="/home/ubuntu/boost/boost/geometry/algorithms/detail/envelope/interface.hpp" line="95" column="1" bodyfile="/home/ubuntu/boost/boost/geometry/algorithms/detail/envelope/interface.hpp" bodystart="95" bodyend="98"/>
  68       </memberdef>
  69       <memberdef kind="function" id="group__envelope_1ga4afb45ba6fb41e732a008a9e1e104347" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
  70         <templateparamlist>
  71           <param>
  72             <type>typename Box</type>
  73           </param>
  74           <param>
  75             <type>typename Geometry</type>
  76           </param>
  77         </templateparamlist>
  78         <type>Box</type>
  79         <definition>Box boost::geometry::return_envelope</definition>
  80         <argsstring>(Geometry const &amp;geometry)</argsstring>
  81         <name>return_envelope</name>
  82         <param>
  83           <type>Geometry const &amp;</type>
  84           <declname>geometry</declname>
  85         </param>
  86         <briefdescription>
  87 <para>Calculates the envelope of a geometry. </para>        </briefdescription>
  88         <detaileddescription>
  89 <para>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. <parameterlist kind="templateparam"><parameteritem>
  90 <parameternamelist>
  91 <parametername>Box</parametername>
  92 </parameternamelist>
  93 <parameterdescription>
  94 <para>Any type fulfilling a Box Concept </para></parameterdescription>
  95 </parameteritem>
  96 <parameteritem>
  97 <parameternamelist>
  98 <parametername>Geometry</parametername>
  99 </parameternamelist>
 100 <parameterdescription>
 101 <para>Any type fulfilling a Geometry Concept </para></parameterdescription>
 102 </parameteritem>
 103 </parameterlist>
 104 <parameterlist kind="param"><parameteritem>
 105 <parameternamelist>
 106 <parametername>geometry</parametername>
 107 </parameternamelist>
 108 <parameterdescription>
 109 <para>A model of the specified concept </para></parameterdescription>
 110 </parameteritem>
 111 </parameterlist>
 112 <simplesect kind="return"><para>The calculated envelope</para></simplesect>
 113  <qbk>[include reference/algorithms/envelope.qbk]</qbk>   <qbk>
 114 [heading Example]
 115 [return_envelope] [return_envelope_output]
 116 </qbk>  </para>        </detaileddescription>
 117         <inbodydescription>
 118         </inbodydescription>
 119         <location file="/home/ubuntu/boost/boost/geometry/algorithms/detail/envelope/interface.hpp" line="117" column="1" bodyfile="/home/ubuntu/boost/boost/geometry/algorithms/detail/envelope/interface.hpp" bodystart="117" bodyend="122"/>
 120       </memberdef>
 121       </sectiondef>
 122     <briefdescription>
 123     </briefdescription>
 124     <detaileddescription>
 125     </detaileddescription>
 126   </compounddef>
 127 </doxygen>