Merge pull request #18 from compas-dev/mesh-split

add mesh split endpoint

Author: Licini

CHANGELOG.md

@@ -10,6 +10,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 * Support to python 3.10.
 * Added Changelog check in PRs.
+* Exposing mesh `split` function.
 
 ### Changed
 * Updated github workflow.

docs/_images/cgal_boolean_split.jpg

@@ -0,0 +1,50 @@
+from compas.geometry import Point
+from compas.geometry import Box
+from compas.geometry import Sphere
+from compas.datastructures import Mesh
+from compas.colors import Color
+from random import random
+
+from compas_view2.app import App
+
+from compas_cgal.booleans import split
+from compas.topology import connected_components
+
+# ==============================================================================
+# Make a box and a sphere
+# ==============================================================================
+
+box = Box.from_width_height_depth(2, 2, 2)
+box = Mesh.from_shape(box)
+box.quads_to_triangles()
+
+A = box.to_vertices_and_faces()
+
+sphere = Sphere(Point(1, 1, 1), 1)
+sphere = Mesh.from_shape(sphere, u=20, v=20)
+sphere.quads_to_triangles()
+
+B = sphere.to_vertices_and_faces()
+
+# ==============================================================================
+# Compute the mesh split
+# ==============================================================================
+
+V, F = split(A, B)
+
+mesh = Mesh.from_vertices_and_faces(V, F)
+
+# ==============================================================================
+# Seperate disjoint faces and visualize
+# ==============================================================================
+
+viewer = App()
+
+fa = mesh.face_adjacency()
+parts = connected_components(fa)
+for face_indexes in connected_components(fa):
+    mesh = Mesh.from_vertices_and_faces(V, F[face_indexes])
+    mesh.remove_unused_vertices()
+    viewer.add(mesh, facecolor=Color.from_i(random()))
+
+viewer.run()

docs/examples/booleans_split.py

@@ -0,0 +1,11 @@
+********************************************************************************
+Mesh Split
+********************************************************************************
+
+.. figure:: /_images/cgal_boolean_split.jpg
+    :figclass: figure
+    :class: figure-img img-fluid
+
+
+.. literalinclude:: booleans_split.py
+    :language: python

docs/examples/mesh_split.rst

@@ -9,12 +9,13 @@ invoke >=0.14
 ipykernel
 ipython >=5.8
 isort
-m2r
+m2r2
 nbsphinx
 pydocstyle
-pytest >=3.2
+pytest <7.1
 sphinx_compas_theme >=0.15.18
-sphinx >=3.4
+sphinx ==4.5
 twine
 wheel
+jinja2 >= 3.0
 -e .

requirements-dev.txt

@@ -1,5 +1,6 @@
 #include "booleans.h"
 #include <CGAL/Polygon_mesh_processing/corefinement.h>
+#include <CGAL/Polygon_mesh_processing/clip.h>
 
 
 namespace PMP = CGAL::Polygon_mesh_processing;
@@ -68,6 +69,28 @@ pmp_boolean_intersection(
 };
 
 
+std::tuple<compas::RowMatrixXd, compas::RowMatrixXi>
+pmp_split(
+    Eigen::Ref<const compas::RowMatrixXd> &VA,
+    Eigen::Ref<const compas::RowMatrixXi> &FA,
+    Eigen::Ref<const compas::RowMatrixXd> &VB,
+    Eigen::Ref<const compas::RowMatrixXi> &FB)
+{
+    Mesh A = compas::mesh_from_vertices_and_faces(VA, FA);
+    Mesh B = compas::mesh_from_vertices_and_faces(VB, FB);
+    // Mesh C;
+
+    // PMP::clip(A, B, CGAL::parameters::clip_volume(false), CGAL::parameters::clip_volume(false));
+    PMP::split(A, B);
+
+    // Result
+
+    std::tuple<compas::RowMatrixXd, compas::RowMatrixXi> R = compas::mesh_to_vertices_and_faces(A);
+
+    return R;
+};
+
+
 void init_booleans(pybind11::module &m)
 {
     pybind11::module submodule = m.def_submodule("booleans");
@@ -95,4 +118,12 @@ void init_booleans(pybind11::module &m)
         pybind11::arg("FA").noconvert(),
         pybind11::arg("VB").noconvert(),
         pybind11::arg("FB").noconvert());
+    
+    submodule.def(
+        "split",
+        &pmp_split,
+        pybind11::arg("VA").noconvert(),
+        pybind11::arg("FA").noconvert(),
+        pybind11::arg("VB").noconvert(),
+        pybind11::arg("FB").noconvert());
 };

src/booleans.cpp

@@ -28,4 +28,12 @@ pmp_boolean_intersection(
     Eigen::Ref<const compas::RowMatrixXi> &FB);
 
 
+std::tuple<compas::RowMatrixXd, compas::RowMatrixXi>
+pmp_clip(
+    Eigen::Ref<const compas::RowMatrixXd> &VA,
+    Eigen::Ref<const compas::RowMatrixXi> &FA,
+    Eigen::Ref<const compas::RowMatrixXd> &VB,
+    Eigen::Ref<const compas::RowMatrixXi> &FB);
+
+
 #endif /* COMPAS_BOOLEANS_H */

src/booleans.h

@@ -15,6 +15,7 @@
     booleans.boolean_union
     booleans.boolean_difference
     booleans.boolean_intersection
+    booleans.split
 
 Intersections
 =============

src/compas_cgal/__init__.py

@@ -41,6 +41,8 @@ def _boolean(A, B, operation):
         result = booleans.boolean_difference(VA, FA, VB, FB)
     elif operation == 'intersection':
         result = booleans.boolean_intersection(VA, FA, VB, FB)
+    elif operation == 'split':
+        result = booleans.split(VA, FA, VB, FB)
     else:
         raise NotImplementedError
 
@@ -159,3 +161,41 @@ def boolean_intersection(A, B):
 
     """
     return _boolean(A, B, 'intersection')
+
+
+@plugin(category='booleans', pluggable_name='split_mesh_mesh')
+def split(A, B):
+    """Split one mesh with another.
+
+    Parameters
+    ----------
+    A : tuple[Sequence[[float, float, float] | :class:`~compas.geometry.Point`], Sequence[[int, int, int]]]
+        Mesh A.
+    B : tuple[Sequence[[float, float, float] | :class:`~compas.geometry.Point`], Sequence[[int, int, int]]]
+        Mesh B.
+    operation : Literal['union', 'difference', 'intersection']
+        The type of boolean operation.
+
+    Returns
+    -------
+    NDArray[(Any, 3), np.float64]
+        The vertices of the boolean mesh.
+    NDArray[(Any, 3), np.int32]
+        The faces of the boolean mesh.
+
+    Examples
+    --------
+    >>> from compas.geometry import Box, Sphere, Polyhedron
+    >>> from compas_cgal.booleans import split
+
+    >>> box = Box.from_width_height_depth(1, 1, 1)
+    >>> sphere = Sphere([1, 1, 1], 0.5)
+
+    >>> A = box.to_vertices_and_faces(triangulated=True)
+    >>> B = sphere.to_vertices_and_faces(u=32, v=32, triangulated=True)
+
+    >>> V, F = split(A, B)
+    >>> mesh = Mesh.from_vertices_and_faces(V, F)
+
+    """
+    return _boolean(A, B, 'split')

src/compas_cgal/booleans.py

@@ -4,7 +4,7 @@ from compas_cgal.types import VerticesFaces
 from compas_cgal.types import VerticesFacesNumpy
 
 
-def _boolean(A: VerticesFaces, B: VerticesFaces, operation: Literal['union', 'difference', 'intersection']) -> VerticesFacesNumpy:
+def _boolean(A: VerticesFaces, B: VerticesFaces, operation: Literal['union', 'difference', 'intersection', 'split']) -> VerticesFacesNumpy:
     pass
 
 
@@ -18,3 +18,6 @@ def boolean_difference(A: VerticesFaces, B: VerticesFaces) -> VerticesFacesNumpy
 
 def boolean_intersection(A: VerticesFaces, B: VerticesFaces) -> VerticesFacesNumpy:
     pass
+
+def split(A: VerticesFaces, B: VerticesFaces) -> VerticesFacesNumpy:
+    pass