• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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__intersects.xml]
16[section:intersects_1_one_geometry intersects (one geometry)]
17
18'''<indexterm><primary>intersects</primary></indexterm>'''
19Checks if a geometry has at least one intersection (crossing or self-tangency)
20
21[heading Synopsis]
22``template<typename Geometry>
23bool intersects(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-intersecting
35
36[heading Header]
37Either
38
39`#include <boost/geometry.hpp>`
40
41
42Or
43
44`#include <boost/geometry/algorithms/intersects.hpp>`
45
46[def __one_parameter__]
47[include reference/algorithms/intersects.qbk]
48
49
50[endsect]
51
52[section:intersects_3_with_strategy intersects (with strategy)]
53
54'''<indexterm><primary>intersects</primary></indexterm>'''
55Checks if two geometries have at least one intersection.
56
57[heading Synopsis]
58``template<typename Geometry1, typename Geometry2, typename Strategy>
59bool intersects(Geometry1 const & geometry1, Geometry2 const & geometry2, Strategy const & strategy)``
60
61[heading Parameters]
62
63[table
64[[Type] [Concept] [Name] [Description] ]
65[[Geometry1 const &] [Any type fulfilling a Geometry Concept ] [geometry1] [A model of the specified concept ]]
66[[Geometry2 const &] [Any type fulfilling a Geometry Concept ] [geometry2] [A model of the specified concept ]]
67[[Strategy const &] [Any type fulfilling a Intersects Strategy Concept ] [strategy] [The strategy which will be used for intersects calculations ]]
68]
69
70
71[heading Returns]
72Returns true if two geometries intersect each other
73
74[heading Header]
75Either
76
77`#include <boost/geometry.hpp>`
78
79
80Or
81
82`#include <boost/geometry/algorithms/intersects.hpp>`
83
84[include reference/algorithms/intersects.qbk]
85
86
87[endsect]
88
89[section:intersects_2_two_geometries intersects (two geometries)]
90
91'''<indexterm><primary>intersects</primary></indexterm>'''
92Checks if two geometries have at least one intersection.
93
94[heading Synopsis]
95``template<typename Geometry1, typename Geometry2>
96bool intersects(Geometry1 const & geometry1, Geometry2 const & geometry2)``
97
98[heading Parameters]
99
100[table
101[[Type] [Concept] [Name] [Description] ]
102[[Geometry1 const &] [Any type fulfilling a Geometry Concept ] [geometry1] [A model of the specified concept ]]
103[[Geometry2 const &] [Any type fulfilling a Geometry Concept ] [geometry2] [A model of the specified concept ]]
104]
105
106
107[heading Returns]
108Returns true if two geometries intersect each other
109
110[heading Header]
111Either
112
113`#include <boost/geometry.hpp>`
114
115
116Or
117
118`#include <boost/geometry/algorithms/intersects.hpp>`
119
120[include reference/algorithms/intersects.qbk]
121
122
123[endsect]
124
125