Added cone 3D primitive to Workplane.

Author: martinbudden

cadquery/cq.py

@@ -3800,6 +3800,63 @@ def sphere(
         else:
             return self.union(spheres, clean=clean)
 
+    def cone(
+        self: T,
+        height: float,
+        radius: float = 0,
+        radius1: float = None,
+        radius2: float = None,
+        direct: Vector = Vector(0, 0, 1),
+        angle: float = 360,
+        combine: bool = True,
+        clean: bool = True,
+    ) -> T:
+        """
+        Returns a cone with the specified radius and height for each point on the stack
+        A truncated cone can be created by specifying parameters radius1 and radius2 instead of radius.
+
+        :param height: The height of the cone
+        :type height: float > 0
+        :param radius: The radius of the cone
+        :type radius: float > 0
+        :param radius1: The radius of the bottom of the cone
+        :type radius1: float > 0
+        :param radius2: The radius of the top of the cone
+        :type radius2: float > 0
+        :param direct: The direction axis for the creation of the cone
+        :type direct: A three-tuple
+        :param angle: The angle to sweep the cone arc through
+        :type angle: float > 0
+        :param combine: Whether the results should be combined with other solids on the stack
+            (and each other)
+        :type combine: true to combine shapes, false otherwise
+        :param clean: call :py:meth:`clean` afterwards to have a clean shape
+        :return: A cone object for each point on the stack
+
+        One cone is created for each item on the current stack. If no items are on the stack, one
+        box using the current workplane center is created.
+
+        If combine is true, the result will be a single object on the stack. If a solid was found
+        in the chain, the result is that solid with all cones produced fused onto it otherwise,
+        the result is the combination of all the produced cones.
+
+        If combine is false, the result will be a list of the cones produced.
+        """
+
+        r1 = radius if radius1 is None or radius1 == 0 else radius1
+        r2 = 0 if radius2 is None else radius2
+        offset = Vector()
+        s = Solid.makeCone(r1, r2, height, offset, direct, angle)
+
+        # We want a cone for each point on the workplane
+        cones = self.eachpoint(lambda loc: s.moved(loc), True)
+
+        # If we don't need to combine everything, just return the created cones
+        if not combine:
+            return cones
+        else:
+            return self.union(cones, clean=clean)
+
     def wedge(
         self: T,
         dx: float,

doc/apireference.rst

@@ -90,6 +90,7 @@ Some 3-d operations also require an active 2-d workplane, but some do not.
 	Workplane.cutThruAll
 	Workplane.box
 	Workplane.sphere
+	Workplane.cone
 	Workplane.union
 	Workplane.combine
 	Workplane.intersect

doc/roadmap.rst

@@ -80,10 +80,9 @@ rotation/transform that return a copy
 
 primitive creation
     Need primitive creation for:
-        * cone
         * cylinder
         * torus
         * wedge
 
 extrude/cut up to surface
-    allow a cut or extrude to terminate at another surface, rather than either through all or a fixed distance
+    allow a cut or extrude to terminate at another surface, rather than either through all or a fixed distance

tests/test_cadquery.py

@@ -2443,6 +2443,20 @@ def testSphereCombine(self):
         self.assertEqual(1, s.solids().size())
         self.assertEqual(4, s.faces().size())
 
+    def testConeDefaults(self):
+        s = Workplane("XY").cone(40, 10)
+        self.saveModel(s)
+        self.assertEqual(1, s.size())
+        self.assertEqual(1, s.solids().size())
+        self.assertEqual(2, s.faces().size())
+        self.assertEqual(2, s.vertices().size())
+        s1 = Workplane("XY").cone(40, radius1=10, radius2=5)
+        self.saveModel(s)
+        self.assertEqual(1, s1.size())
+        self.assertEqual(1, s1.solids().size())
+        self.assertEqual(3, s1.faces().size())
+        self.assertEqual(2, s1.vertices().size())
+
     def testWedgeDefaults(self):
         s = Workplane("XY").wedge(10, 10, 10, 5, 5, 5, 5)
         self.saveModel(s)