cadquery_shape_primitives.md

CadQuery Shape primitives

---

3d shapes

Box

Workplane.box

result = cq.Workplane("XY" ).box(3, 3, 3)

Cone

Solid.makeCone

result = cq.Solid.makeCone(3, 1, 3)

Cylinder

Workplane.cylinder

result = cq.Workplane("XY" ).cylinder(3, 2)

Sphere

Workplane.sphere

result = cq.Workplane("XY" ).sphere(3)

Solid.makeSphere

result = cq.Solid.makeSphere(3, angleDegrees1 = -90, angleDegrees2 =90, angleDegrees3 = 360)

Text

Workplane.text

result = cq.Workplane("XY").text("Test",10, 2)

Torus

Solid.makeTorus

result = cq.Solid.makeTorus(3, 1.5)

Wedge

Workplane.wedge

result = cq.Workplane("XY" ).wedge(3,3,3,1.5,1.5,1.5,1.5)

---

2d Sketch shapes

Arc

Sketch.arc

result = cq.Sketch().arc((0,3), (1.5,1.5), (0,0))

Circle

Sketch.circle

result = cq.Sketch().circle(4)

Ellipse

Sketch.ellipse

result = cq.Sketch().ellipse(4,5)

Polygon

Sketch.polygon

pts = [(0,0),(0,4),(2,3) ,(4,4), (4,0)]
result = cq.Sketch().polygon(pts)

Rect

Sketch.rect

result = cq.Sketch().rect(4,4)

Regular Polygon

Sketch.regularPolygon

result = cq.Sketch().regularPolygon(3,5)

Slot

Sketch.slot

result = cq.Sketch().slot(1.5, 0.5, angle=90)

Spline

Sketch.spline

pts = [(0,0),(0,4),(2,3) ,(4,4)]
result = cq.Sketch().spline(pts)

Trapezoid

Sketch.trapezoid

result = cq.Sketch().trapezoid(4,3,70)

2d shapes

2d operations

Circle

Workplane.circle

result = cq.Workplane("XY" ).circle(3)

result = cq.Edge.makeCircle(3)

Wire.makeCircle

result = cq.Wire.makeCircle(3, (0,0,0), (0,0,1))

Ellipse

Workplane.ellipse

result = cq.Workplane("XY" ).ellipse(3,4)

result = cq.Edge.makeEllipse(3,4)

Wire.makeEllipse

result = cq.Wire.makeEllipse(3, 4, (0,0,0),(0,0,1), (1,0))

Helix

Wire.makeHelix

result = cq.Wire.makeHelix(1, 4, 3)

Line

Workplane.line

result = cq.Workplane("XY" ).line(1,3)

Line To

Workplane.lineTo

result = cq.Workplane("XY" ).lineTo(1,3)

Rect

Workplane.rect

result = cq.Workplane("XY" ).rect(3, 3)

Polygon

Workplane.polygon

result = cq.Workplane("XY").polygon(6, 1)

Polyline

Workplane.polyline

pts = [(0,0),(0,4),(2,3) ,(4,4), (4,0)]
result = cq.Workplane("XY").polyline(pts).close()

slot2d

Workplane.slot2D

result = cq.Workplane("XY").slot2D(5,2)

spline

Workplane.spline

pts = [(0,0),(0,4),(2,5) ]
path = cq.Workplane("XY").spline(pts)

---

operations

Chamfer

Workplane.chamfer

origin = cq.Workplane("XY").polygon(6, 20).extrude(10).translate((0,0,-1*(10/2)))
result = origin.chamfer(1,2)

Extrude

Workplane.extrude

result = cq.Workplane("XY" ).rect(3, 3).extrude(2)

Fillet

Workplane.fillet

wikipedia

result = (
    cq.Workplane("XY")
    .box(10,10,10)
    .edges()
    .fillet(1)
)

Note

• Fillet has specific tolerances; if the fillet is too large the code will fail.

result = (
    cq.Workplane("XY")
    .box(10,10,10)
    .edges()
    .fillet(5)
)

Hole

Workplane.hole

result = cq.Workplane("XY").box(2,2,1).faces(">Z").hole(1,2)

Loft

Workplane.loft

result = (cq.Workplane("front").circle(1.5).workplane(offset=3.0).rect(0.75, 0.5).loft(combine=True))

Rotate

Workplane.rotate

result = cq.Workplane("XY" ).box(3, 3, 2).rotate((0,0,1), (0,0,0), 30)

Shell

Workplane.shell

Negative shell

result = cq.Workplane().box(10, 10, 10).faces("+Z").shell(-1)

Positiv Shell

result = cq.Workplane().box(10, 10, 10).faces("+Z").shell(-1)

Sweep

Workplane.sweep

pts = [(0,0),(0,4),(2,5) ]
path = cq.Workplane("XZ").spline(pts)
rect = cq.Workplane("XY" ).rect(3, 3)
result = rect.sweep(path)

Translate

Workplane.translate

rect = cq.Workplane("XY" ).box(3, 3, 2).translate((5,5,1))

TwistExtrude

Workplane.twistExtrude

result = cq.Workplane("XY" ).rect(3, 3).twistExtrude(2,45)

---

Plugins

CboreHole

Workplane.cboreHole

result = (
    cq.Workplane("XY")
    .box(10,10,5)
    .faces(">Z")
    .cboreHole(2,4,1.5)
)

CskHole

Workplane.cskHole

result = (
    cq.Workplane("XY")
    .box(10,10,5)
    .faces(">Z")    
    .cskHole(2, 4, 82, depth=None)
)