Explicit methods for geometry and separate methods for doc objects

Author: tomvanmele

CHANGELOG.md

@@ -32,6 +32,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 * Added `compas.geometry.curves.curve.Curve.from_native`.
 * Added `compas_rhino.geometry.curves.curve.Curve.from_native`.
 * Added `compas_rhino.geometry.curves.nurbs.NurbsCurve.from_native`.
+* Added `compas_rhino.conversions.breps.brep_to_compas_mesh`.
+* Added `compas_rhino.conversions.docobjects.brepobject_to_compas`.
+* Added `compas_rhino.conversions.docobjects.curveobject_to_compas`.
+* Added `compas_rhino.conversions.docobjects.meshobject_to_compas`.
+* Added `compas_rhino.conversions.docobjects.pointobject_to_compas`.
+* Added `compas_rhino.conversions.docobjects.surfaceobject_to_compas`.
 
 ### Changed
 
@@ -46,7 +52,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 * Changed `compas.geometry.curves.nurbs.NurbsCurve.__new__` to prevent instantiation of `NurbsCurve` directly.
 * Changed `compas_rhino.geometry.curves.new_nurbscurve_from_...` to `nurbscurve_from_...`.
 * Fixed `compas_ghpython` Grasshopper components not included in published pakcage.
-* Chnaged `compas.colors.Color.coerce` to take color as is, if it is already aninstance of `compas.colors.Color`.
+* Changed `compas.colors.Color.coerce` to take color as is, if it is already aninstance of `compas.colors.Color`.
+* Changed `compas_rhino.conversions.surfaces.surface_to_compas` to work only with surface geometry.
+* Changed `compas_rhino.conversions.curves.curve_to_compas_line` to work only with geometry.
+* Changed `compas_rhino.conversions.curves.curve_to_compas_circle` to work only with geometry.
+* Changed `compas_rhino.conversions.curves.curve_to_compas_ellipse` to work only with geometry.
+* Changed `compas_rhino.conversions.curves.curve_to_compas_polyline` to work only with geometry.
 
 ### Removed
 
@@ -75,6 +86,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 * Removed `compas.geometry.curves.curve.new_nurbscurve`.
 * Removed `compas_rhino.geometry.curves.new_curve`.
 * Removed `compas_rhino.geometry.curves.new_nurbscurve`.
+* Removed `compas_rhino.conversions.surfaces.data_to_rhino_surface`.
+* Removed `compas_rhino.conversions.surfaces.surface_to_compas_data`.
+* Removed `compas_rhino.conversions.surfaces.surface_to_compas_quadmesh`.
+* Removed `compas_rhino.conversions.curves.curve_to_compas_data`.
 
 ## [2.2.1] 2024-06-25
 

src/compas_rhino/conversions/__init__.py

@@ -43,11 +43,8 @@
 )
 from .surfaces import (
     surface_to_rhino,
-    data_to_rhino_surface,
-    surface_to_compas_data,
     surface_to_compas,
     surface_to_compas_mesh,
-    surface_to_compas_quadmesh,
 )
 from .shapes import (
     box_to_rhino,
@@ -77,6 +74,7 @@
     brep_to_compas_cone,
     brep_to_compas_cylinder,
     brep_to_compas_sphere,
+    brep_to_compas_mesh,
 )
 from .extrusions import (
     extrusion_to_compas_box,
@@ -89,6 +87,14 @@
     transformation_matrix_to_rhino,
 )
 
+from .docobjects import (
+    brepobject_to_compas,
+    curveobject_to_compas,
+    meshobject_to_compas,
+    pointobject_to_compas,
+    surfaceobject_to_compas,
+)
+
 
 __all__ = [
     "ConversionError",
@@ -127,11 +133,8 @@
     "curve_to_compas",
     # surfaces
     "surface_to_rhino",
-    "surface_to_compas_data",
-    "data_to_rhino_surface",
     "surface_to_compas",
     "surface_to_compas_mesh",
-    "surface_to_compas_quadmesh",
     # shapes
     "box_to_rhino",
     "sphere_to_rhino",
@@ -158,11 +161,18 @@
     "brep_to_compas_cone",
     "brep_to_compas_cylinder",
     "brep_to_compas_sphere",
+    "brep_to_compas_mesh",
     # extrusions
     "extrusion_to_compas_box",
     "extrusion_to_compas_cylinder",
     "extrusion_to_compas_torus",
     # transformations
     "transformation_to_rhino",
     "transformation_matrix_to_rhino",
+    # docobjects
+    "brepobject_to_compas",
+    "curveobject_to_compas",
+    "meshobject_to_compas",
+    "pointobject_to_compas",
+    "surfaceobject_to_compas",
 ]

src/compas_rhino/conversions/breps.py

@@ -4,7 +4,12 @@
 
 import scriptcontext as sc  # type: ignore
 
+from compas.datastructures import Mesh
+from compas.geometry import Brep
+from compas.tolerance import TOL
+
 from .exceptions import ConversionError
+from .geometry import point_to_compas
 from .shapes import cone_to_compas
 from .shapes import cylinder_to_compas
 from .shapes import sphere_to_compas
@@ -15,7 +20,7 @@
 
 
 def brep_to_rhino(brep):
-    """Convert a COMPAS brep to a Rhino brep.
+    """Convert a COMPAS Brep to a Rhino Brep.
 
     Parameters
     ----------
@@ -34,6 +39,26 @@ def brep_to_rhino(brep):
 # =============================================================================
 
 
+def brep_to_compas(brep):
+    """Convert a Rhino Brep to a COMPAS Brep.
+
+    Parameters
+    ----------
+    brep : :rhino:`Rhino.Geometry.Brep`
+
+    Returns
+    -------
+    :class:`compas.geometry.Brep`
+
+    """
+    return Brep.from_native(brep)
+
+
+# =============================================================================
+# To COMPAS Shapes
+# =============================================================================
+
+
 def brep_to_compas_box(brep):
     """Convert a Rhino brep to a COMPAS box.
 
@@ -120,3 +145,89 @@ def brep_to_compas_sphere(brep):
     result, sphere = face.TryGetSphere()
     if result:
         return sphere_to_compas(sphere)
+
+
+# =============================================================================
+# To COMPAS Mesh
+# =============================================================================
+
+
+def brep_to_compas_mesh(brep, facefilter=None, cleanup=False, cls=None):
+    """Convert the face loops of a Rhino brep to a COMPAS mesh.
+
+    Parameters
+    ----------
+    brep : :class:`Rhino.Geometry.Brep`
+        A Rhino brep.
+    facefilter : callable, optional
+        A filter for selection which Brep faces to include.
+        If provided, the filter should return True or False per face.
+        A very simple filter that includes all faces is ``def facefilter(face): return True``.
+        Default parameter value is None in which case all faces are included.
+    cleanup : bool, optional
+        Flag indicating to clean up the result.
+        Cleaning up means to remove isolated faces and unused vertices.
+        Default is False.
+    cls : :class:`compas.datastructures.Mesh`, optional
+        The type of COMPAS mesh.
+
+    Returns
+    -------
+    :class:`compas.datastructures.Mesh`
+        The resulting mesh.
+
+    """
+    if facefilter and callable(facefilter):
+        brepfaces = [face for face in brep.Faces if facefilter(face)]
+    else:
+        brepfaces = brep.Faces
+
+    # vertex maps and face lists
+    gkey_xyz = {}
+    faces = []
+    for face in brepfaces:
+        loop = face.OuterLoop
+        curve = loop.To3dCurve()
+        segments = list(curve.Explode())
+        a = point_to_compas(segments[0].PointAtStart)
+        b = point_to_compas(segments[0].PointAtEnd)
+        a_gkey = TOL.geometric_key(a)
+        b_gkey = TOL.geometric_key(b)
+        gkey_xyz[a_gkey] = a
+        gkey_xyz[b_gkey] = b
+        face = [a_gkey, b_gkey]
+        for segment in segments[1:-1]:
+            b = point_to_compas(segment.PointAtEnd)
+            b_gkey = TOL.geometric_key(b)
+            face.append(b_gkey)
+            gkey_xyz[b_gkey] = b
+        faces.append(face)
+
+    # vertices and faces
+    gkey_index = {gkey: index for index, gkey in enumerate(gkey_xyz)}
+    vertices = [list(xyz) for gkey, xyz in gkey_xyz.items()]
+    faces = [[gkey_index[gkey] for gkey in face] for face in faces]
+
+    # remove duplicates from vertexlist
+    polygons = []
+    for temp in faces:
+        face = []
+        for vertex in temp:
+            if vertex not in face:
+                face.append(vertex)
+        polygons.append(face)
+
+    # define mesh type
+    cls = cls or Mesh
+    # create mesh
+    mesh = cls.from_vertices_and_faces(vertices, polygons)
+
+    # remove isolated faces
+    if cleanup:
+        if mesh.number_of_faces() > 1:
+            for face in list(mesh.faces()):
+                if not mesh.face_neighbors(face):
+                    mesh.delete_face(face)
+        mesh.remove_unused_vertices()
+
+    return mesh

src/compas_rhino/conversions/curves.py

@@ -7,6 +7,7 @@
 
 from compas.geometry import Arc
 from compas.geometry import Circle
+from compas.geometry import Curve
 from compas.geometry import Ellipse
 from compas.geometry import Line
 from compas.geometry import NurbsCurve
@@ -25,33 +26,6 @@
 # =============================================================================
 
 
-def data_to_rhino_curve(data):
-    """Convert a COMPAS curve to a Rhino curve.
-
-    Parameters
-    ----------
-    data : dict
-
-    Returns
-    -------
-    :rhino:`Rhino.Geometry.NurbsCurve`
-
-    """
-    nurbs = Rhino.Geometry.NurbsCurve(data["degree"], len(data["points"]))
-
-    for index, xyz in enumerate(data["points"]):
-        nurbs.Points.SetPoint(index, *xyz)
-
-    knotvector = []
-    for knot, mult in zip(data["knots"], data["multiplicities"]):
-        for i in range(mult):
-            knotvector.append(knot)
-
-    for index, knot in enumerate(knotvector):
-        nurbs.Knots.Item[index] = knot
-    return nurbs
-
-
 def line_to_rhino(line):
     """Convert a COMPAS line to a Rhino line.
 
@@ -308,8 +282,6 @@ def curve_to_compas_line(curve):
     :class:`compas.geometry.Line`
 
     """
-    if isinstance(curve, Rhino.DocObjects.RhinoObject):
-        curve = curve.Geometry
     return Line(point_to_compas(curve.PointAtStart), point_to_compas(curve.PointAtEnd))
 
 
@@ -330,8 +302,6 @@ def curve_to_compas_circle(curve):
         If the curve cannot be converted to a circle.
 
     """
-    if isinstance(curve, Rhino.DocObjects.RhinoObject):
-        curve = curve.Geometry
     result, circle = curve.TryGetCircle()
     if not result:
         raise ConversionError("The curve cannot be converted to a circle.")
@@ -355,8 +325,6 @@ def curve_to_compas_ellipse(curve):
         If the curve cannot be converted to an ellipse.
 
     """
-    if isinstance(curve, Rhino.DocObjects.RhinoObject):
-        curve = curve.Geometry
     result, ellipse = curve.TryGetEllipse()
     if not result:
         raise ConversionError("The curve cannot be converted to an ellipse.")
@@ -380,74 +348,29 @@ def curve_to_compas_polyline(curve):
         If the curve cannot be converted to a polyline.
 
     """
-    if isinstance(curve, Rhino.DocObjects.RhinoObject):
-        curve = curve.Geometry
     result, polyline = curve.TryGetPolyline()
     if not result:
         raise ConversionError("The curve cannot be converted to a polyline.")
     return polyline_to_compas(polyline)
 
 
-def curve_to_compas_data(curve):
-    """Convert a Rhino curve to a COMPAS data dict.
+def curve_to_compas(curve, try_nurbs=True):
+    """Convert a Rhino curve to a COMPAS curve.
 
     Parameters
     ----------
     curve : :rhino:`Rhino.Geometry.Curve`
+        A Rhino curve.
+    try_nurbs : bool, optional
+        Try to convert the curve to a NURBS curve.
 
     Returns
     -------
-    dict
-
-    """
-    if isinstance(curve, Rhino.DocObjects.RhinoObject):
-        curve = curve.Geometry
-
-    nurbs = curve.ToNurbsCurve()
-    points = []
-    weights = []
-    knots = []
-    multiplicities = []
-    degree = nurbs.Degree
-    is_periodic = nurbs.IsPeriodic
-
-    for index in range(nurbs.Points.Count):
-        point = nurbs.Points.Item[index]
-        points.append(point_to_compas(point.Location))
-        weights.append(point.Weight)
-
-    for index in range(nurbs.Knots.Count):
-        knots.append(nurbs.Knots.Item[index])
-        multiplicities.append(nurbs.Knots.KnotMultiplicity(index))
-
-    return {
-        "points": [point.data for point in points],
-        "weights": weights,
-        "knots": knots,
-        "multiplicities": multiplicities,
-        "degree": degree,
-        "is_periodic": is_periodic,
-    }
-
-
-def curve_to_compas(curve):
-    """Convert a Rhino (Nurbs) curve to a COMPAS curve.
-
-    Parameters
-    ----------
-    curve : :rhino:`Rhino.Geometry.Curve`
-
-    Returns
-    -------
-    :class:`compas.geometry.NurbsCurve`
-
-    Raises
-    ------
-    ConversionError
-        If the curve cannot be converted to a COMPAS curve.
+    :class:`compas.geometry.Curve` | :class:`compas.geometry.NurbsCurve`
+        If `try_nurbs` is `True`, and the geometry has a NURBS representation, return a NURBS curve.
+        Otherwise return a general curve.
 
     """
-    if isinstance(curve, Rhino.DocObjects.RhinoObject):
-        curve = curve.Geometry
-    nurbs = curve.ToNurbsCurve()
-    return NurbsCurve.from_native(nurbs)
+    if try_nurbs and curve.HasNurbsForm():
+        return NurbsCurve.from_native(curve.ToNurbsCurve())
+    return Curve.from_native(curve)