fix: use global verbose flag instead of per function variable

to set verbose mode on loop_cgal.set_verbose(True)

Author: lachlangrose

CMakeLists.txt

@@ -26,17 +26,18 @@ include_directories(${CMAKE_SOURCE_DIR}/src)
 find_package(pybind11 REQUIRED)
 
 # Add the Python module
-add_library(loop_cgal MODULE
+add_library(_loop_cgal MODULE
     loop_cgal/bindings.cpp
     src/clip.cpp
     src/mesh.cpp
     src/meshutils.cpp
+    src/globals.cpp
 
 )
-target_link_libraries(loop_cgal PRIVATE pybind11::module CGAL::CGAL)
-target_include_directories(loop_cgal PRIVATE ${CMAKE_SOURCE_DIR}/src)
-set_target_properties(loop_cgal PROPERTIES PREFIX "" SUFFIX ".so")
+target_link_libraries(_loop_cgal PRIVATE pybind11::module CGAL::CGAL)
+target_include_directories(_loop_cgal PRIVATE ${CMAKE_SOURCE_DIR}/src)
+set_target_properties(_loop_cgal PROPERTIES PREFIX "" SUFFIX ".so")
 # Install the Python module to the correct location
-install(TARGETS loop_cgal
+install(TARGETS _loop_cgal
     LIBRARY DESTINATION ${CMAKE_INSTALL_PREFIX}/loop_cgal
 )

examples/clip_v2.py

@@ -2,10 +2,11 @@
 import numpy as np
 import pyvista as pv
 from LoopStructural.datatypes import BoundingBox
+loop_cgal.set_verbose(True)
+print(loop_cgal.verbose)  # Should print True
 def test():
     bb = BoundingBox(np.zeros(3), np.ones(3))
     grid = bb.structured_grid().vtk()
-    print(grid)
     grid["scalars"] = grid.points[:,0]
     surface = grid.contour([.5])
     surface_1_tri = surface.faces.reshape(-1, 4)[:, 1:].copy()
@@ -18,12 +19,9 @@ def test():
     # surface_cgal.remesh(target_edge_length=0.02, verbose=True,protect_constraints=True, relax_constraints=False, number_of_iterations=1,split_long_edges=False)
     surface_cgal_2 = loop_cgal.TriMesh(surface_2)
     # surface_cgal_2.remesh(target_edge_length=0.02, verbose=True,protect_constraints=True, relax_constraints=False, number_of_iterations=1,split_long_edges=False)
-    print("clipping 1")
-    surface_cgal.cut_with_surface(surface_cgal_2,verbose=True, preserve_intersection=False, preserve_intersection_clipper=False)
+    surface_cgal.cut_with_surface(surface_cgal_2, preserve_intersection=False, preserve_intersection_clipper=False)
 
-    print("reverse face orientation")
     surface_cgal_2.reverse_face_orientation()
-    print("clipping 3")
     surface_cgal_3 = loop_cgal.TriMesh(surface)
     # surface_cgal_3.remesh(target_edge_length=0.02, verbose=True,protect_constraints=True, relax_constraints=False, number_of_iterations=1,split_long_edges=False)
     surface_cgal_3.cut_with_surface(surface_cgal_2)

loop_cgal/__init__.py

@@ -5,9 +5,10 @@
 import numpy as np
 import pyvista as pv
 
-from .loop_cgal import NumpyMesh, NumpyPlane, clip_plane, clip_surface, corefine_mesh
-from .loop_cgal import TriMesh as _TriMesh
-
+from ._loop_cgal import NumpyMesh, NumpyPlane, clip_plane, clip_surface, corefine_mesh
+from ._loop_cgal import TriMesh as _TriMesh
+from ._loop_cgal import verbose
+from ._loop_cgal import set_verbose as set_verbose
 class TriMesh(_TriMesh):
     """
     A class for handling triangular meshes using CGAL.
@@ -21,7 +22,7 @@ def __init__(self, surface: pv.PolyData):
 
     def to_pyvista(self, area_threshold: float = 1e-6,  # this is the area threshold for the faces, if the area is smaller than this it will be removed
             duplicate_vertex_threshold: float = 1e-4,  # this is the threshold for duplicate vertices
-            verbose: bool = False) -> pv.PolyData:
+            ) -> pv.PolyData:
         """
         Convert the TriMesh to a pyvista PolyData object.
         
@@ -30,7 +31,7 @@ def to_pyvista(self, area_threshold: float = 1e-6,  # this is the area threshold
         pyvista.PolyData
             The converted PolyData object.
         """
-        np_mesh = self.save(area_threshold, duplicate_vertex_threshold, verbose)
+        np_mesh = self.save(area_threshold, duplicate_vertex_threshold)
         vertices = np.array(np_mesh.vertices).copy()
         triangles = np.array(np_mesh.triangles).copy()
         return pv.PolyData.from_regular_faces(vertices, triangles)
@@ -47,7 +48,6 @@ def clip_pyvista_polydata_with_plane(
     area_threshold: float = 0.0001,
     protect_constraints: bool = False,
     relax_constraints: bool = True,
-    verbose: bool = False,
 ) -> pv.PolyData:
     """
     Clip a pyvista PolyData object with a plane using the CGAL library.
@@ -72,8 +72,7 @@ def clip_pyvista_polydata_with_plane(
         The threshold for merging duplicate vertices, by default 0.001
     area_threshold : float, optional
         The area threshold for removing small faces, by default 0.0001
-    verbose : bool, optional
-        Whether to print verbose output, by default False
+    
     Returns
     -------
     pyvista.PolyData
@@ -98,7 +97,6 @@ def clip_pyvista_polydata_with_plane(
         area_threshold=area_threshold,
         protect_constraints=protect_constraints,
         relax_constraints=relax_constraints,
-        verbose=verbose,
     )
     return pv.PolyData.from_regular_faces(mesh.vertices, mesh.triangles)
 
@@ -114,7 +112,6 @@ def clip_pyvista_polydata(
     area_threshold: float = 0.0001,
     protect_constraints: bool = False,
     relax_constraints: bool = True,
-    verbose: bool = False,
 ) -> pv.PolyData:
     """
     Clip two pyvista PolyData objects using the CGAL library.
@@ -150,7 +147,6 @@ def clip_pyvista_polydata(
         area_threshold=area_threshold,
         protect_constraints=protect_constraints,
         relax_constraints=relax_constraints,
-        verbose=verbose,
     )
     return pv.PolyData.from_regular_faces(mesh.vertices, mesh.triangles)
 
@@ -164,7 +160,6 @@ def corefine_pyvista_polydata(
     number_of_iterations: int = 10,
     protect_constraints: bool = True,
     relax_constraints: bool = True,
-    verbose: bool = False,
 ) -> Tuple[pv.PolyData, pv.PolyData]:
     """
     Corefine two pyvista PolyData objects using the CGAL library.
@@ -199,7 +194,6 @@ def corefine_pyvista_polydata(
         number_of_iterations=number_of_iterations,
         relax_constraints=relax_constraints,
         protect_constraints=protect_constraints,
-        verbose=verbose,
     )
     return (
         pv.PolyData.from_regular_faces(tm1.vertices, tm1.triangles),

loop_cgal/bindings.cpp

@@ -4,12 +4,13 @@
 #include "clip.h" // Include the API implementation
 #include "mesh.h"
 #include "numpymesh.h"
-
+#include "globals.h" // Include the global verbose flag
 namespace py = pybind11;
 
-PYBIND11_MODULE(loop_cgal, m)
+PYBIND11_MODULE(_loop_cgal, m)
 {
-
+     m.attr("verbose") = &LoopCGAL::verbose; // Expose the global verbose flag
+     m.def("set_verbose", &LoopCGAL::set_verbose, "Set the verbose flag");
      m.def("clip_surface", &clip_surface, py::arg("tm"), py::arg("clipper"),
            py::arg("target_edge_length") = 10.0,
            py::arg("remesh_before_clipping") = true,
@@ -49,18 +50,15 @@ PYBIND11_MODULE(loop_cgal, m)
          .def(py::init<const pybind11::array_t<double> &, const pybind11::array_t<int> &>(),
               py::arg("vertices"), py::arg("triangles"))
          .def("cut_with_surface", &TriMesh::cutWithSurface, py::arg("surface"),
-              py::arg("verbose") = false,
               py::arg("preserve_intersection") = false,
               py::arg("preserve_intersection_clipper") = false)
          .def("remesh", &TriMesh::remesh, py::arg("split_long_edges") = true,
-              py::arg("verbose") = false,
               py::arg("target_edge_length") = 10.0,
               py::arg("number_of_iterations") = 3,
               py::arg("protect_constraints") = true,
               py::arg("relax_constraints") = false)
          .def("save", &TriMesh::save, py::arg("area_threshold") = 1e-6,
-              py::arg("duplicate_vertex_threshold") = 1e-6,
-              py::arg("verbose") = false)
+              py::arg("duplicate_vertex_threshold") = 1e-6)
          .def("reverse_face_orientation", &TriMesh::reverseFaceOrientation,
               "Reverse the face orientation of the mesh.")
          .def("add_fixed_edges", &TriMesh::add_fixed_edges,

src/clip.cpp

@@ -271,7 +271,7 @@ NumpyMesh clip_plane(NumpyMesh tm, NumpyPlane clipper,
   // store the result in a numpymesh object for sending back to Python
 
   NumpyMesh result =
-      export_mesh(_tm, area_threshold, duplicate_vertex_threshold, verbose);
+      export_mesh(_tm, area_threshold, duplicate_vertex_threshold);
   if (verbose) {
     std::cout << "Exported clipped mesh with " << result.vertices.shape(0)
               << " vertices and " << result.triangles.shape(0) << " triangles."
@@ -299,7 +299,9 @@ NumpyMesh clip_surface(NumpyMesh tm, NumpyMesh clipper,
   if (!CGAL::is_valid_polygon_mesh(_tm, verbose)) {
     std::cerr << "tm is invalid!" << std::endl;
     if (verbose)
+    {
       CGAL::is_valid_polygon_mesh(_tm, true);
+    }
   }
   if (!CGAL::is_valid_polygon_mesh(_clipper, verbose)) {
     std::cerr << "clipper is invalid!" << std::endl;
@@ -386,7 +388,9 @@ NumpyMesh clip_surface(NumpyMesh tm, NumpyMesh clipper,
     }
   } else {
     if (verbose)
+    {
       std::cout << "Meshes do not intersect. Returning tm." << std::endl;
+    }
   }
   if (verbose) {
     std::cout << "Clipping done." << std::endl;
@@ -395,7 +399,7 @@ NumpyMesh clip_surface(NumpyMesh tm, NumpyMesh clipper,
   // store the result in a numpymesh object for sending back to Python
 
   NumpyMesh result =
-      export_mesh(_tm, area_threshold, duplicate_vertex_threshold, verbose);
+      export_mesh(_tm, area_threshold, duplicate_vertex_threshold);
   if (verbose) {
     std::cout << "Exported clipped mesh with " << result.vertices.shape(0)
               << " vertices and " << result.triangles.shape(0) << " triangles."
@@ -437,10 +441,11 @@ corefine_mesh(NumpyMesh tm1, NumpyMesh tm2, double target_edge_length,
     }
   }
   if (verbose)
+  {
     std::cout << "Found " << tm_1_shared_edges.size()
               << " shared edges in tm1 and " << tm_2_shared_edges.size()
               << " shared edges in tm2." << std::endl;
-
+  }
   // std::set<TriangleMesh::Edge_index> constrained_edges;
 
   std::set<TriangleMesh::Edge_index> boundary_edges =
@@ -470,9 +475,10 @@ corefine_mesh(NumpyMesh tm1, NumpyMesh tm2, double target_edge_length,
           .protect_constraints(protect_constraints));
 
   if (verbose)
+  {
     std::cout << "Corefinement done." << std::endl;
-
+  }
   return {
-      export_mesh(_tm1, area_threshold, duplicate_vertex_threshold, verbose),
-      export_mesh(_tm2, area_threshold, duplicate_vertex_threshold, verbose)};
+      export_mesh(_tm1, area_threshold, duplicate_vertex_threshold),
+      export_mesh(_tm2, area_threshold, duplicate_vertex_threshold)};
 }

src/globals.cpp

@@ -0,0 +1,13 @@
+#include "globals.h"
+#include <iostream>
+
+namespace LoopCGAL
+{
+    bool verbose = false; // Definition of the verbose flag
+
+    void set_verbose(bool value)
+    {
+        verbose = value;
+        std::cout << "Verbose flag set to: " << verbose << std::endl;
+    }
+}

src/globals.h

@@ -4,6 +4,7 @@
 namespace LoopCGAL
 {
     extern bool verbose; // Declaration of the module-wide verbose flag
+    void set_verbose(bool value); // Declaration of the set_verbose function
 }
 
 #endif // GLOBALS_H