libs/geometry/doc/doxy/doxygen_output/xml/group__touches.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__touches" kind="group">
   4     <compoundname>touches</compoundname>
   5     <title>touches: detect if a geometry self-touches or if two geometries touch</title>
   6       <sectiondef kind="func">
   7       <memberdef kind="function" id="group__touches_1ga34c4c58f9757ecd08dbd413701a59fac" 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         </templateparamlist>
  13         <type>bool</type>
  14         <definition>bool boost::geometry::touches</definition>
  15         <argsstring>(Geometry const &amp;geometry)</argsstring>
  16         <name>touches</name>
  17         <param>
  18           <type>Geometry const &amp;</type>
  19           <declname>geometry</declname>
  20         </param>
  21         <briefdescription>
  22 <para>Checks if a geometry has at least one touching point (self-tangency) </para>        </briefdescription>
  23         <detaileddescription>
  24 <para><simplesect kind="note"><para>This function can be called for one geometry (self-tangency) and also for two geometries (touch)</para></simplesect>
  25 <parameterlist kind="templateparam"><parameteritem>
  26 <parameternamelist>
  27 <parametername>Geometry</parametername>
  28 </parameternamelist>
  29 <parameterdescription>
  30 <para>Any type fulfilling a Geometry Concept </para></parameterdescription>
  31 </parameteritem>
  32 </parameterlist>
  33 <parameterlist kind="param"><parameteritem>
  34 <parameternamelist>
  35 <parametername>geometry</parametername>
  36 </parameternamelist>
  37 <parameterdescription>
  38 <para>A model of the specified concept </para></parameterdescription>
  39 </parameteritem>
  40 </parameterlist>
  41 <simplesect kind="return"><para>Returns true if the geometry is self-touching</para></simplesect>
  42  <qbk.distinguish>one geometry</qbk.distinguish>   <qbk>[def __one_parameter__]</qbk>   <qbk>[include reference/algorithms/touches.qbk]</qbk>  </para>        </detaileddescription>
  43         <inbodydescription>
  44         </inbodydescription>
  45         <location file="/home/ubuntu/boost/boost/geometry/algorithms/touches.hpp" line="560" column="1" bodyfile="/home/ubuntu/boost/boost/geometry/algorithms/touches.hpp" bodystart="560" bodyend="563"/>
  46       </memberdef>
  47       <memberdef kind="function" id="group__touches_1gabbb053b4c78edc40a6c37f1f0f71ddbe" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
  48         <templateparamlist>
  49           <param>
  50             <type>typename Geometry1</type>
  51           </param>
  52           <param>
  53             <type>typename Geometry2</type>
  54           </param>
  55         </templateparamlist>
  56         <type>bool</type>
  57         <definition>bool boost::geometry::touches</definition>
  58         <argsstring>(Geometry1 const &amp;geometry1, Geometry2 const &amp;geometry2)</argsstring>
  59         <name>touches</name>
  60         <param>
  61           <type>Geometry1 const &amp;</type>
  62           <declname>geometry1</declname>
  63         </param>
  64         <param>
  65           <type>Geometry2 const &amp;</type>
  66           <declname>geometry2</declname>
  67         </param>
  68         <briefdescription>
  69 <para>Checks if two geometries have at least one touching point (tangent - non overlapping) </para>        </briefdescription>
  70         <detaileddescription>
  71 <para><parameterlist kind="templateparam"><parameteritem>
  72 <parameternamelist>
  73 <parametername>Geometry1</parametername>
  74 </parameternamelist>
  75 <parameterdescription>
  76 <para>Any type fulfilling a Geometry Concept </para></parameterdescription>
  77 </parameteritem>
  78 <parameteritem>
  79 <parameternamelist>
  80 <parametername>Geometry2</parametername>
  81 </parameternamelist>
  82 <parameterdescription>
  83 <para>Any type fulfilling a Geometry Concept </para></parameterdescription>
  84 </parameteritem>
  85 </parameterlist>
  86 <parameterlist kind="param"><parameteritem>
  87 <parameternamelist>
  88 <parametername>geometry1</parametername>
  89 </parameternamelist>
  90 <parameterdescription>
  91 <para>A model of the specified concept </para></parameterdescription>
  92 </parameteritem>
  93 <parameteritem>
  94 <parameternamelist>
  95 <parametername>geometry2</parametername>
  96 </parameternamelist>
  97 <parameterdescription>
  98 <para>A model of the specified concept </para></parameterdescription>
  99 </parameteritem>
 100 </parameterlist>
 101 <simplesect kind="return"><para>Returns true if two geometries touch each other</para></simplesect>
 102  <qbk.distinguish>two geometries</qbk.distinguish>   <qbk>[include reference/algorithms/touches.qbk]</qbk>  </para>        </detaileddescription>
 103         <inbodydescription>
 104         </inbodydescription>
 105         <location file="/home/ubuntu/boost/boost/geometry/algorithms/touches.hpp" line="579" column="1" bodyfile="/home/ubuntu/boost/boost/geometry/algorithms/touches.hpp" bodystart="579" bodyend="582"/>
 106       </memberdef>
 107       </sectiondef>
 108     <briefdescription>
 109     </briefdescription>
 110     <detaileddescription>
 111     </detaileddescription>
 112   </compounddef>
 113 </doxygen>