diff --git a/Polygon_mesh_processing/doc/Polygon_mesh_processing/PackageDescription.txt b/Polygon_mesh_processing/doc/Polygon_mesh_processing/PackageDescription.txt index 0b4e1e0b39a..910305a59ae 100644 --- a/Polygon_mesh_processing/doc/Polygon_mesh_processing/PackageDescription.txt +++ b/Polygon_mesh_processing/doc/Polygon_mesh_processing/PackageDescription.txt @@ -39,5 +39,6 @@ - `CGAL::is_oriented()` - \link polyhedron_stitching_grp `CGAL::polyhedron_stitching()` \endlink - `CGAL::triangulate_polyhedron()` - +- `CGAL::self_intersect()` +- `CGAL::do_self_intersect()` */ \ No newline at end of file diff --git a/Operations_on_polyhedra/include/CGAL/Self_intersection_polyhedron_3.h b/Polygon_mesh_processing/include/CGAL/Self_intersection_polyhedron_3.h similarity index 94% rename from Operations_on_polyhedra/include/CGAL/Self_intersection_polyhedron_3.h rename to Polygon_mesh_processing/include/CGAL/Self_intersection_polyhedron_3.h index 136cc849365..ddcbb04368f 100644 --- a/Operations_on_polyhedra/include/CGAL/Self_intersection_polyhedron_3.h +++ b/Polygon_mesh_processing/include/CGAL/Self_intersection_polyhedron_3.h @@ -201,7 +201,9 @@ concept SelfIntersectionTraits{ //////////////////////////////////////////////////////////////////////////////////// /** - * Detects and reports self-intersections of a triangulated polyhedral surface + * \ingroup PkgPolygonMeshProcessing + * Detects and reports self-intersections of a triangulated polyhedral surface. + * Depends on \ref PkgBoxIntersectionDSummary * @pre @a p.is_pure_triangle() * * @tparam GeomTraits a model of `SelfIntersectionTraits` @@ -211,10 +213,10 @@ concept SelfIntersectionTraits{ * * @param polyhedron polyhedron to be checked, might be passed by const reference or reference * @param out all pairs of non-adjacent facets intersecting are put in it - * + * @param geom_traits traits class providing intersection test primitives * @return pair of bool and out, where the bool indicates whether there is an intersection or not * - * \TODO Doc: move SelfIntersectionTraits concept to appropriate location. + * \todo Doc: move SelfIntersectionTraits concept to appropriate location. */ template std::pair @@ -263,19 +265,22 @@ self_intersect(Polyhedron& polyhedron, OutputIterator out, const GeomTraits& geo return std::make_pair(intersect_facets.m_intersected, intersect_facets.m_iterator); } -/** - * Checks if a polyhedron is self-intersecting +/** + * \ingroup PkgPolygonMeshProcessing + * Checks if a polyhedron is self-intersecting. + * Depends on \ref PkgBoxIntersectionDSummary * @pre @a p.is_pure_triangle() * * @tparam GeomTraits a model of `SelfIntersectionTraits` * @tparam Polyhedron a %CGAL polyhedron * * @param polyhedron polyhedron to be tested + * @param geom_traits traits class providing intersection test primitives * * @return true if `polyhedron` is self-intersecting */ template -bool self_intersect(const Polyhedron& polyhedron, const GeomTraits& geom_traits = GeomTraits()) +bool do_self_intersect(const Polyhedron& polyhedron, const GeomTraits& geom_traits = GeomTraits()) { try {