Merge pull request #903 from compas-dev/shape-api

Improved API for shape booleans

Author: tomvanmele

CHANGELOG.md

@@ -10,13 +10,19 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 
 * Added `draw_vertexlabels`, `draw_edgelabels`, `draw_facelabels`, `draw_vertexnormals`, and `draw_facenormals` to `compas_blender.artists.MeshArtist`.
+* Added optional `triangulated` flag to `to_vertices_and_faces` of all shapes.
+* Added `compas.geometry.Geometry` base class.
+* Added `__add__`, `__sub__`, `__and__` to `compas.geometry.Shape` for boolean operations using binary operators.
+* Added `is_closed` to `compas.geometry.Polyhedron`.
 * Added `Plane.offset`.
 * Added `draw_node_labels` and `draw_edgelabels` to `compas_blender.artists.NetworkArtist`.
 * Added `compas_blender.artists.RobotModelArtist.clear`.
 
 ### Changed
 
 * Fixed bug in `compas_blender.draw_texts`.
+* Changed default resolution for shape discretisation to 16 for both u and v where relevant.
+* Changed base class of `compas.geometry.Primitive` and `compas.geometry.Shape` to `compas.geometry.Geometry`.
 * `compas_blender.artists.RobotModelArtist.collection` can be assigned as a Blender collection or a name.
 * Generalized the parameter `color` of `compas_blender.draw_texts` and various label drawing methods.
 

src/compas/geometry/__init__.py

@@ -5,6 +5,15 @@
 
 .. currentmodule:: compas.geometry
 
+Base Class
+==========
+
+.. autosummary::
+    :toctree: generated/
+    :nosignatures:
+
+    Geometry
+
 Classes
 =======
 
@@ -828,6 +837,9 @@
         world_to_local_coordinates_numpy,
         local_to_world_coordinates_numpy
     )
+
+from .geometry import Geometry
+
 from .primitives import (  # noqa: E402
     Primitive,
     Bezier,
@@ -1201,9 +1213,8 @@
     'trimesh_remesh_along_isoline',
     'trimesh_slice',
 
-    'KDTree',
+    'Geometry',
 
-    'Pointcloud',
     'Primitive',
     'Bezier',
     'Circle',
@@ -1226,6 +1237,9 @@
     'Sphere',
     'Torus',
 
+    'Pointcloud',
+    'KDTree',
+
     'Projection',
     'Reflection',
     'Rotation',

src/compas/geometry/geometry.py

@@ -0,0 +1,45 @@
+from __future__ import absolute_import
+from __future__ import division
+from __future__ import print_function
+
+from compas.data import Data
+
+
+class Geometry(Data):
+    """Base class for all geometric objects."""
+
+    def __ne__(self, other):
+        # this is not obvious to ironpython
+        return not self.__eq__(other)
+
+    def transform(self, transformation):
+        """Transform the geometry.
+
+        Parameters
+        ----------
+        transformation : :class:`Transformation`
+            The transformation used to transform the geometry.
+
+        Returns
+        -------
+        None
+
+        """
+        raise NotImplementedError
+
+    def transformed(self, transformation):
+        """Returns a transformed copy of this geometry.
+
+        Parameters
+        ----------
+        transformation : :class:`Transformation`
+            The transformation used to transform the geometry.
+
+        Returns
+        -------
+        :class:`Geometry`
+            The transformed geometry.
+        """
+        primitive = self.copy()
+        primitive.transform(transformation)
+        return primitive

src/compas/geometry/primitives/_primitive.py

@@ -2,44 +2,8 @@
 from __future__ import division
 from __future__ import print_function
 
-from compas.data import Data
+from ..geometry import Geometry
 
 
-class Primitive(Data):
+class Primitive(Geometry):
     """Base class for geometric primitives."""
-
-    def __ne__(self, other):
-        # this is not obvious to ironpython
-        return not self.__eq__(other)
-
-    def transform(self, transformation):
-        """Transform the primitive.
-
-        Parameters
-        ----------
-        transformation : :class:`Transformation`
-            The transformation used to transform the Box.
-
-        Returns
-        -------
-        None
-
-        """
-        raise NotImplementedError
-
-    def transformed(self, transformation):
-        """Returns a transformed copy of this primitive.
-
-        Parameters
-        ----------
-        transformation : :class:`Transformation`
-            The transformation used to transform the primitive.
-
-        Returns
-        -------
-        :class:`Primitive`
-            The transformed primitive.
-        """
-        primitive = self.copy()
-        primitive.transform(transformation)
-        return primitive

src/compas/geometry/shapes/__init__.py

@@ -11,6 +11,3 @@
 from .polyhedron import Polyhedron  # noqa: F401
 from .sphere import Sphere  # noqa: F401
 from .torus import Torus  # noqa: F401
-
-
-__all__ = [name for name in dir() if not name.startswith('_')]

src/compas/geometry/shapes/_shape.py

@@ -3,12 +3,115 @@
 from __future__ import division
 
 import abc
-from compas.geometry import Primitive
+from ..geometry import Geometry
 
 
-class Shape(Primitive):
+class Shape(Geometry):
     """Base class for geometric shapes."""
 
     @abc.abstractmethod
     def to_vertices_and_faces(self):
         pass
+
+    def __add__(self, other):
+        """Compute the boolean union using the "+" operator of this shape and another.
+
+        Parameters
+        ----------
+        other : :class:`Solid`
+            The solid to add.
+
+        Returns
+        -------
+        :class:`Solid`
+            The resulting solid.
+
+        Examples
+        --------
+        >>> from compas.geometry import Box, Sphere
+        >>> A = Box.from_width_height_depth(2, 2, 2)
+        >>> B = Sphere([1, 1, 1], 1.0)
+        >>> C = A + B
+        """
+        from compas.geometry import boolean_union_mesh_mesh
+        from compas.geometry import Polyhedron
+        A = self.to_vertices_and_faces(triangulated=True)
+        B = other.to_vertices_and_faces(triangulated=True)
+        V, F = boolean_union_mesh_mesh(A, B)
+        return Polyhedron(V, F)
+
+    def __sub__(self, other):
+        """Compute the boolean difference using the "-" operator of this shape and another.
+
+        Parameters
+        ----------
+        other : :class:`Solid`
+            The solid to subtract.
+
+        Returns
+        -------
+        :class:`Solid`
+            The resulting solid.
+
+        Examples
+        --------
+        >>> from compas.geometry import Box, Sphere
+        >>> A = Box.from_width_height_depth(2, 2, 2)
+        >>> B = Sphere([1, 1, 1], 1.0)
+        >>> C = A - B
+        """
+        from compas.geometry import boolean_difference_mesh_mesh
+        from compas.geometry import Polyhedron
+        A = self.to_vertices_and_faces(triangulated=True)
+        B = other.to_vertices_and_faces(triangulated=True)
+        V, F = boolean_difference_mesh_mesh(A, B)
+        return Polyhedron(V, F)
+
+    def __and__(self, other):
+        """Compute the boolean intersection using the "&" operator of this shape and another.
+
+        Parameters
+        ----------
+        other : :class:`Solid`
+            The solid to intersect with.
+
+        Returns
+        -------
+        :class:`Solid`
+            The resulting solid.
+
+        Examples
+        --------
+        >>> from compas.geometry import Box, Sphere
+        >>> A = Box.from_width_height_depth(2, 2, 2)
+        >>> B = Sphere([1, 1, 1], 1.0)
+        >>> C = A & B
+        """
+        from compas.geometry import boolean_intersection_mesh_mesh
+        from compas.geometry import Polyhedron
+        A = self.to_vertices_and_faces(triangulated=True)
+        B = other.to_vertices_and_faces(triangulated=True)
+        V, F = boolean_intersection_mesh_mesh(A, B)
+        return Polyhedron(V, F)
+
+    def __or__(self, other):
+        """Compute the boolean union using the "|" operator of this shape and another.
+
+        Parameters
+        ----------
+        other : :class:`Solid`
+            The solid to add.
+
+        Returns
+        -------
+        :class:`Solid`
+            The resulting solid.
+
+        Examples
+        --------
+        >>> from compas.geometry import Box, Sphere
+        >>> A = Box.from_width_height_depth(2, 2, 2)
+        >>> B = Sphere([1, 1, 1], 1.0)
+        >>> C = A | B
+        """
+        return self.__add__(other)

src/compas/geometry/shapes/box.py

@@ -8,7 +8,7 @@
 from compas.geometry import Frame
 from compas.geometry import Vector
 
-from compas.geometry.shapes._shape import Shape
+from ._shape import Shape
 
 
 class Box(Shape):
@@ -519,6 +519,29 @@ def from_diagonal(cls, diagonal):
     # methods
     # ==========================================================================
 
+    def to_vertices_and_faces(self, triangulated=False):
+        """Returns a list of vertices and faces.
+
+        Parameters
+        ----------
+        triangulated: bool, optional
+            Flag indicating that the faces have to be triangulated.
+
+        Returns
+        -------
+        (vertices, faces)
+            A list of vertex locations and a list of faces,
+            with each face defined as a list of indices into the list of vertices.
+        """
+        if triangulated:
+            faces = []
+            for a, b, c, d in self.faces:
+                faces.append([a, b, c])
+                faces.append([a, c, d])
+        else:
+            faces = self.faces
+        return self.vertices, faces
+
     def contains(self, point):
         """Verify if the box contains a given point.
 
@@ -538,17 +561,6 @@ def contains(self, point):
                     return True
         return False
 
-    def to_vertices_and_faces(self):
-        """Returns a list of vertices and faces.
-
-        Returns
-        -------
-        (vertices, faces)
-            A list of vertex locations and a list of faces,
-            with each face defined as a list of indices into the list of vertices.
-        """
-        return self.vertices, self.faces
-
     def transform(self, transformation):
         """Transform the box.
 

src/compas/geometry/shapes/capsule.py

@@ -12,7 +12,7 @@
 from compas.geometry import Plane
 from compas.geometry import Line
 
-from compas.geometry.shapes import Shape
+from ._shape import Shape
 
 
 class Capsule(Shape):
@@ -186,17 +186,17 @@ def from_data(cls, data):
     # methods
     # ==========================================================================
 
-    def to_vertices_and_faces(self, u=10, v=10):
+    def to_vertices_and_faces(self, u=16, v=16, triangulated=False):
         """Returns a list of vertices and faces.
 
         Parameters
         ----------
         u : int, optional
             Number of faces in the 'u' direction.
-            Default is ``10``.
         v : int, optional
             Number of faces in the 'v' direction.
-            Default is ``10``.
+        triangulated: bool, optional
+            Flag indicating that the faces have to be triangulated.
 
         Returns
         -------
@@ -263,6 +263,16 @@ def to_vertices_and_faces(self, u=10, v=10):
             nn = len(vertices) - 3 - (j + 1) % u
             faces.append([np, nn, nc])
 
+        if triangulated:
+            triangles = []
+            for face in faces:
+                if len(face) == 4:
+                    triangles.append(face[0:3])
+                    triangles.append([face[0], face[2], face[3]])
+                else:
+                    triangles.append(face)
+            faces = triangles
+
         return vertices, faces
 
     def transform(self, transformation):