mirror of https://github.com/CGAL/cgal
40 lines
1.6 KiB
TeX
40 lines
1.6 KiB
TeX
\begin{ccRefFunction}{do_intersect}
|
|
\ccInclude{CGAL/intersections.h}
|
|
|
|
\ccUnchecked{
|
|
\ccFunction{bool do_intersect(Type1<Kernel> obj1, Type2<Kernel> obj2);}
|
|
{checks whether \ccc{obj1} and \ccc{obj2} intersect.
|
|
Two objects \ccStyle{obj1} and \ccStyle{obj2} intersect if there is a point
|
|
\ccStyle{p} that is part of both \ccStyle{obj1} and \ccStyle{obj2}.
|
|
The \ccHtmlNoLinksFrom{intersection} region of those two objects is defined as the set of all
|
|
points \ccStyle{p} that are part of both \ccStyle{obj1} and \ccStyle{obj2}.
|
|
Note that for objects like triangles and polygons that enclose a
|
|
bounded region, this region is part of the object.
|
|
}}
|
|
|
|
The types \ccStyle{Type1} and \ccStyle{Type2} can be any of the following:
|
|
\begin{itemize}\ccTexHtml{\itemsep0pt\topsep0pt\partopsep0pt\parskip0pt\parsep0pt}{}
|
|
\item \ccStyle{Point_2<Kernel>}
|
|
\item \ccStyle{Line_2<Kernel>}
|
|
\item \ccStyle{Ray_2<Kernel>}
|
|
\item \ccStyle{Segment_2<Kernel>}
|
|
\item \ccStyle{Triangle_2<Kernel>}
|
|
\item \ccStyle{Iso_rectangle_2<Kernel>}
|
|
\end{itemize}
|
|
|
|
Also, in three-dimensional space \ccc{Type1} can be \ccc{Plane_3<Kernel>} or
|
|
\ccc{Triangle_3<Kernel>} and \ccc{Type2} any of
|
|
\begin{itemize}\ccTexHtml{\itemsep0pt\topsep0pt\partopsep0pt\parskip0pt\parsep0pt}{}
|
|
\item \ccStyle{Plane_3<Kernel>}
|
|
\item \ccStyle{Line_3<Kernel>}
|
|
\item \ccStyle{Ray_3<Kernel>}
|
|
\item \ccStyle{Segment_3<Kernel>}
|
|
\item \ccStyle{Triangle_3<Kernel>}
|
|
\end{itemize}
|
|
Finally, \ccc{Type1} can be of type \ccc{Triangle_3<Kernel>} and \ccc{Type2} of type \ccc{Tetrahedron_3<Kernel>}.
|
|
|
|
\ccSeeAlso
|
|
\ccRefIdfierPage{CGAL::intersection}
|
|
|
|
\end{ccRefFunction}
|