cq.Shape and some free-func improvements (#1672)

* Initial commit of better paramAt, solid and a new function check

* mypy fix

* isSolid fix

* Implement outerShell, innerShells

* Imports cleanup

* Typo fix

* Make paramAt fully compatibile with Wires

* Typo fix

* Add check test

* Fix orientation handling

* Add test

* paramAt test

* More tests

* Add orientation fix and optimize check

* Switch to miniforge

* Add missing newline

Author: adam-urbanczyk

appveyor.yml

@@ -16,14 +16,14 @@ environment:
         secure: $(anaconda_token)
 
 init:
-    - cmd: curl -fsSLo Miniforge.exe https://github.com/conda-forge/miniforge/releases/latest/download/Mambaforge-Windows-x86_64.exe
+    - cmd: curl -fsSLo Miniforge.exe https://github.com/conda-forge/miniforge/releases/latest/download/Miniforge3-Windows-x86_64.exe
     - cmd: Miniforge.exe /InstallationType=JustMe /RegisterPython=0 /S /D=%MINICONDA_DIRNAME%
     - cmd: set "PATH=%MINICONDA_DIRNAME%;%MINICONDA_DIRNAME%\\Scripts;%PATH%"
     - cmd: activate
-    - sh: curl -sL https://github.com/conda-forge/miniforge/releases/latest/download/Mambaforge-$OS-x86_64.sh > miniconda.sh
+    - sh: curl -sL https://github.com/conda-forge/miniforge/releases/latest/download/Miniforge3-$OS-x86_64.sh > miniconda.sh
     - sh: bash miniconda.sh -b -p $HOME/miniconda;
     - sh: export PATH="$HOME/miniconda/bin:$HOME/miniconda/lib:$PATH";
-    - sh: source $HOME/miniconda/bin/activate 
+    - sh: source $HOME/miniconda/bin/activate
 
 install:
     - mamba env create -f environment.yml

cadquery/occ_impl/shapes.py

@@ -132,6 +132,7 @@
 from OCP.GeomAPI import (
     GeomAPI_Interpolate,
     GeomAPI_ProjectPointOnSurf,
+    GeomAPI_ProjectPointOnCurve,
     GeomAPI_PointsToBSpline,
     GeomAPI_PointsToBSplineSurface,
 )
@@ -144,6 +145,7 @@
     BRepAlgoAPI_Cut,
     BRepAlgoAPI_BooleanOperation,
     BRepAlgoAPI_Splitter,
+    BRepAlgoAPI_Check,
 )
 
 from OCP.Geom import (
@@ -152,6 +154,7 @@
     Geom_CylindricalSurface,
     Geom_Surface,
     Geom_Plane,
+    Geom_BSplineCurve,
 )
 from OCP.Geom2d import Geom2d_Line
 
@@ -211,20 +214,11 @@
     Graphic3d_VTA_TOP,
 )
 
-from OCP.Graphic3d import (
-    Graphic3d_HTA_LEFT,
-    Graphic3d_HTA_CENTER,
-    Graphic3d_HTA_RIGHT,
-    Graphic3d_VTA_BOTTOM,
-    Graphic3d_VTA_CENTER,
-    Graphic3d_VTA_TOP,
-)
-
 from OCP.NCollection import NCollection_Utf8String
 
 from OCP.BRepFeat import BRepFeat_MakeDPrism
 
-from OCP.BRepClass3d import BRepClass3d_SolidClassifier
+from OCP.BRepClass3d import BRepClass3d_SolidClassifier, BRepClass3d
 
 from OCP.TCollection import TCollection_AsciiString
 
@@ -233,10 +227,8 @@
 from OCP.GeomAbs import (
     GeomAbs_Shape,
     GeomAbs_C0,
-    GeomAbs_C1,
-    GeomAbs_C2,
     GeomAbs_G2,
-    GeomAbs_G1,
+    GeomAbs_C2,
     GeomAbs_Intersection,
     GeomAbs_JoinType,
 )
@@ -249,7 +241,7 @@
 
 from OCP.TopAbs import TopAbs_ShapeEnum, TopAbs_Orientation
 
-from OCP.ShapeAnalysis import ShapeAnalysis_FreeBounds
+from OCP.ShapeAnalysis import ShapeAnalysis_FreeBounds, ShapeAnalysis_Wire
 from OCP.TopTools import TopTools_HSequenceOfShape
 
 from OCP.GCPnts import GCPnts_AbscissaPoint
@@ -281,6 +273,8 @@
 
 from OCP.ChFi2d import ChFi2d_FilletAPI  # For Wire.Fillet()
 
+from OCP.GeomConvert import GeomConvert_ApproxCurve
+
 from math import pi, sqrt, inf, radians, cos
 
 import warnings
@@ -1643,6 +1637,9 @@ def makeVertex(cls, x: float, y: float, z: float) -> "Vertex":
 
 
 class Mixin1DProtocol(ShapeProtocol, Protocol):
+    def _approxCurve(self) -> Geom_BSplineCurve:
+        ...
+
     def _geomAdaptor(self) -> Union[BRepAdaptor_Curve, BRepAdaptor_CompCurve]:
         ...
 
@@ -1699,18 +1696,44 @@ def endPoint(self: Mixin1DProtocol) -> Vector:
 
         return Vector(curve.Value(umax))
 
-    def paramAt(self: Mixin1DProtocol, d: float) -> float:
+    def _approxCurve(self: Mixin1DProtocol) -> Geom_BSplineCurve:
         """
-        Compute parameter value at the specified normalized distance.
+        Approximate curve adaptor into a real b-spline. Meant for handling of
+        BRepAdaptor_CompCurve.
+        """
+
+        rv = GeomConvert_ApproxCurve(
+            self._geomAdaptor(), TOLERANCE, GeomAbs_C2, MaxSegments=100, MaxDegree=3
+        ).Curve()
 
-        :param d: normalized distance [0, 1]
+        return rv
+
+    def paramAt(self: Mixin1DProtocol, d: Union[Real, Vector]) -> float:
+        """
+        Compute parameter value at the specified normalized distance or a point.
+
+        :param d: normalized distance [0, 1] or a point
         :return: parameter value
         """
 
         curve = self._geomAdaptor()
 
-        l = GCPnts_AbscissaPoint.Length_s(curve)
-        return GCPnts_AbscissaPoint(curve, l * d, curve.FirstParameter()).Parameter()
+        if isinstance(d, Vector):
+            # handle comp curves (i.e. wire adaptors)
+            if isinstance(curve, BRepAdaptor_Curve):
+                curve_ = curve.Curve().Curve()  # get the underlying curve object
+            else:
+                curve_ = self._approxCurve()  # approximate the adaptor as a real curve
+
+            rv = GeomAPI_ProjectPointOnCurve(
+                d.toPnt(), curve_, curve.FirstParameter(), curve.LastParameter(),
+            ).LowerDistanceParameter()
+
+        else:
+            l = GCPnts_AbscissaPoint.Length_s(curve)
+            rv = GCPnts_AbscissaPoint(curve, l * d, curve.FirstParameter()).Parameter()
+
+        return rv
 
     def tangentAt(
         self: Mixin1DProtocol,
@@ -2253,12 +2276,29 @@ class Wire(Shape, Mixin1D):
 
     wrapped: TopoDS_Wire
 
-    def _geomAdaptor(self) -> BRepAdaptor_CompCurve:
+    def _nbEdges(self) -> int:
         """
-        Return the underlying geometry
+        Number of edges.
         """
 
-        return BRepAdaptor_CompCurve(self.wrapped)
+        sa = ShapeAnalysis_Wire()
+        sa.Load(self.wrapped)
+
+        return sa.NbEdges()
+
+    def _geomAdaptor(self) -> Union[BRepAdaptor_Curve, BRepAdaptor_CompCurve]:
+        """
+        Return the underlying geometry.
+        """
+
+        rv: Union[BRepAdaptor_Curve, BRepAdaptor_CompCurve]
+
+        if self._nbEdges() == 1:
+            rv = self.Edges()[-1]._geomAdaptor()
+        else:
+            rv = BRepAdaptor_CompCurve(self.wrapped)
+
+        return rv
 
     def close(self) -> "Wire":
         """
@@ -2518,6 +2558,7 @@ def fillet(
         """
         Apply 2D or 3D fillet to a wire
 
+        :param wire: The input wire to fillet. Currently only open wires are supported
         :param radius: the radius of the fillet, must be > zero
         :param vertices: Optional list of vertices to fillet. By default all vertices are fillet.
         :return: A wire with filleted corners
@@ -2948,7 +2989,7 @@ def thicken(self, thickness: float) -> "Solid":
             False,
             GeomAbs_Intersection,
             True,
-        )  # The last True is important to make solid
+        )  # The last True is important to make a solid
 
         builder.MakeOffsetShape()
 
@@ -3300,8 +3341,8 @@ def isSolid(obj: Shape) -> bool:
         Returns true if the object is a solid, false otherwise
         """
         if hasattr(obj, "ShapeType"):
-            if obj.ShapeType == "Solid" or (
-                obj.ShapeType == "Compound" and len(obj.Solids()) > 0
+            if obj.ShapeType() == "Solid" or (
+                obj.ShapeType() == "Compound" and len(obj.Solids()) > 0
             ):
                 return True
         return False
@@ -3837,6 +3878,22 @@ def sweep_multi(
 
         return cls(builder.Shape())
 
+    def outerShell(self) -> Shell:
+        """
+        Returns outer shell.
+        """
+
+        return Shell(BRepClass3d.OuterShell_s(self.wrapped))
+
+    def innerShells(self) -> List[Shell]:
+        """
+        Returns inner shells.
+        """
+
+        outer = self.outerShell()
+
+        return [s for s in self.Shells() if not s.isSame(outer)]
+
 
 class CompSolid(Shape, Mixin3D):
     """
@@ -4419,9 +4476,20 @@ def solid(*s: Shape) -> Shape:
 
 
 @solid.register
-def solid(s: Sequence[Shape]) -> Shape:
+def solid(s: Sequence[Shape], inner: Optional[Sequence[Shape]] = None) -> Shape:
 
-    return solid(*s)
+    builder = BRepBuilderAPI_MakeSolid()
+    builder.Add(shell(*s).wrapped)
+
+    if inner:
+        for sh in _get(shell(*inner), "Shell"):
+            builder.Add(sh.wrapped)
+
+    # fix orientations
+    sf = ShapeFix_Solid(builder.Solid())
+    sf.Perform()
+
+    return _compound_or_shape(sf.Solid())
 
 
 @multimethod
@@ -5111,3 +5179,22 @@ def loft(s: Sequence[Shape], cap: bool = False, ruled: bool = False) -> Shape:
 def loft(*s: Shape, cap: bool = False, ruled: bool = False) -> Shape:
 
     return loft(s, cap, ruled)
+
+
+#%% diagnotics
+
+
+def check(s: Shape) -> bool:
+    """
+    Check if a shape is valid.
+    """
+
+    analyzer = BRepAlgoAPI_Check(s.wrapped)
+    analyzer.SetRunParallel(True)
+    analyzer.SetUseOBB(True)
+
+    analyzer.Perform()
+
+    rv = analyzer.IsValid()
+
+    return rv

tests/test_free_functions.py

@@ -39,6 +39,7 @@
     _get,
     _get_one,
     _get_edges,
+    check,
 )
 
 from pytest import approx, raises
@@ -139,6 +140,13 @@ def test_constructors():
     assert s1.Volume() == approx(1)
     assert s2.Volume() == approx(1)
 
+    # solid with voids
+    b1 = box(0.1, 0.1, 0.1)
+
+    s3 = solid(b.Faces(), b1.moved([(0.2, 0, 0.5), (-0.2, 0, 0.5)]).Faces())
+
+    assert s3.Volume() == approx(1 - 2 * 0.1 ** 3)
+
     # compound
     c1 = compound(b.Faces())
     c2 = compound(*b.Faces())
@@ -558,3 +566,15 @@ def test_export():
     b2 = Shape.importBrep("box.brep")
 
     assert (b1 - b2).Volume() == approx(0)
+
+
+# %% diagnostics
+def test_check():
+
+    s1 = box(1, 1, 1)
+
+    assert check(s1)
+
+    s2 = sweep(rect(1, 1), segment((0, 0), (1, 1)))
+
+    assert not check(s2)

tests/test_shapes.py

@@ -0,0 +1,63 @@
+from cadquery.occ_impl.shapes import (
+    wire,
+    segment,
+    polyline,
+    Vector,
+    box,
+    Solid,
+    compound,
+)
+
+from pytest import approx
+
+
+def test_paramAt():
+
+    # paramAt for a segment
+    e = segment((0, 0), (0, 1))
+
+    p1 = e.paramAt(Vector(0, 0))
+    p2 = e.paramAt(Vector(-1, 0))
+    p3 = e.paramAt(Vector(0, 1))
+
+    assert p1 == approx(p2)
+    assert p1 == approx(0)
+    assert p3 == approx(e.paramAt(1))
+
+    # paramAt for a simple wire
+    w1 = wire(e)
+
+    p4 = w1.paramAt(Vector(0, 0))
+    p5 = w1.paramAt(Vector(0, 1))
+
+    assert p4 == approx(p1)
+    assert p5 == approx(p3)
+
+    # paramAt for a complex wire
+    w2 = polyline((0, 0), (0, 1), (1, 1))
+
+    p6 = w2.paramAt(Vector(0, 0))
+    p7 = w2.paramAt(Vector(0, 1))
+    p8 = w2.paramAt(Vector(0.1, 0.1))
+
+    assert p6 == approx(w2.paramAt(0))
+    assert p7 == approx(w2.paramAt(0.5))
+    assert p8 == approx(w2.paramAt(0.1 / 2))
+
+
+def test_isSolid():
+
+    s = box(1, 1, 1)
+
+    assert Solid.isSolid(s)
+    assert Solid.isSolid(compound(s))
+    assert not Solid.isSolid(s.faces())
+
+
+def test_shells():
+
+    s = box(2, 2, 2) - box(1, 1, 1).moved(z=0.5)
+
+    assert s.outerShell().Area() == approx(6 * 4)
+    assert len(s.innerShells()) == 1
+    assert s.innerShells()[0].Area() == approx(6 * 1)