Merge pull request #1073 from compas-dev/brep_split

implemented split operation in RhinoBrep

Author: tomvanmele

CHANGELOG.md

@@ -20,6 +20,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 * Added `format` task using `black` formatter.
 
 * Added a `test_intersection_circle_circle_xy` in the `test_intersections`
+* Added split operation to `compas_rhino.geometry.Brep`.
 
 ### Changed
 * Based all gltf data classes on `BaseGLTFDataClass`

docs/tutorial/brep.rst

@@ -110,6 +110,27 @@ Trimming a Brep in Grasshopper
 .. |pic2| image:: files/trimmed_box.png
    :width: 48%
 
+Splitting a Brep in Grasshopper
+
+.. code-block::
+
+    from compas.geometry import Brep, Box, Frame, Translation
+
+    brep = Brep.from_box(Box.from_width_height_depth(5,5,5))
+    cutter = Brep.from_box(Box.from_width_height_depth(1, 6, 6))
+
+    a, b, c = brep.split(cutter)
+
+    world_xy = Frame.worldXY()
+    translated_frame = Frame((0, 0, 1.), world_xy.xaxis, world_xy.yaxis)
+    t = Translation.from_frame_to_frame(world_xy, translated_frame)
+    a.transform(t)
+    b.transform(t)
+
+    result = [x.native_brep for x in [a, b, c]]
+
+.. image:: files/3_way_split.png
+    :width: 50%
 
 Implementing a new backend
 ==========================

docs/tutorial/files/3_way_split.PNG

@@ -911,13 +911,13 @@ def slice(self, plane):
 
         """
 
-    def split(self, other):
+    def split(self, cutter):
         """Slice through the BRep with a plane.
 
         Parameters
         ----------
-        other : :class:`~compas.geomtery.Brep`
-            Another Brep.
+        cutter : :class:`~compas.geomtery.Brep`
+            Another Brep to use as a cutter.
 
         Returns
         -------

src/compas/geometry/brep/brep.py

@@ -312,6 +312,23 @@ def from_boolean_intersection(cls, breps_a, breps_b):
         )
         return [RhinoBrep.from_brep(brep) for brep in resulting_breps]
 
+    def split(self, cutter):
+        """Splits a Brep into pieces using a Brep as a cutter.
+
+        Parameters
+        ----------
+        cutter : :class:`~compas_rhino.geometry.RhinoBrep`
+            Another Brep to use as a cutter.
+
+        Returns
+        -------
+        list(:class:`~compas_rhino.geometry.RhinoBrep`)
+            list of zero or more resulting Breps.
+
+        """
+        resulting_breps = self._brep.Split(cutter.native_brep, TOLERANCE)
+        return [RhinoBrep.from_brep(brep) for brep in resulting_breps]
+
     # ==============================================================================
     # Other Methods
     # ==============================================================================