Merge pull request #35 from compas-dev/feature/offset_with_holes

Added function `create_offset_polygons_with_holes_2`

Author: romanarust

CHANGELOG.md

@@ -11,8 +11,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 * Added recipe hasher.
 * Added `scip` to dev install instructions in README.md
+* Added `compas_cgal.straight_skeleton_2.offset_polygon_with_holes`.
 
 ### Changed
+* Changed name of `compas_cgal.straight_skeleton_2.create_interior_straight_skeleton` to `interior_straight_skeleton`
+* Changed name of `compas_cgal.straight_skeleton_2.create_interior_straight_skeleton_with_holes` to `interior_straight_skeleton_with_holes`
+* Changed name of `compas_cgal.straight_skeleton_2.create_offset_polygons_2` to `offset_polygon`
+* Changed name of `compas_cgal.straight_skeleton_2.create_weighted_offset_polygons_2` to `weighted_offset_polygon`
 
 ### Removed
 

docs/api/compas_cgal.straight_skeleton_2.rst

@@ -8,5 +8,8 @@ compas_cgal.straight_skeleton_2
     :toctree: generated/
     :nosignatures:
 
-    create_interior_straight_skeleton
-    create_interior_straight_skeleton_with_holes
+    interior_straight_skeleton
+    interior_straight_skeleton_with_holes
+    offset_polygon
+    weighted_offset_polygon
+    offset_polygon_with_holes

docs/examples/polygonal_poinset_reconstruction.rst

@@ -7,5 +7,5 @@ Polygonal PointSet Reconstruction
     :class: figure-img img-fluid
 
 
-.. literalinclude:: polygonal_poinset_reconstruction_ransac.py
+.. literalinclude:: polygonal_poinset_reconstruction.py
     :language: python

docs/examples/straight_skeleton_2.py

@@ -1,4 +1,4 @@
-from compas_cgal.straight_skeleton_2 import create_interior_straight_skeleton
+from compas_cgal.straight_skeleton_2 import interior_straight_skeleton
 from compas_viewer import Viewer
 
 points = [
@@ -15,7 +15,7 @@
 ]
 
 
-graph = create_interior_straight_skeleton(points)
+graph = interior_straight_skeleton(points)
 
 # ==============================================================================
 # Viz

docs/examples/straight_skeleton_2_holes.py

@@ -1,7 +1,8 @@
 from compas.geometry import Polygon
-from compas_cgal.straight_skeleton_2 import create_interior_straight_skeleton_with_holes
 from compas_viewer import Viewer
 
+from compas_cgal.straight_skeleton_2 import interior_straight_skeleton_with_holes
+
 points = [
     (-1.91, 3.59, 0.0),
     (-5.53, -5.22, 0.0),
@@ -24,7 +25,7 @@
 
 polygon = Polygon(points)
 holes = [Polygon(hole) for hole in holes]
-graph = create_interior_straight_skeleton_with_holes(polygon, holes)
+graph = interior_straight_skeleton_with_holes(polygon, holes)
 
 # ==============================================================================
 # Viz

docs/examples/straight_skeleton_2_offset.py

@@ -1,7 +1,8 @@
 from compas.geometry import Polygon
-from compas_cgal.straight_skeleton_2 import create_offset_polygons_2
 from compas_viewer import Viewer
 
+from compas_cgal.straight_skeleton_2 import offset_polygon
+
 points = [
     (-1.91, 3.59, 0.0),
     (-5.53, -5.22, 0.0),
@@ -17,8 +18,8 @@
 polygon = Polygon(points)
 offset = 1.5
 
-offset_polygons_inner = create_offset_polygons_2(points, offset)
-offset_polygons_outer = create_offset_polygons_2(points, -offset)
+offset_polygon_inner = offset_polygon(points, offset)
+offset_polygon_outer = offset_polygon(points, -offset)
 
 # ==============================================================================
 # Viz
@@ -28,9 +29,9 @@
 viewer.scene.add(polygon)
 viewer.config.renderer.show_grid = False
 
-for opolygon in offset_polygons_inner:
+for opolygon in offset_polygon_inner:
     viewer.scene.add(opolygon, linecolor=(1.0, 0.0, 0.0), facecolor=(1.0, 1.0, 1.0, 0.0))
-for opolygon in offset_polygons_outer:
+for opolygon in offset_polygon_outer:
     viewer.scene.add(opolygon, linecolor=(0.0, 0.0, 1.0), facecolor=(1.0, 1.0, 1.0, 0.0))
 
 viewer.show()

docs/examples/straight_skeleton_2_offset_weighted.py

@@ -1,7 +1,8 @@
 from compas.geometry import Polygon
-from compas_cgal.straight_skeleton_2 import create_weighted_offset_polygons_2
 from compas_viewer import Viewer
 
+from compas_cgal.straight_skeleton_2 import weighted_offset_polygons
+
 points = [
     (-1.91, 3.59, 0.0),
     (-5.53, -5.22, 0.0),
@@ -20,7 +21,7 @@
 distances = [0.1, 0.3, 0.6, 0.1, 0.7, 0.5, 0.2, 0.4, 0.8, 0.2]
 weights = [1.0 / d for d in distances]
 offset = 1.0
-offset_polygons_outer = create_weighted_offset_polygons_2(points, -offset, weights)
+offset_polygons_outer = weighted_offset_polygons(points, -offset, weights)
 
 # ==============================================================================
 # Viz

src/compas_cgal/straight_skeleton_2.py

@@ -48,8 +48,8 @@ def graph_from_skeleton_data(points: VerticesNumpy, indices: IntNx1, edges: IntN
     return graph
 
 
-def create_interior_straight_skeleton(points, as_graph=True) -> Union[Graph, Tuple[VerticesNumpy, IntNx1, IntNx2, IntNx1]]:
-    """Compute the skeleton of a polygon.
+def interior_straight_skeleton(points, as_graph=True) -> Union[Graph, Tuple[VerticesNumpy, IntNx1, IntNx2, IntNx1]]:
+    """Compute the skeleton of a 2D polygon.
 
     Parameters
     ----------
@@ -66,7 +66,7 @@ def create_interior_straight_skeleton(points, as_graph=True) -> Union[Graph, Tup
     Raises
     ------
     ValueError
-        If the normal of the polygon is not [0, 0, 1].
+        If the normal of the polygon is not directed vertically upwards like [0, 0, 1].
     """
     points = list(points)
     normal = normal_polygon(points, True)
@@ -79,13 +79,13 @@ def create_interior_straight_skeleton(points, as_graph=True) -> Union[Graph, Tup
     return points, indices, edges, edge_types
 
 
-def create_interior_straight_skeleton_with_holes(points, holes, as_graph=True) -> Union[Graph, Tuple[VerticesNumpy, IntNx1, IntNx2, IntNx1]]:
-    """Compute the skeleton of a polygon with holes.
+def interior_straight_skeleton_with_holes(points, holes, as_graph=True) -> Union[Graph, Tuple[VerticesNumpy, IntNx1, IntNx2, IntNx1]]:
+    """Compute the skeleton of a 2D polygon with holes.
 
     Parameters
     ----------
     points : list of point coordinates or :class:`compas.geometry.Polygon`
-        The points of the polygon.
+        The points of the 2D polygon.
     holes : list of list of point coordinates or list of :class:`compas.geometry.Polygon`
         The holes of the polygon.
     as_graph : bool, optional
@@ -99,8 +99,8 @@ def create_interior_straight_skeleton_with_holes(points, holes, as_graph=True) -
     Raises
     ------
     ValueError
-        If the normal of the polygon is not [0, 0, 1].
-        If the normal of a hole is not [0, 0, -1].
+        If the normal of the polygon is not directed vertically upwards like [0, 0, 1].
+        If the normal of a hole is not directed vertically downwards like [0, 0, -1].
     """
     points = list(points)
     normal = normal_polygon(points, True)
@@ -122,13 +122,13 @@ def create_interior_straight_skeleton_with_holes(points, holes, as_graph=True) -
     return points, indices, edges, edge_types
 
 
-def create_offset_polygons_2(points, offset) -> list[Polygon]:
-    """Compute the polygon offset.
+def offset_polygon(points, offset) -> list[Polygon]:
+    """Compute the offset from a 2D polygon.
 
     Parameters
     ----------
     points : list of point coordinates or :class:`compas.geometry.Polygon`
-        The points of the polygon.
+        The points of the 2D polygon.
     offset : float
         The offset distance. If negative, the offset is outside the polygon, otherwise inside.
 
@@ -140,7 +140,7 @@ def create_offset_polygons_2(points, offset) -> list[Polygon]:
     Raises
     ------
     ValueError
-        If the normal of the polygon is not [0, 0, 1].
+        If the normal of the polygon is not directed vertically upwards like [0, 0, 1].
     """
     points = list(points)
     normal = normal_polygon(points, True)
@@ -155,13 +155,66 @@ def create_offset_polygons_2(points, offset) -> list[Polygon]:
     return [Polygon(points.tolist()) for points in offset_polygons]
 
 
-def create_weighted_offset_polygons_2(points, offset, weights) -> list[Polygon]:
-    """Compute the polygon offset with weights.
+def offset_polygon_with_holes(points, holes, offset) -> list[Tuple[Polygon, list[Polygon]]]:
+    """Compute the offset from a 2D polygon with holes.
 
     Parameters
     ----------
     points : list of point coordinates or :class:`compas.geometry.Polygon`
-        The points of the polygon.
+        The points of the 2D polygon.
+    holes : list of list of point coordinates or list of :class:`compas.geometry.Polygon`
+        The holes of the polygon.
+    offset : float
+        The offset distance. If negative, the offset is outside the polygon, otherwise inside.
+
+    Returns
+    -------
+    list of tuple of (:class:`Polygon`, list[:class:`Polygon`])
+        The polygons with holes.
+
+    Raises
+    ------
+    ValueError
+        If the normal of the polygon is not directed vertically upwards like [0, 0, 1].
+        If the normal of a hole is not directed vertically downwards like [0, 0, -1].
+    """
+    points = list(points)
+    normal = normal_polygon(points, True)
+    if not TOL.is_allclose(normal, [0, 0, 1]):
+        raise ValueError("The normal of the polygon should be [0, 0, 1]. The normal of the provided polygon is {}".format(normal))
+    V = np.asarray(points, dtype=np.float64)
+
+    H = []
+    for i, hole in enumerate(holes):
+        points = hole
+        normal_hole = normal_polygon(points, True)
+        if not TOL.is_allclose(normal_hole, [0, 0, -1]):
+            raise ValueError("The normal of the hole should be [0, 0, -1]. The normal of the provided {}-th hole is {}".format(i, normal_hole))
+        hole = np.asarray(points, dtype=np.float64)
+        H.append(hole)
+
+    if offset < 0:  # outside
+        offset_polygons = straight_skeleton_2.create_offset_polygons_2_outer_with_holes(V, H, abs(offset))
+    else:  # inside
+        offset_polygons = straight_skeleton_2.create_offset_polygons_2_inner_with_holes(V, H, offset)
+
+    result = []
+    for points, holes_np in offset_polygons:
+        polygon = Polygon(points.tolist())
+        holes = []
+        for hole in holes_np:
+            holes.append(Polygon(hole.tolist()))
+        result.append((polygon, holes))
+    return result
+
+
+def weighted_offset_polygon(points, offset, weights) -> list[Polygon]:
+    """Compute the offset from a 2D polygon with weights.
+
+    Parameters
+    ----------
+    points : list of point coordinates or :class:`compas.geometry.Polygon`
+        The points of the 2D polygon.
     offset : float
         The offset distance. If negative, the offset is outside the polygon, otherwise inside.
     weights : list of float
@@ -175,7 +228,7 @@ def create_weighted_offset_polygons_2(points, offset, weights) -> list[Polygon]:
     Raises
     ------
     ValueError
-        If the normal of the polygon is not [0, 0, 1].
+        If the normal of the polygon is not directed vertically upwards like [0, 0, 1].
     ValueError
         If the number of weights does not match the number of points.
     """