improve doc + doc parameter for clip

add tests

Author: sloriot

PMP_Boolean_operations/include/CGAL/Polygon_mesh_processing/clip.h

@@ -713,7 +713,7 @@ generic_clip_impl(
   typedef Corefinement::No_mark<TriangleMesh> NoMap;
   typedef Corefinement::Edge_properties_for_input<TriangleMesh, User_cst_map, NoMap, Edge_mark_map, NoMap> Edge_properties_in;
 
-  Edge_mark_map edge_mark_map  = get(CGAL::dynamic_edge_property_t<bool>(), tm1);
+  Edge_mark_map edge_mark_map  = get(CGAL::dynamic_edge_property_t<bool>(), tm1, false);
 
   // Face index point maps
   typedef typename CGAL::GetInitializedFaceIndexMap<TriangleMesh, NamedParameters1>::type FaceIndexMap1;
@@ -838,6 +838,13 @@ struct Visitor_wrapper_for_triangulate_face
   *                     will be set after refining `tm` with the intersection with `clipper`}
   *   \cgalParamNEnd
   *
+  *   \cgalParamNBegin{edge_is_constrained_map}
+  *     \cgalParamDescription{a property map containing the constrained-or-not status of each edge of `tm`}
+  *     \cgalParamType{a class model of `ReadWritePropertyMap` with `boost::graph_traits<TriangleMesh>::%edge_descriptor` as key type and `bool` as value type.
+  *                    If an edge marked as constrained in `tm` is split during clipping, the remaining part after the clip will be marked as constrained.}
+  *     \cgalParamDefault{a constant property map returning `false` for any edge}
+  *   \cgalParamNEnd
+  *
   *   \cgalParamNBegin{visitor}
   *     \cgalParamDescription{a visitor used to track the creation of new faces}
   *     \cgalParamType{a class model of `PMPCorefinementVisitor`}
@@ -943,6 +950,13 @@ clip(TriangleMesh& tm,
   *     \cgalParamDefault{`boost::get(CGAL::vertex_point, pm)`}
   *   \cgalParamNEnd
   *
+  *   \cgalParamNBegin{edge_is_constrained_map}
+  *     \cgalParamDescription{a property map containing the constrained-or-not status of each edge of `tm`}
+  *     \cgalParamType{a class model of `ReadWritePropertyMap` with `boost::graph_traits<TriangleMesh>::%edge_descriptor` as key type and `bool` as value type.
+  *                    If an edge marked as constrained in `tm` is split during clipping, the remaining part after the clip will be marked as constrained.}
+  *     \cgalParamDefault{a constant property map returning `false` for any edge}
+  *   \cgalParamNEnd
+  *
   *   \cgalParamNBegin{visitor}
   *     \cgalParamDescription{a visitor used to track the creation of new faces, edges, and faces.
   *                           Note that as there are no mesh associated with `plane`,
@@ -1032,6 +1046,7 @@ bool clip(PolygonMesh& pm,
     return true;
   }
 
+  using edge_descriptor = typename boost::graph_traits<PolygonMesh>::edge_descriptor;
   using halfedge_descriptor = typename boost::graph_traits<PolygonMesh>::halfedge_descriptor;
 
   using GT = typename GetGeomTraits<PolygonMesh, NamedParameters>::type;
@@ -1064,14 +1079,19 @@ bool clip(PolygonMesh& pm,
   bool triangulate = !choose_parameter(get_parameter(np, internal_np::do_not_triangulate_faces), false);
   constexpr bool traits_supports_cdt2 = !internal::Has_member_Does_not_support_CDT2<GT>::value;
   auto vos = get(dynamic_vertex_property_t<Oriented_side>(), pm);
-  auto ecm = get(dynamic_edge_property_t<bool>(), pm, false);
+
+  using Default_ecm = Static_boolean_property_map<edge_descriptor, false>;
+  auto ecm = choose_parameter<Default_ecm>(get_parameter(np, internal_np::edge_is_constrained));
+  auto edge_is_marked_map = get(dynamic_edge_property_t<bool>(), pm, false);
+
   auto construct_orthogonal_vector = traits.construct_orthogonal_vector_3_object();
 
   if (traits_supports_cdt2 && triangulate && !is_triangle_mesh(pm))
     triangulate = false;
 
   refine_with_plane(pm, plane, parameters::vertex_oriented_side_map(vos)
-                                          .edge_is_marked_map(ecm)
+                                          .edge_is_marked_map(edge_is_marked_map)
+                                          .edge_is_constrained_map(ecm)
                                           .vertex_point_map(vpm)
                                           .geom_traits(traits)
                                           .do_not_triangulate_faces(!triangulate)
@@ -1092,7 +1112,7 @@ bool clip(PolygonMesh& pm,
 
   auto fcc = get(dynamic_face_property_t<std::size_t>(), pm);
 
-  std::size_t nbcc = connected_components(pm, fcc, CGAL::parameters::edge_is_constrained_map(ecm));
+  std::size_t nbcc = connected_components(pm, fcc, CGAL::parameters::edge_is_constrained_map(edge_is_marked_map));
 
   std::vector<bool> classified(nbcc, false);
   std::vector<std::size_t> ccs_to_remove;
@@ -1166,6 +1186,13 @@ bool clip(PolygonMesh& pm,
   *     \cgalParamDefault{`boost::get(CGAL::vertex_point, tm)`}
   *   \cgalParamNEnd
   *
+  *   \cgalParamNBegin{edge_is_constrained_map}
+  *     \cgalParamDescription{a property map containing the constrained-or-not status of each edge of `tm`}
+  *     \cgalParamType{a class model of `ReadWritePropertyMap` with `boost::graph_traits<TriangleMesh>::%edge_descriptor` as key type and `bool` as value type.
+  *                    If an edge marked as constrained in `tm` is split during clipping, the remaining part after the clip will be marked as constrained.}
+  *     \cgalParamDefault{a constant property map returning `false` for any edge}
+  *   \cgalParamNEnd
+  *
   *   \cgalParamNBegin{visitor}
   *     \cgalParamDescription{a visitor used to track the creation of new faces}
   *     \cgalParamType{a class model of `PMPCorefinementVisitor`}
@@ -1239,8 +1266,7 @@ bool clip(TriangleMesh& tm,
 
   make_hexahedron(iso_cuboid[0], iso_cuboid[1], iso_cuboid[2], iso_cuboid[3],
                   iso_cuboid[4], iso_cuboid[5], iso_cuboid[6], iso_cuboid[7],
-                  clipper);
-  triangulate_faces(clipper);
+                  clipper, parameters::do_not_triangulate_faces(false));
 
   const bool do_not_modify = choose_parameter(get_parameter(np, internal_np::allow_self_intersections), false);
   return clip(tm, clipper, np, params::do_not_modify(do_not_modify));

PMP_Boolean_operations/include/CGAL/Polygon_mesh_processing/corefinement.h

@@ -191,8 +191,8 @@ enum Boolean_operation_type {UNION = 0, INTERSECTION=1,
   *
   *   \cgalParamNBegin{edge_is_constrained_map}
   *     \cgalParamDescription{a property map containing the constrained-or-not status of each edge of `tm1` (`tm2`)}
-  *     \cgalParamType{a class model of `ReadWritePropertyMap` with `boost::graph_traits<TriangleMesh>::%edge_descriptor`
-  *                    as key type and `bool` as value type}
+  *     \cgalParamType{a class model of `ReadWritePropertyMap` with `boost::graph_traits<TriangleMesh>::%edge_descriptor`as key type and `bool` as value type.
+  *                    If an edge marked as constrained in `tm1` (tm2`) is split during corefinement, the resulting sub-edges will be marked as constrained.}
   *     \cgalParamDefault{a constant property map returning `false` for any edge}
   *   \cgalParamNEnd
   *
@@ -246,8 +246,8 @@ enum Boolean_operation_type {UNION = 0, INTERSECTION=1,
   *
   *   \cgalParamNBegin{edge_is_constrained_map}
   *     \cgalParamDescription{a property map containing the constrained-or-not status of each edge of `tm_out`.
-  *                           An edge of `tm_out` is constrained if it is on the intersection of `tm1` and `tm2`,
-  *                           or if the edge corresponds to a constrained edge in `tm1` or `tm2`.}
+  *                           An edge of `tm_out` is constrained if the edge corresponds to a constrained edge in `tm1` or `tm2`.
+  *                           If an edge marked as constrained in `tm1` (tm2`) is split during corefinement, the resulting sub-edges will be marked as constrained.}
   *     \cgalParamType{a class model of `WritablePropertyMap` with `boost::graph_traits<TriangleMesh>::%edge_descriptor`
   *                    as key type and `bool` as value type}
   *   \cgalParamNEnd
@@ -529,8 +529,8 @@ corefine_and_compute_boolean_operations(
   *
   *   \cgalParamNBegin{edge_is_constrained_map}
   *     \cgalParamDescription{a property map containing the constrained-or-not status of each edge of `tm1` (`tm2`)}
-  *     \cgalParamType{a class model of `ReadWritePropertyMap` with `boost::graph_traits<TriangleMesh>::%edge_descriptor`
-  *                    as key type and `bool` as value type}
+  *     \cgalParamType{a class model of `ReadWritePropertyMap` with `boost::graph_traits<TriangleMesh>::%edge_descriptor`as key type and `bool` as value type
+  *                    If an edge marked as constrained in `tm1` (tm2`) is split during corefinement, the resulting sub-edges will be marked as constrained.
   *     \cgalParamDefault{a constant property map returning `false` for any edge}
   *   \cgalParamNEnd
   *
@@ -583,8 +583,7 @@ corefine_and_compute_boolean_operations(
   *
   *   \cgalParamNBegin{edge_is_constrained_map}
   *     \cgalParamDescription{a property map containing the constrained-or-not status of each edge of `tm_out`.
-  *                           An edge of `tm_out` is constrained if it is on the intersection of `tm1` and `tm2`,
-  *                           or if the edge corresponds to a constrained edge in `tm1` or `tm2`.}
+  *                           An edge of `tm_out` is constrained if the edge corresponds to a (part of a) constrained edge in `tm1` or `tm2`.}
   *     \cgalParamType{a class model of `WritablePropertyMap` with `boost::graph_traits<TriangleMesh>::%edge_descriptor`
   *                    as key type and `bool` as value type}
   *   \cgalParamNEnd
@@ -724,9 +723,8 @@ corefine_and_compute_difference(      TriangleMesh& tm1,
  *
  *   \cgalParamNBegin{edge_is_constrained_map}
  *     \cgalParamDescription{a property map containing the constrained-or-not status of each edge of `tm1` (`tm2`)}
- *     \cgalParamType{a class model of `ReadWritePropertyMap` with `boost::graph_traits<TriangleMesh>::%edge_descriptor`
- *                    as key type and `bool` as value type. If an edge marked as constrained is split by this function,
- *                    the resulting edges will also be marked as constrained.}
+ *     \cgalParamType{a class model of `ReadWritePropertyMap` with `boost::graph_traits<TriangleMesh>::%edge_descriptor` as key type and `bool` as value type.
+ *                    If an edge marked as constrained in is split during corefinement, the resulting sub-edges will be marked as constrained.}
  *     \cgalParamDefault{a constant property map returning `false` for any edge}
  *   \cgalParamNEnd
  *

PMP_Boolean_operations/test/PMP_Boolean_operations/test_pmp_clip.cpp

@@ -1,5 +1,7 @@
 #include <CGAL/Polygon_mesh_processing/clip.h>
 #include <CGAL/Polygon_mesh_processing/transform.h>
+#include <CGAL/Polygon_mesh_processing/detect_features.h>
+#include <CGAL/boost/graph/generators.h>
 
 #include <CGAL/Surface_mesh.h>
 #include <CGAL/Polyhedron_3.h>
@@ -1294,6 +1296,102 @@ void test_clip_and_split_with_plane_visitor()
 
 }
 
+
+
+
+template <class ECM>
+std::size_t
+count_constrained_edges(const Surface_mesh& tm, ECM ecm)
+{
+  std::size_t n=0;
+  for(auto e : tm.edges())
+  {
+    if ( ecm[e] ) ++n;
+  }
+  return n;
+}
+
+/*
+template <class ECM>
+void dump_constrained_edges(const Surface_mesh& tm, ECM ecm, std::string fname)
+{
+  std::ofstream output(fname);
+  for(auto e : tm.edges())
+  {
+    if ( get(ecm, e) )
+      output << "2 " << tm.point( tm.vertex(e, 0) )
+             <<  " " << tm.point( tm.vertex(e, 1) ) << "\n";
+  }
+}
+*/
+
+void test_edge_is_contrained()
+{
+  {
+  Surface_mesh tm;
+  std::ifstream(CGAL::data_file_path("meshes/joint_refined.off")) >> tm;
+
+  auto ecm = tm.add_property_map<Surface_mesh::Edge_index, bool>("ecm", false).first;
+  PMP::detect_sharp_edges(tm, 60, ecm);
+
+  CGAL::Bbox_3 bb(-0.61222702264785767, -0.31298750638961792, -0.16560758650302887,
+                  0.54861283302307129, 0.62676382064819336, 0.68821543455123901);
+
+  Surface_mesh clipper;
+  CGAL::make_hexahedron(K::Iso_cuboid_3(bb), clipper, params::do_not_triangulate_faces(false));
+
+  PMP::clip(tm, clipper, params::edge_is_constrained_map(ecm));
+
+  assert( count_constrained_edges(tm, ecm)==132 );
+  }
+
+  {
+  Surface_mesh tm;
+  std::ifstream(CGAL::data_file_path("meshes/joint_refined.off")) >> tm;
+
+  auto ecm = tm.add_property_map<Surface_mesh::Edge_index, bool>("ecm", false).first;
+  PMP::detect_sharp_edges(tm, 60, ecm);
+
+  CGAL::Bbox_3 bb(-0.61222702264785767, -0.31298750638961792, -0.16560758650302887,
+                  0.54861283302307129, 0.62676382064819336, 0.68821543455123901);
+
+  Surface_mesh clipper;
+  CGAL::make_hexahedron(K::Iso_cuboid_3(bb), clipper, params::do_not_triangulate_faces(false));
+
+  PMP::clip(tm, clipper, params::edge_is_constrained_map(ecm).clip_volume(true));
+
+  assert( count_constrained_edges(tm, ecm)==132 );
+  }
+
+  {
+  Surface_mesh tm;
+  std::ifstream(CGAL::data_file_path("meshes/joint_refined.off")) >> tm;
+
+  auto ecm = tm.add_property_map<Surface_mesh::Edge_index, bool>("ecm", false).first;
+  PMP::detect_sharp_edges(tm, 60, ecm);
+
+  K::Plane_3 plane(-1.63242e-16, -1, -2.22045e-16, -0.242727);
+
+  PMP::clip(tm, plane, params::edge_is_constrained_map(ecm));
+
+  assert( count_constrained_edges(tm, ecm)==146 );
+  }
+
+  {
+  Surface_mesh tm;
+  std::ifstream(CGAL::data_file_path("meshes/joint_refined.off")) >> tm;
+
+  auto ecm = tm.add_property_map<Surface_mesh::Edge_index, bool>("ecm", false).first;
+  PMP::detect_sharp_edges(tm, 60, ecm);
+
+  K::Plane_3 plane(-1.63242e-16, -1, -2.22045e-16, -0.242727);
+
+  PMP::clip(tm, plane, params::edge_is_constrained_map(ecm).clip_volume(true));
+
+  assert( count_constrained_edges(tm, ecm)==146 );
+  }
+}
+
 int main()
 {
   std::cout << "Surface Mesh" << std::endl;
@@ -1324,6 +1422,9 @@ int main()
   std::cout << "Done!" << std::endl;
   std::cout << "running test_clip_and_split_with_plane_visitor\n";
   test_clip_and_split_with_plane_visitor();
+  std::cout << "running test_edge_is_contrained\n";
+  test_edge_is_contrained();
   std::cout << "Done!" << std::endl;
+
   return EXIT_SUCCESS;
 }