1[/============================================================================ 2 Boost.Geometry (aka GGL, Generic Geometry Library) 3 4 Copyright (c) 2007-2013 Barend Gehrels, Amsterdam, the Netherlands. 5 Copyright (c) 2008-2013 Bruno Lalande, Paris, France. 6 Copyright (c) 2009-2013 Mateusz Loskot, London, UK. 7 8 Use, modification and distribution is subject to the Boost Software License, 9 Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at 10 http://www.boost.org/LICENSE_1_0.txt) 11=============================================================================/] 12 13 14[/ Generated by doxygen_xml2qbk 1.1.1, don't change, will be overwritten automatically] 15[/ Generated from doxy/doxygen_output/xml/group__touches.xml] 16[section:touches_1_one_geometry touches (one geometry)] 17 18'''<indexterm><primary>touches</primary></indexterm>''' 19Checks if a geometry has at least one touching point (self-tangency) 20 21[heading Synopsis] 22``template<typename Geometry> 23bool touches(Geometry const & geometry)`` 24 25[heading Parameters] 26 27[table 28[[Type] [Concept] [Name] [Description] ] 29[[Geometry const &] [Any type fulfilling a Geometry Concept ] [geometry] [A model of the specified concept ]] 30] 31 32 33[heading Returns] 34Returns true if the geometry is self-touching 35 36[heading Header] 37Either 38 39`#include <boost/geometry.hpp>` 40 41 42Or 43 44`#include <boost/geometry/algorithms/touches.hpp>` 45 46[def __one_parameter__] 47[include reference/algorithms/touches.qbk] 48[heading Examples] 49[touches_one_geometry] 50[touches_one_geometry_output] 51 52 53[endsect] 54 55[section:touches_2_two_geometries touches (two geometries)] 56 57'''<indexterm><primary>touches</primary></indexterm>''' 58Checks if two geometries have at least one touching point (tangent - non overlapping) 59 60[heading Synopsis] 61``template<typename Geometry1, typename Geometry2> 62bool touches(Geometry1 const & geometry1, Geometry2 const & geometry2)`` 63 64[heading Parameters] 65 66[table 67[[Type] [Concept] [Name] [Description] ] 68[[Geometry1 const &] [Any type fulfilling a Geometry Concept ] [geometry1] [A model of the specified concept ]] 69[[Geometry2 const &] [Any type fulfilling a Geometry Concept ] [geometry2] [A model of the specified concept ]] 70] 71 72 73[heading Returns] 74Returns true if two geometries touch each other 75 76[heading Header] 77Either 78 79`#include <boost/geometry.hpp>` 80 81 82Or 83 84`#include <boost/geometry/algorithms/touches.hpp>` 85 86[include reference/algorithms/touches.qbk] 87[heading Examples] 88[touches_two_geometries] 89[touches_two_geometries_output] 90 91 92[endsect] 93 94[section:touches_3_with_strategy touches (with strategy)] 95 96'''<indexterm><primary>touches</primary></indexterm>''' 97Checks if two geometries have at least one touching point (tangent - non overlapping) 98 99[heading Synopsis] 100``template<typename Geometry1, typename Geometry2, typename Strategy> 101bool touches(Geometry1 const & geometry1, Geometry2 const & geometry2, Strategy const & strategy)`` 102 103[heading Parameters] 104 105[table 106[[Type] [Concept] [Name] [Description] ] 107[[Geometry1 const &] [Any type fulfilling a Geometry Concept ] [geometry1] [A model of the specified concept ]] 108[[Geometry2 const &] [Any type fulfilling a Geometry Concept ] [geometry2] [A model of the specified concept ]] 109[[Strategy const &] [Any type fulfilling a Touches Strategy Concept ] [strategy] [The strategy which will be used for touches calculations ]] 110] 111 112 113[heading Returns] 114Returns true if two geometries touch each other 115 116[heading Header] 117Either 118 119`#include <boost/geometry.hpp>` 120 121 122Or 123 124`#include <boost/geometry/algorithms/touches.hpp>` 125 126[include reference/algorithms/touches.qbk] 127 128 129[endsect] 130 131