Implement Workplane.splineApprox

Author: adam-urbanczyk

cadquery/cq.py

@@ -1756,10 +1756,9 @@ def spline(
         makeWire: bool = False,
     ) -> T:
         """
-        Create a spline interpolated through the provided points.
+        Create a spline interpolated through the provided points (2D or 3D).
 
         :param listOfXYTuple: points to interpolate through
-        :type listOfXYTuple: list of 2-tuple
         :param tangents: vectors specifying the direction of the tangent to the
             curve at each of the specified interpolation points.
 
@@ -1852,6 +1851,52 @@ def spline(
 
         return self.newObject([rv_w if makeWire else e])
 
+    def splineApprox(
+        self: T,
+        points: Iterable[VectorLike],
+        tol: Optional[float] = 1e-6,
+        minDeg: int = 1,
+        maxDeg: int = 6,
+        smoothing: Optional[Tuple[float, float, float]] = (1, 1, 1),
+        forConstruction: bool = False,
+        includeCurrent: bool = False,
+        makeWire: bool = False,
+    ) -> T:
+        """
+        Create a spline interpolated through the provided points (2D or 3D).
+
+        :param points: points to interpolate through
+        :param tol: tolerance of the algorithm (default: 1e-6)
+        :param minDeg: minimum spline degree (default: 1)
+        :param maxDeg: maximum spline degree (default: 6)
+        :param smoothing: optional parameters for the variational smoothing algorithm (default: (1,1,1))
+        :param includeCurrent: use current point as a starting point of the curve
+        :param makeWire: convert the resulting spline edge to a wire
+        :return: a Workplane object with the current point at the end of the spline
+
+        *WARNING*  for advanced users.
+        """
+
+        allPoints = self._toVectors(points, includeCurrent)
+
+        e = Edge.makeSplineApprox(
+            allPoints,
+            minDeg=minDeg,
+            maxDeg=maxDeg,
+            smoothing=smoothing,
+            **({"tol": tol} if tol else {}),
+        )
+
+        if makeWire:
+            rv_w = Wire.assembleEdges([e])
+            if not forConstruction:
+                self._addPendingWire(rv_w)
+        else:
+            if not forConstruction:
+                self._addPendingEdge(e)
+
+        return self.newObject([rv_w if makeWire else e])
+
     def parametricCurve(
         self: T,
         func: Callable[[float], VectorLike],

tests/test_cadquery.py

@@ -4400,6 +4400,8 @@ def testSplineApprox(self):
 
         pts = [Vector(e[0], e[1], 0) for e in naca5305]
 
+        # spline
+
         e1 = Edge.makeSplineApprox(pts, 1e-6, maxDeg=6, smoothing=(1, 1, 1))
         e2 = Edge.makeSplineApprox(pts, 1e-6, minDeg=2, maxDeg=6)
 
@@ -4418,6 +4420,24 @@ def testSplineApprox(self):
         self.assertTrue(e3.IsClosed())
         self.assertTrue(w.IsClosed())
 
+        # Workplane method
+
+        w1 = Workplane().splineApprox(pts)
+        w2 = Workplane().splineApprox(pts, forConstruction=True)
+        w3 = Workplane().splineApprox(pts, makeWire=True,)
+        w4 = Workplane().splineApprox(pts, makeWire=True, forConstruction=True)
+
+        self.assertEqual(w1.edges().size(), 1)
+        self.assertEqual(len(w1.ctx.pendingEdges), 1)
+        self.assertEqual(w2.edges().size(), 1)
+        self.assertEqual(len(w2.ctx.pendingEdges), 0)
+        self.assertEqual(w3.wires().size(), 1)
+        self.assertEqual(len(w3.ctx.pendingWires), 1)
+        self.assertEqual(w4.wires().size(), 1)
+        self.assertEqual(len(w4.ctx.pendingWires), 0)
+
+        # spline surface
+
         N = 40
         T = 20
         A = 5