Surface from rhino

CHANGELOG.md

@@ -29,6 +29,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 * Added `VolMesh.vertex_edges`.
 * Added `VolMesh.from_meshes`.
 * Added `VolMesh.from_polyhedrons`.
+* Added pluggable `Surface.from_native`.
+* Added deprecation warning on `RhinoSurface.from_rhino`.
+* Added `Surface.native_surface`.
+* Added `RhinoSurface.native_surface`.
+* Added plugin `RhinoSurface.from_native`.
+* Added parameters `frame`, `domain_u` and `domain_v` to `RhinoNurbs.from_parameters`.
+* Added `nurbssurface_to_compas` to `compas_rhino.conversions`.
+* Added `is_closed_u` and `is_closed_v` to `compas.geometry.Surface`.
 
 ### Changed
 
@@ -54,11 +62,16 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 * Updated `compas.geometry.vector.__truediv__` to allow element-wise division with another vector.
 * Fixed bug in registration `shapely` boolean plugins.
 * Temporarily restrict `numpy` to versions lower than `2.x`.
+* Protected call to `compas.geometry.Surface()`. `Surface` should be instantiated using one of the alternative constructors.
+* Protected call to `compas.geometry.NurbsSurface()`. `NurbsSurface` should be instantiated using one of the alternative constructors.
 
 ### Removed
 
 * Removed `System` dependency in `compas_ghpython/utilities/drawing.py`.
 * Removed GH plugin for `compas.scene.clear` since it clashed with the Rhino version.
+* Removed pluggable `new_nurbssurface`.
+* Removed pluggable `new_surface`.
+* Removed `compas.geometry.Surface.is_closed`.
 
 ## [2.1.1] 2024-05-14
 

src/compas/geometry/surfaces/nurbs.py

@@ -2,6 +2,7 @@
 from __future__ import division
 from __future__ import print_function
 
+from compas.geometry import Frame
 from compas.geometry import Point
 from compas.itertools import linspace
 from compas.itertools import meshgrid
@@ -12,17 +13,17 @@
 
 
 @pluggable(category="factories")
-def new_nurbssurface(cls, *args, **kwargs):
+def new_nurbssurface_from_native(cls, *args, **kwargs):
     raise PluginNotInstalledError
 
 
 @pluggable(category="factories")
-def new_nurbssurface_from_native(cls, *args, **kwargs):
+def new_nurbssurface_from_parameters(cls, *args, **kwargs):
     raise PluginNotInstalledError
 
 
 @pluggable(category="factories")
-def new_nurbssurface_from_parameters(cls, *args, **kwargs):
+def new_nurbssurface_from_plane(cls, *args, **kwargs):
     raise PluginNotInstalledError
 
 
@@ -94,36 +95,66 @@
 
     @property
     def __data__(self):
-        return {
-            "points": [point.__data__ for point in self.points],
-            "weights": self.weights,
-            "knots_u": self.knots_u,
-            "knots_v": self.knots_v,
-            "mults_u": self.mults_u,
-            "mults_v": self.mults_v,
-            "degree_u": self.degree_u,
-            "degree_v": self.degree_v,
-            "is_periodic_u": self.is_periodic_u,
-            "is_periodic_v": self.is_periodic_v,
-        }
+        data = super(NurbsSurface, self).__data__
+        data["points"] = [[point.__data__ for point in row] for row in self.points]  # type: ignore
+        data["weights"] = self.weights
+        data["knots_u"] = self.knots_u
+        data["knots_v"] = self.knots_v
+        data["mults_u"] = self.mults_u
+        data["mults_v"] = self.mults_v
+        data["degree_u"] = self.degree_u
+        data["degree_v"] = self.degree_v
+        data["is_periodic_u"] = self.is_periodic_u
+        data["is_periodic_v"] = self.is_periodic_v
+        return data
 
     @classmethod
     def __from_data__(cls, data):
+        """Construct a BSpline surface from its data representation.
+
+        Parameters
+        ----------
+        data : dict
+            The data dictionary.
+
+        Returns
+        -------
+        :class:`compas_rhino.geometry.RhinoNurbsSurface`
+            The constructed surface.
+
+        """
+        frame = Frame.__from_data__(data["frame"])
+        domain_u = data["domain_u"]
+        domain_v = data["domain_v"]
+        points = [[Point.__from_data__(point) for point in row] for row in data["points"]]
+        weights = data["weights"]
+        knots_u = data["knots_u"]
+        knots_v = data["knots_v"]
+        mults_u = data["mults_u"]
+        mults_v = data["mults_v"]
+        degree_u = data["degree_u"]
+        degree_v = data["degree_v"]
+        is_periodic_u = data["is_periodic_u"]
+        is_periodic_v = data["is_periodic_v"]
+
         return cls.from_parameters(
-            data["points"],
-            data["weights"],
-            data["knots_u"],
-            data["knots_v"],
-            data["mults_u"],
-            data["mults_v"],
-            data["degree_u"],
-            data["degree_v"],
-            data["is_periodic_u"],
-            data["is_periodic_v"],
+            frame,
+            domain_u,
+            domain_v,
+            points,
+            weights,
+            knots_u,
+            knots_v,
+            mults_u,
+            mults_v,
+            degree_u,
+            degree_v,
+            is_periodic_u,
+            is_periodic_v,
         )
 
     def __new__(cls, *args, **kwargs):
-        return new_nurbssurface(cls, *args, **kwargs)
+        raise AssertionError("NurbsSurface() is protected. Use NurbsSurface.from_...() to construct a NurbsSurface object.")
 
     def __init__(self, name=None):
         super(NurbsSurface, self).__init__(name=name)
@@ -211,6 +242,9 @@
     @classmethod
     def from_parameters(
         cls,
+        frame,
+        domain_u,
+        domain_v,
         points,
         weights,
         knots_u,
@@ -250,6 +284,9 @@
         """
         return new_nurbssurface_from_parameters(
             cls,
+            frame,
+            domain_u,
+            domain_v,
             points,
             weights,
             knots_u,
@@ -350,6 +387,10 @@
         """
         return new_nurbssurface_from_fill(cls, curve1, curve2, curve3, curve4, style)
 
+    @classmethod
+    def from_plane(cls, plane, u_degree=1, v_degree=1):
+        return new_nurbssurface_from_plane(cls, plane, u_degree, v_degree)
+
     # ==============================================================================
     # Conversions
     # ==============================================================================

src/compas/geometry/surfaces/surface.py

@@ -13,10 +13,8 @@
 
 
 @pluggable(category="factories")
-def new_surface(cls, *args, **kwargs):
-    surface = object.__new__(cls)
-    surface.__init__(*args, **kwargs)
-    return surface
+def new_surface_from_native(cls, *args, **kwargs):
+    raise NotImplementedError
 
 
 @pluggable(category="factories")
@@ -43,15 +41,41 @@
         The parameter domain of the surface in the U direction.
     domain_v : tuple[float, float], read-only
         The parameter domain of the surface in the V direction.
+    is_closed_u : bool, read-only
+        Flag indicating if the surface is closed in the U direction.
+    is_closed_v : bool, read-only
+        Flag indicating if the surface is closed in the V direction.
     is_periodic_u : bool, read-only
         Flag indicating if the surface is periodic in the U direction.
     is_periodic_v : bool, read-only
         Flag indicating if the surface is periodic in the V direction.
+    native_surface : Any, read-only
+        The CAD native surface object.
 
     """
 
+    @property
+    def __data__(self):
+        return {
+            "frame": self._frame.__data__,
+            "domain_u": list(self.domain_u),
+            "domain_v": list(self.domain_v),
+        }
+
+    @classmethod
+    def __from_data__(cls, data):
+        frame = Frame.__from_data__(data["frame"])
+        domain_u = tuple(data["domain_u"])
+        domain_v = tuple(data["domain_v"])
+        return cls.from_plane(frame, domain_u, domain_v)
+
+    @property
+    def __dtype__(self):
+        # make serialization CAD agnostic
+        return "compas.geometry/Surface"
+
     def __new__(cls, *args, **kwargs):
-        return new_surface(cls, *args, **kwargs)
+        raise AssertionError("Surface() is protected. Use Surface.from_...() to construct a Surface object.")
 
     def __init__(self, frame=None, name=None):
         super(Surface, self).__init__(name=name)
@@ -95,6 +119,10 @@
             self._transformation = Transformation.from_frame(self.frame)
         return self._transformation
 
+    @property
+    def native_surface(self):
+        raise NotImplementedError
+
     @property
     def point(self):
         if not self._point:
@@ -134,7 +162,11 @@
         return self._domain_v
 
     @property
-    def is_closed(self):
+    def is_closed_u(self):
+        raise NotImplementedError
+
+    @property
+    def is_closed_v(self):
         raise NotImplementedError
 
     @property
@@ -197,6 +229,22 @@
         """
         return new_surface_from_plane(cls, plane, *args, **kwargs)
 
+    @classmethod
+    def from_native(cls, surface):
+        """Construct a surface from a CAD native surface object.
+
+        Parameters
+        ----------
+        surface : Any
+            A native surface object.
+
+        Returns
+        -------
+        :class:`compas.geometry.Surface`
+
+        """
+        return new_surface_from_native(cls, surface)
+
     # ==============================================================================
     # Conversions
     # ==============================================================================

src/compas_rhino/conversions/__init__.py

@@ -43,6 +43,7 @@
 )
 from .surfaces import (
     surface_to_rhino,
+    nurbssurface_to_compas,
     data_to_rhino_surface,
     surface_to_compas_data,
     surface_to_compas,
@@ -127,6 +128,7 @@
     "curve_to_compas",
     # surfaces
     "surface_to_rhino",
+    "nurbssurface_to_compas",
     "surface_to_compas_data",
     "data_to_rhino_surface",
     "surface_to_compas",

src/compas_rhino/conversions/surfaces.py

@@ -7,6 +7,7 @@
 from compas.datastructures import Mesh
 from compas.geometry import NurbsSurface
 from compas.geometry import Point
+from compas.geometry import Surface
 from compas.tolerance import TOL
 from compas.utilities import memoize
 
@@ -32,12 +33,14 @@ def surface_to_rhino(surface):
     Rhino.Geometry.Surface
 
     """
-    return surface.rhino_surface
+    return surface.native_surface
 
 
 def data_to_rhino_surface(data):
     """Convert a COMPAS surface to a Rhino surface.
 
+    TODO: still needed? this is basically RhinoSurface.from_parameters()
+
     Parameters
     ----------
     data: dict
@@ -85,6 +88,8 @@ def data_to_rhino_surface(data):
 def surface_to_compas_data(surface):
     """Convert a Rhino surface to a COMPAS surface.
 
+    TODO: still needed? this is basically RhinoSurface.__data__
+
     Parameters
     ----------
     surface: :rhino:`Rhino.Geometry.Surface`
@@ -147,24 +152,37 @@ def surface_to_compas(surface):
     Parameters
     ----------
     surface: :rhino:`Rhino.Geometry.Surface`
+        A Rhino surface object.
 
     Returns
     -------
-    :class:`compas.geometry.Surface`
+    :class:`compas_rhino.geometry.RhinoSurface`
 
     """
-    if isinstance(surface, Rhino.DocObjects.RhinoObject):
-        surface = surface.Geometry
+    if not isinstance(surface, Rhino.Geometry.Surface):
+        raise ConversionError("Expected a Rhino Surface object but got: {}".format(type(surface)))
+
+    return Surface.from_native(surface)
 
-    if not isinstance(surface, Rhino.Geometry.Brep):
-        brep = Rhino.Geometry.Brep.TryConvertBrep(surface)
-    else:
-        brep = surface
 
-    if brep.Surfaces.Count > 1:  # type: ignore
-        raise ConversionError("Conversion of a Brep with multiple underlying surface is currently not supported.")
+def nurbssurface_to_compas(nurbssurface):
+    """Convert a Rhino NurbsSurface to a COMPAS NurbsSurface.
+
+    Parameters
+    ----------
+    nurbssurface : :class:`Rhino.Geometry.NurbsSurface`
+        A Rhino NurbsSurface object.
+
+    Returns
+    -------
+    :class:`compas_rhino.geometry.RhinoNurbsSurface`
+        A COMPAS NurbsSurface object.
+
+    """
+    if not isinstance(nurbssurface, Rhino.Geometry.NurbsSurface):
+        raise ConversionError("Expected a Rhino NurbsSurface object but got: {}".format(type(nurbssurface)))
 
-    return NurbsSurface.from_native(brep.Surfaces[0])
+    return NurbsSurface.from_native(nurbssurface)
 
 
 def surface_to_compas_mesh(surface, facefilter=None, cleanup=False, cls=None):

src/compas_rhino/geometry/__init__.py

@@ -5,6 +5,7 @@
 from __future__ import absolute_import
 
 from .curves.nurbs import RhinoNurbsCurve
+from .surfaces import RhinoSurface
 from .surfaces.nurbs import RhinoNurbsSurface
 
 from .brep.brep import RhinoBrep
@@ -34,6 +35,7 @@
     "trimesh_principal_curvature",
     "trimesh_slice",
     "RhinoNurbsCurve",
+    "RhinoSurface",
     "RhinoNurbsSurface",
     "RhinoBrep",
     "RhinoBrepVertex",