use new curve

tomvanmele · tomvanmele · commit 882850960de4 · 2022-01-21T16:23:56.000+01:00
diff --git a/src/compas_occ/brep/brep.py b/src/compas_occ/brep/brep.py
@@ -48,7 +48,7 @@
 from compas_occ.conversions import triangle_to_face
 from compas_occ.conversions import quad_to_face
 from compas_occ.conversions import ngon_to_face
-from compas_occ.geometry import OCCNurbsSurface as NurbsSurface
+from compas_occ.geometry import NurbsSurface
 
 from compas_occ.brep import BRepVertex
 from compas_occ.brep import BRepEdge
@@ -61,21 +61,21 @@ class BRep:
 
     Attributes
     ----------
-    shape : :class:`TopoDS_Shape`
+    shape : ``TopoDS_Shape``
         The underlying OCC shape of the BRep.
-    type : :class:`TopAbs_ShapeEnum`, read-only
-        One of `{TopAbs_COMPOUND, TopAbs_COMPSOLID, TopAbs_SOLID, TopAbs_SHELL, TopAbs_FACE,  TopAbs_WIRE, TopAbs_EDGE, TopAbs_VERTEX, TopAbs_SHAPE}`.
-    vertices : list[:class:`BRepVertex`], read-only
+    type : ``TopAbs_ShapeEnum``, read-only
+        The type of BRep shape.
+    vertices : list[:class:`compas_occ.brep.BRepVertex`], read-only
         The vertices of the BRep.
-    edges : list[:class:`BRepEdge`], read-only
+    edges : list[:class:`compas_occ.brep.BRepEdge`], read-only
         The edges of the BRep.
-    loops : list[:class:`BRepLoop`], read-only
+    loops : list[:class:`compas_occ.brep.BRepLoop`], read-only
         The loops of the BRep.
-    faces : list[:class:`BRepFace`], read-only
+    faces : list[:class:`compas_occ.brep.BRepFace`], read-only
         The faces of the BRep.
-    orientation : :class:`TopAbs_Orientation`, read-only
-        One of `{TopAbs_FORWARD, TopAbs_REVERSED, TopAbs_INTERNAL, TopAbs_EXTERNAL}`.
-    frame : :class:`Frame`, read-only
+    orientation : TopAbs_Orientation, read-only
+        Orientation of the shape.
+    frame : :class:`compas.geometry.Frame`, read-only
         The local coordinate system of the BRep.
     area : float, read-only
         The surface area of the BRep.
@@ -195,7 +195,7 @@ def from_corners(cls,
         p1 : :class:`compas.geometry.Point`
         p2 : :class:`compas.geometry.Point`
         p3 : :class:`compas.geometry.Point`
-        p4 : :class:`compas.geometry.Point`
+        p4 : :class:`compas.geometry.Point`, optional
 
         Returns
         -------
@@ -238,12 +238,12 @@ def from_polygons(cls, polygons: List[compas.geometry.Polygon]) -> 'BRep':
         return brep
 
     @classmethod
-    def from_curves(cls, curves) -> 'BRep':
+    def from_curves(cls, curves: List[compas.geometry.NurbsCurve]) -> 'BRep':
         """Construct a BRep from a set of curves.
 
         Parameters
         ----------
-        curves : list[:class:`compas_occ.geometry.OCCNurbsCurve`]
+        curves : list[:class:`compas.geometry.NurbsCurve`]
 
         Returns
         -------
@@ -449,6 +449,7 @@ def to_json(self, filepath: str):
         Parameters
         ----------
         filepath : str
+            Location of the file.
 
         Returns
         -------
@@ -464,8 +465,11 @@ def to_step(self, filepath: str, schema: str = "AP203", unit: str = "MM") -> Non
         Parameters
         ----------
         filepath : str
+            Location of the file.
         schema : str, optional
+            STEP file format schema.
         unit : str, optional
+            Base units for the geometry in the file.
 
         Returns
         -------
@@ -499,7 +503,9 @@ def to_meshes(self, u=16, v=16):
         Parameters
         ----------
         u : int, optional
+            The number of mesh faces in the U direction of the underlying surface geometry of every face of the BRep.
         v : int, optional
+            The number of mesh faces in the V direction of the underlying surface geometry of every face of the BRep.
 
         Returns
         -------
@@ -511,7 +517,7 @@ def to_meshes(self, u=16, v=16):
         brep.shape = converter.Shape()
         meshes = []
         for face in brep.faces:
-            srf = NurbsSurface.from_face(face)
+            srf = NurbsSurface.from_face(face.face)
             mesh = srf.to_vizmesh(u, v)
             meshes.append(mesh)
         return meshes
@@ -574,24 +580,77 @@ def is_convex(self) -> bool:
         return self.shape.Convex()
 
     def is_manifold(self) -> bool:
+        """Check if the shape is manifold.
+
+        Returns
+        -------
+        bool
+
+        Notes
+        -----
+        A BRep is non-manifold if at least one edge is shared by more than two faces.
+
+        """
         pass
 
     def is_solid(self) -> bool:
+        """Check if the shape is a solid.
+
+        Returns
+        -------
+        bool
+
+        """
         pass
 
     def is_surface(self) -> bool:
+        """Check if the shape is a surface.
+
+        Returns
+        -------
+        bool
+
+        """
         pass
 
     def cull_unused_vertices(self) -> None:
+        """Remove all unused vertices.
+
+        Returns
+        -------
+        None
+
+        """
         pass
 
     def cull_unused_edges(self) -> None:
+        """Remove all unused edges.
+
+        Returns
+        -------
+        None
+
+        """
         pass
 
     def cull_unused_loops(self) -> None:
+        """Remove all unused loops.
+
+        Returns
+        -------
+        None
+
+        """
         pass
 
     def cull_unused_faces(self) -> None:
+        """Remove all unused faces.
+
+        Returns
+        -------
+        None
+
+        """
         pass
 
     # flip
@@ -611,5 +670,19 @@ def cull_unused_faces(self) -> None:
     # translate
     # unjoin edges
 
-    def contours(self, plane: compas.geometry.Plane, spacing: Optional[float] = None) -> List[List[compas.geometry.Polyline]]:
+    def contours(self,
+                 planes: List[compas.geometry.Plane]) -> List[List[compas.geometry.Polyline]]:
+        """Generate contour lines by slicing the BRep shape with a series of planes.
+
+        Parameters
+        ----------
+        planes : list[:class:`compas.geometry.Plane`]
+            The slicing planes.
+
+        Returns
+        -------
+        list[list[:class:`compas.geometry.Polyline`]]
+            A list of polylines per plane.
+
+        """
         pass
diff --git a/src/compas_occ/brep/brepedge.py b/src/compas_occ/brep/brepedge.py
@@ -1,13 +1,15 @@
 from typing import List
 from enum import Enum
 
-from OCC.Core.TopoDS import TopoDS_Edge, topods_Edge
+from OCC.Core.TopoDS import TopoDS_Edge
+from OCC.Core.TopoDS import topods_Edge
 
 from OCC.Core.TopExp import TopExp_Explorer
 from OCC.Core.TopAbs import TopAbs_VERTEX
 
 from OCC.Core.BRepAdaptor import BRepAdaptor_Curve
-from OCC.Core.GeomAdaptor import GeomAdaptor_Curve
+# from OCC.Core.GeomAdaptor import GeomAdaptor_Curve
+# from OCC.Core.Geom import Geom_Curve
 
 from OCC.Core.TopExp import topexp_FirstVertex
 from OCC.Core.TopExp import topexp_LastVertex
@@ -19,14 +21,20 @@
 from compas.geometry import Ellipse
 
 from compas_occ.brep import BRepVertex
+from compas_occ.geometry import Curve
 
 
 class BRepEdge:
     """Class representing an edge in the BRep of a geometric shape.
 
+    Parameters
+    ----------
+    edge : TopoDS_Edge
+        An OCC BRep edge.
+
     Attributes
     ----------
-    edge : :class:`TopoDS_Edge`
+    edge : ``TopoDS_Edge``
         The underlying OCC topological edge data structure.
     type : :class:`BRepEdge.CurveType`, read-only
         The type of the geometric curve underlying the topological edge.
@@ -46,15 +54,15 @@ class BRepEdge:
         True if the underlying curve is a bspline curve.
     is_other : bool, read-only
         True if the underlying curve is an other type of curve.
-    vertices : list of :class:`BRepVertex`, read-only
+    vertices : list[:class:`compas_occ.brep.BRepVertex`], read-only
         The topological vertices of the edge.
-    first_vertex : :class:`BRepVertex`, read-only
+    first_vertex : :class:`compas_occ.brep.BRepVertex`, read-only
         The first vertex with forward orientation.
-    last_vertex : :class:`BRepVertex`, read-only
+    last_vertex : :class:`compas_occ.brep.BRepVertex`, read-only
         The first vertex with reversed orientation.
-    adaptor : BRepAdaptor_Curve
+    adaptor : ``BRepAdaptor_Curve``
         Edge adaptor for extracting curve geometry.
-    curve : GeomAdaptor_Curve
+    curve : :class:`compas_occ.geometry.OCCCurve`
         Curve geometry from the edge adaptor.
 
     """
@@ -85,7 +93,7 @@ def edge(self, edge: TopoDS_Edge) -> None:
 
     @property
     def type(self) -> int:
-        return BRepEdge.CurveType(self.curve.GetType())
+        return BRepEdge.CurveType(self.adaptor.Curve().GetType())
 
     @property
     def is_line(self) -> bool:
@@ -144,9 +152,10 @@ def adaptor(self) -> BRepAdaptor_Curve:
         return self._adaptor
 
     @property
-    def curve(self) -> GeomAdaptor_Curve:
+    def curve(self) -> Curve:
         if not self._curve:
-            self._curve = self.adaptor.Curve()
+            self._curve = Curve()
+            self._curve.occ_curve = self.adaptor.Curve()
         return self._curve
 
     def to_line(self) -> compas.geometry.Line:
@@ -187,7 +196,8 @@ def to_circle(self) -> compas.geometry.Circle:
         if not self.is_circle:
             raise ValueError(f'The underlying geometry is not a circle: {self.type}')
 
-        circle = self.curve.Circle()
+        curve = self.adaptor.Curve()
+        circle = curve.Circle()
         location = circle.Location()
         direction = circle.Axis().Direction()
         radius = circle.Radius()
@@ -212,7 +222,8 @@ def to_ellipse(self) -> compas.geometry.Ellipse:
         if not self.is_ellipse:
             raise ValueError(f'The underlying geometry is not an ellipse: {self.type}')
 
-        ellipse = self.curve.Ellipse()
+        curve = self.adaptor.Curve()
+        ellipse = curve.Ellipse()
         location = ellipse.Location()
         direction = ellipse.Axis().Direction()
         major = ellipse.MajorRadius()
@@ -232,13 +243,10 @@ def to_hyperbola(self) -> None:
         ------
         ValueError
             If the underlying geometry is not a hyperbola.
-        NotImplementedError
-            In all other cases
 
         """
         if not self.is_hyperbola:
             raise ValueError(f'The underlying geometry is not a hyperbola: {self.type}')
-
         raise NotImplementedError
 
     def to_parabola(self) -> None:
@@ -252,13 +260,10 @@ def to_parabola(self) -> None:
         ------
         ValueError
             If the underlying geometry is not a parabola.
-        NotImplementedError
-            In all other cases
 
         """
         if not self.is_parabola:
             raise ValueError(f'The underlying geometry is not a parabola: {self.type}')
-
         raise NotImplementedError
 
     def to_bezier(self) -> None:
@@ -272,13 +277,10 @@ def to_bezier(self) -> None:
         ------
         ValueError
             If the underlying geometry is not a bezier curve.
-        NotImplementedError
-            In all other cases
 
         """
         if not self.is_bezier:
             raise ValueError(f'The underlying geometry is not a bezier: {self.type}')
-
         raise NotImplementedError
 
     def to_bspline(self) -> None:
@@ -292,11 +294,18 @@ def to_bspline(self) -> None:
         ------
         ValueError
             If the underlying geometry is not a bspline.
-        NotImplementedError
-            In all other cases
 
         """
         if not self.is_bspline:
             raise ValueError(f'The underlying geometry is not a bspline: {self.type}')
-
         raise NotImplementedError
+
+    def to_curve(self) -> Curve:
+        """Convert the edge geometry to a NURBS curve.
+
+        Returns
+        -------
+        :class:`compas_occ.geometry.Curve`
+
+        """
+        return self.curve
diff --git a/src/compas_occ/brep/brepvertex.py b/src/compas_occ/brep/brepvertex.py
@@ -12,12 +12,12 @@ class BRepVertex:
 
     Parameters
     ----------
-    vertex : :class:`TopoDS_Vertex`
+    vertex : ``TopoDS_Vertex``
         An OCC topological vertex data structure.
 
     Attributes
     ----------
-    vertex : :class:`TopoDS_Vertex`
+    vertex : ``TopoDS_Vertex``
         The underlying OCC vertex.
     point : :class:`compas.geometry.Point`, read-only
         The geometric point underlying the topological vertex.
