CadQuery Class Summary 

cut(*toCut: Shape, tol: float | None = None) → Compound[source]

Remove the positional arguments from this Shape.

Parameters:

tol (float | None) – Fuzzy mode tolerance
toCut (Shape)

Return type:

fuse(*toFuse: Shape, glue: bool = False, tol: float | None = None) → Compound[source]

Fuse shapes together

Parameters:

toFuse (Shape)
glue (bool)
tol (float | None)

Return type:

intersect(*toIntersect: Shape, tol: float | None = None) → Compound[source]

Intersection of the positional arguments and this Shape.

Parameters:

tol (float | None) – Fuzzy mode tolerance
toIntersect (Shape)

Return type:

classmethod makeCompound(listOfShapes: Iterable[Shape]) → Compound[source]

Create a compound out of a list of shapes

Parameters:: listOfShapes (Iterable[Shape])
Return type:: Compound

classmethod makeText(text: str, size: float, height: float, font: str = 'Arial', fontPath: str | None = None, kind: Literal['regular', 'bold', 'italic'] = 'regular', halign: Literal['center', 'left', 'right'] = 'center', valign: Literal['center', 'top', 'bottom'] = 'center', position: Plane = Plane(origin=(0.0, 0.0, 0.0), xDir=(1.0, 0.0, 0.0), normal=(0.0, 0.0, 1.0))) → Shape[source]

Create a 3D text

Parameters:

text (str)
size (float)
height (float)
font (str)
fontPath (str | None)
kind (Literal['regular', 'bold', 'italic'])
halign (Literal['center', 'left', 'right'])
valign (Literal['center', 'top', 'bottom'])
position (Plane)

Return type:

remove(*shape: Shape)[source]

Remove the specified shapes.

Parameters:: shape (Shape)

siblings(shape: Shape, kind: Literal['Vertex', 'Edge', 'Wire', 'Face', 'Shell', 'Solid', 'CompSolid', 'Compound'], level: int = 1) → Compound[source]

Iterate over siblings, i.e. shapes within shape that share subshapes of kind with the elements of self.

Parameters:

shape (Shape)
kind (Literal['Vertex', 'Edge', 'Wire', 'Face', 'Shell', 'Solid', 'CompSolid', 'Compound'])
level (int)

Return type:

cadquery.Constraint: alias of ConstraintSpec

class cadquery.DirectionMinMaxSelector(vector: Vector, directionMax: bool = True, tolerance: float = 0.0001)[source]

Bases: CenterNthSelector

Selects objects closest or farthest in the specified direction.

Applicability:: All object types. for a vertex, its point is used. for all other kinds of objects, the center of mass of the object is used.

You can use the string shortcuts >(X|Y|Z) or <(X|Y|Z) if you want to select based on a cardinal direction.

For example this:

CQ(aCube).faces(DirectionMinMaxSelector((0, 0, 1), True))

Means to select the face having the center of mass farthest in the positive z direction, and is the same as:

CQ(aCube).faces(">Z")

Parameters:

vector (Vector)
directionMax (bool)
tolerance (float)

__init__(vector: Vector, directionMax: bool = True, tolerance: float = 0.0001)[source]

Parameters:

vector (Vector)
directionMax (bool)
tolerance (float)

class cadquery.DirectionSelector(vector: Vector, tolerance: float = 0.0001)[source]

Selects objects aligned with the provided direction.

Applicability:: Linear Edges Planar Faces

Use the string syntax shortcut +/-(X|Y|Z) if you want to select based on a cardinal direction.

Example:

CQ(aCube).faces(DirectionSelector((0, 0, 1)))

selects faces with the normal in the z direction, and is equivalent to:

CQ(aCube).faces("+Z")

Parameters:

vector (Vector)
tolerance (float)

test(vec: Vector) → bool[source]

Test a specified vector. Subclasses override to provide other implementations

Parameters:: vec (Vector)
Return type:: bool

class cadquery.Edge(obj: TopoDS_Shape)[source]

Bases: Shape, Mixin1D

A trimmed curve that represents the border of a face

Parameters:: obj (TopoDS_Shape)

arcCenter() → Vector[source]

Center of an underlying circle or ellipse geometry.

Return type:: Vector

close() → Edge | Wire[source]

Close an Edge

Return type:: Edge | Wire

hasPCurve(f: Face) → bool[source]

Check if self has a pcurve defined on f.

Parameters:: f (Face)
Return type:: bool

classmethod makeBezier(points: List[Vector]) → Edge[source]

Create a cubic Bézier Curve from the points.

Parameters:: points (List[Vector]) – a list of Vectors that represent the points. The edge will pass through the first and the last point, and the inner points are Bézier control points.
Returns:: An edge
Return type:: Edge

Makes an Ellipse centered at the provided point, having normal in the provided direction.

Parameters:

cls
x_radius (float) – x radius of the ellipse (along the x-axis of plane the ellipse should lie in)
y_radius (float) – y radius of the ellipse (along the y-axis of plane the ellipse should lie in)
pnt (Vector | Tuple[int | float, int | float] | Tuple[int | float, int | float, int | float]) – vector representing the center of the ellipse
dir (Vector | Tuple[int | float, int | float] | Tuple[int | float, int | float, int | float]) – vector representing the direction of the plane the ellipse should lie in
angle1 (float) – start angle of arc
angle2 (float) – end angle of arc (angle2 == angle1 return closed ellipse = default)
sense (Literal[-1, 1]) – clockwise (-1) or counter clockwise (1)
xdir (Vector | Tuple[int | float, int | float] | Tuple[int | float, int | float, int | float])

Returns:

an Edge

Return type:

Create a line between two points

Parameters:

v1 (Vector | Tuple[int | float, int | float] | Tuple[int | float, int | float, int | float]) – Vector that represents the first point
v2 (Vector | Tuple[int | float, int | float] | Tuple[int | float, int | float, int | float]) – Vector that represents the second point

Returns:

A linear edge between the two provided points

Return type:

classmethod makeSpline(listOfVector: List[Vector], tangents: Sequence[Vector] | None = None, periodic: bool = False, parameters: Sequence[float] | None = None, scale: bool = True, tol: float = 1e-06) → Edge[source]

Interpolate a spline through the provided points.

Parameters:

listOfVector (List[Vector]) – a list of Vectors that represent the points
tangents (Sequence[Vector] | None) – tuple of Vectors specifying start and finish tangent
periodic (bool) – creation of periodic curves
parameters (Sequence[float] | None) – the value of the parameter at each interpolation point. (The interpolated curve is represented as a vector-valued function of a scalar parameter.) If periodic == True, then len(parameters) must be len(intepolation points) + 1, otherwise len(parameters) must be equal to len(interpolation points).
scale (bool) – whether to scale the specified tangent vectors before interpolating. Each tangent is scaled, so it’s length is equal to the derivative of the Lagrange interpolated curve. I.e., set this to True, if you want to use only the direction of the tangent vectors specified by tangents, but not their magnitude.
tol (float) – tolerance of the algorithm (consult OCC documentation). Used to check that the specified points are not too close to each other, and that tangent vectors are not too short. (In either case interpolation may fail.)

Returns:

an Edge

Return type:

classmethod makeSplineApprox(listOfVector: List[Vector], tol: float = 0.001, smoothing: Tuple[float, float, float] | None = None, minDeg: int = 1, maxDeg: int = 6) → Edge[source]

Approximate a spline through the provided points.

Parameters:

listOfVector (List[Vector]) – a list of Vectors that represent the points
tol (float) – tolerance of the algorithm (consult OCC documentation).
smoothing (Tuple[float, float, float] | None) – optional tuple of 3 weights use for variational smoothing (default: None)
minDeg (int) – minimum spline degree. Enforced only when smothing is None (default: 1)
maxDeg (int) – maximum spline degree (default: 6)

Returns:

an Edge

Return type:

Makes a tangent arc from point v1, in the direction of v2 and ends at v3.

Parameters:

cls
v1 (Vector | Tuple[int | float, int | float] | Tuple[int | float, int | float, int | float]) – start vector
v2 (Vector | Tuple[int | float, int | float] | Tuple[int | float, int | float, int | float]) – tangent vector
v3 (Vector | Tuple[int | float, int | float] | Tuple[int | float, int | float, int | float]) – end vector

Returns:

an edge

Return type:

Makes a three point arc through the provided points

Parameters:

cls
v1 (Vector | Tuple[int | float, int | float] | Tuple[int | float, int | float, int | float]) – start vector
v2 (Vector | Tuple[int | float, int | float] | Tuple[int | float, int | float, int | float]) – middle vector
v3 (Vector | Tuple[int | float, int | float] | Tuple[int | float, int | float, int | float]) – end vector

Returns:

an edge object through the three points

Return type:

trim(u0: float | int, u1: float | int) → Edge[source]

Trim the edge in the parametric space to (u0, u1).

NB: this operation is done on the base geometry.

Parameters:

u0 (float | int)
u1 (float | int)

Return type:

class cadquery.Face(obj: TopoDS_Shape)[source]

Bases: Shape

a bounded surface that represents part of the boundary of a solid

Parameters:: obj (TopoDS_Shape)

Center() → Vector[source]

Returns:: The point of the center of mass of this Shape
Return type:: Vector

addHole(*inner: Wire | Edge) → Self[source]

Add one or more holes.

Parameters:: inner (Wire | Edge)
Return type:: Self

chamfer2D(d: float, vertices: Iterable[Vertex]) → Face[source]

Apply 2D chamfer to a face

Parameters:

d (float)
vertices (Iterable[Vertex])

Return type:

extend(d: float, umin: bool = True, umax: bool = True, vmin: bool = True, vmax: bool = True) → Face[source]

Extend a face. Does not work well in periodic directions.

Parameters:

d (float) – length of the extension.
umin (bool) – extend along the umin isoline.
umax (bool) – extend along the umax isoline.
vmin (bool) – extend along the vmin isoline.
vmax (bool) – extend along the vmax isoline.

Return type:

fillet2D(radius: float, vertices: Iterable[Vertex]) → Face[source]

Apply 2D fillet to a face

Parameters:

radius (float)
vertices (Iterable[Vertex])

Return type:

isoline(param: float | int, direction: Literal['u', 'v'] = 'v') → Edge[source]

Construct an isoline.

Parameters:

param (float | int)
direction (Literal['u', 'v'])

Return type:

isolines(params: Iterable[float | int], direction: Literal['u', 'v'] = 'v') → List[Edge][source]

Construct multiple isolines.

Parameters:

params (Iterable[float | int])
direction (Literal['u', 'v'])

Return type:

List[Edge]

classmethod makeFromWires(outerWire: Wire, innerWires: List[Wire] = []) → Face[source]

Makes a planar face from one or more wires

Parameters:

outerWire (Wire)
innerWires (List[Wire])

Return type:

classmethod makeNSidedSurface(edges: ~typing.Iterable[~cadquery.occ_impl.shapes.Edge | ~cadquery.occ_impl.shapes.Wire], constraints: ~typing.Iterable[~cadquery.occ_impl.shapes.Edge | ~cadquery.occ_impl.shapes.Wire | ~cadquery.occ_impl.geom.Vector | ~typing.Tuple[int | float, int | float] | ~typing.Tuple[int | float, int | float, int | float] | ~OCP.gp.gp_Pnt], continuity: ~OCP.GeomAbs.GeomAbs_Shape = <GeomAbs_Shape.GeomAbs_C0: 0>, degree: int = 3, nbPtsOnCur: int = 15, nbIter: int = 2, anisotropy: bool = False, tol2d: float = 1e-05, tol3d: float = 0.0001, tolAng: float = 0.01, tolCurv: float = 0.1, maxDeg: int = 8, maxSegments: int = 9) → Face[source]

Returns a surface enclosed by a closed polygon defined by ‘edges’ and ‘constraints’.

Parameters:

edges (list of edges or wires) – edges
constraints (list of points or edges) – constraints
continuity (GeomAbs_Shape) – OCC.Core.GeomAbs continuity condition
degree (int) – >=2
nbPtsOnCur (int) – number of points on curve >= 15
nbIter (int) – number of iterations >= 2
anisotropy (bool) – bool Anisotropy
tol2d (float) – 2D tolerance >0
tol3d (float) – 3D tolerance >0
tolAng (float) – angular tolerance
tolCurv (float) – tolerance for curvature >0
maxDeg (int) – highest polynomial degree >= 2
maxSegments (int) – greatest number of segments >= 2

Return type:

classmethod makeRuledSurface(edgeOrWire1: Edge, edgeOrWire2: Edge) → Face[source]
classmethod makeRuledSurface(edgeOrWire1: Wire, edgeOrWire2: Wire) → Face: makeRuledSurface(Edge|Wire,Edge|Wire) – Make a ruled surface Create a ruled surface out of two edges or wires. If wires are used then these must have the same number of edges

classmethod makeSplineApprox(points: List[List[Vector]], tol: float = 0.01, smoothing: Tuple[float, float, float] | None = None, minDeg: int = 1, maxDeg: int = 3) → Face[source]

Approximate a spline surface through the provided points.

Parameters:

points (List[List[Vector]]) – a 2D list of Vectors that represent the points
tol (float) – tolerance of the algorithm (consult OCC documentation).
smoothing (Tuple[float, float, float] | None) – optional tuple of 3 weights use for variational smoothing (default: None)
minDeg (int) – minimum spline degree. Enforced only when smothing is None (default: 1)
maxDeg (int) – maximum spline degree (default: 6)

Return type:

normalAt(u: float | int, v: float | int) → Tuple[Vector, Vector]

Computes the normal vector at the desired location on the face.

Returns:: a vector representing the direction
Parameters:: locationVector (a vector that lies on the surface.) – the location to compute the normal at. If none, the center of the face is used.
Return type:: Vector

Computes the normal vector at the desired location in the u,v parameter space.

Returns:

a vector representing the normal direction and the position

Parameters:

u – the u parametric location to compute the normal at.
v – the v parametric location to compute the normal at.
locationVector (Vector | Tuple[int | float, int | float] | Tuple[int | float, int | float, int | float] | None)

Return type:

normals(us: Iterable[float | int], vs: Iterable[float | int]) → Tuple[List[Vector], List[Vector]][source]

Computes the normal vectors at the desired locations in the u,v parameter space.

Returns:

a tuple of list of vectors representing the normal directions and the positions

Parameters:

us (Iterable[float | int]) – the u parametric locations to compute the normal at.
vs (Iterable[float | int]) – the v parametric locations to compute the normal at.

Return type:

Tuple[List[Vector], List[Vector]]

Computes the (u,v) pair closest to a given vector.

Returns:: (u, v) tuple
Parameters:: pt (a vector that lies on or close to the surface.) – the location to compute the normal at.
Return type:: Tuple[float, float]

Computes (u,v) pairs closest to given vectors.

Returns:

list of (u, v) tuples

Parameters:

pts (a list of vectors that lie on the surface.) – the points to compute the normals at.
tol (float)

Return type:

Tuple[List[float], List[float]]

positionAt(u: float | int, v: float | int) → Vector[source]

Computes the position vector at the desired location in the u,v parameter space.

Returns:

a vector representing the position

Parameters:

u (float | int) – the u parametric location to compute the normal at.
v (float | int) – the v parametric location to compute the normal at.

Return type:

positions(uvs: Iterable[Tuple[int | float, int | float]]) → List[Vector][source]

Computes position vectors at the desired locations in the u,v parameter space.

Returns:: list of vectors corresponding to the requested u,v positions
Parameters:: uvs (Iterable[Tuple[int | float, int | float]]) – iterable of u,v pairs.
Return type:: List[Vector]

thicken(thickness: float) → Solid[source]

Return a thickened face

Parameters:: thickness (float)
Return type:: Solid

toArcs(tolerance: float = 0.001) → Face[source]

Approximate planar face with arcs and straight line segments.

Parameters:: tolerance (float) – Approximation tolerance.
Return type:: Face

toPln() → gp_Pln[source]

Convert this face to a gp_Pln.

Note the Location of the resulting plane may not equal the center of this face, however the resulting plane will still contain the center of this face.

Return type:: gp_Pln

trim(outer: Wire, *inner: Wire) → Self

Trim the face in the (u,v) space to (u0, u1)x(v1, v2).

NB: this operation is done on the base geometry.

Trim the face using a polyline defined in the (u,v) space.

Trim using wires. The provided wires need to have a pcurve on self.

Parameters:

u0 (float | int)
u1 (float | int)
v0 (float | int)
v1 (float | int)
tol (float | int)

Return type:

Self

uvBounds() → Tuple[float, float, float, float][source]

Parametric bounds (u_min, u_max, v_min, v_max).

Return type:: Tuple[float, float, float, float]

Bases: object

Location in 3D space. Depending on usage can be absolute or relative.

This class wraps the TopLoc_Location class from OCCT. It can be used to move Shape objects in both relative and absolute manner. It is the preferred type to locate objects in CQ.

Parameters:: t (Vector | Tuple[int | float, int | float] | Tuple[int | float, int | float, int | float])

__getstate__() → BytesIO[source]

Helper for pickle.

Return type:: BytesIO

__init__(T: gp_Trsf) → None

__init__(T: TopLoc_Location) → None

__init__(t: Plane) → None

Location with translation t with respect to the original location.

Location with translation (x,y,z) and 3 rotation angles.

Location corresponding to the location of the Plane t.

Location corresponding to the angular location of the Plane t with translation v.

Location wrapping the low-level TopLoc_Location object t

Location wrapping the low-level gp_Trsf object t

Location with translation t and rotation around ax by angle
with respect to the original location.

Location with translation t and 3 rotation angles.

Parameters:: t (Vector | Tuple[int | float, int | float] | Tuple[int | float, int | float, int | float])
Return type:: None

__weakref__: list of weak references to the object (if defined)

toTuple() → Tuple[Tuple[float, float, float], Tuple[float, float, float]][source]

Convert the location to a translation, rotation tuple.

Return type:: Tuple[Tuple[float, float, float], Tuple[float, float, float]]

class cadquery.Matrix[source]

class cadquery.Matrix(matrix: gp_GTrsf | gp_Trsf)

class cadquery.Matrix(matrix: Sequence[Sequence[float]])

Bases: object

A 3d , 4x4 transformation matrix.

Used to move geometry in space.

The provided “matrix” parameter may be None, a gp_GTrsf, or a nested list of values.

If given a nested list, it is expected to be of the form:

[[m11, m12, m13, m14],
[m21, m22, m23, m24], [m31, m32, m33, m34]]

A fourth row may be given, but it is expected to be: [0.0, 0.0, 0.0, 1.0] since this is a transform matrix.

__getitem__(rc: Tuple[int, int]) → float[source]

Provide Matrix[r, c] syntax for accessing individual values. The row and column parameters start at zero, which is consistent with most python libraries, but is counter to gp_GTrsf(), which is 1-indexed.

Parameters:: rc (Tuple[int, int])
Return type:: float

__getstate__() → list[list[float]][source]

Helper for pickle.

Return type:: list[list[float]]

__init__() → None[source]
__init__(matrix: gp_GTrsf | gp_Trsf) → None
__init__(matrix: Sequence[Sequence[float]]) → None

__repr__() → str[source]

Generate a valid python expression representing this Matrix

Return type:: str

__weakref__: list of weak references to the object (if defined)

transposed_list() → Sequence[float][source]

Needed by the cqparts gltf exporter

Return type:: Sequence[float]

class cadquery.NearestToPointSelector(pnt)[source]

Bases: Selector

Selects object nearest the provided point.

If the object is a vertex or point, the distance is used. For other kinds of shapes, the center of mass is used to to compute which is closest.

Applicability: All Types of Shapes

Example:

CQ(aCube).vertices(NearestToPointSelector((0, 1, 0)))

returns the vertex of the unit cube closest to the point x=0,y=1,z=0

__init__(pnt)[source]

filter(objectList: Sequence[Shape])[source]

Filter the provided list.

The default implementation returns the original list unfiltered.

Parameters:: objectList (list of OCCT primitives) – list to filter
Returns:: filtered list

class cadquery.ParallelDirSelector(vector: Vector, tolerance: float = 0.0001)[source]

Selects objects parallel with the provided direction.

Applicability:: Linear Edges Planar Faces

Use the string syntax shortcut |(X|Y|Z) if you want to select based on a cardinal direction.

Example:

CQ(aCube).faces(ParallelDirSelector((0, 0, 1)))

selects faces with the normal parallel to the z direction, and is equivalent to:

CQ(aCube).faces("|Z")

Parameters:

vector (Vector)
tolerance (float)

test(vec: Vector) → bool[source]

Test a specified vector. Subclasses override to provide other implementations

Parameters:: vec (Vector)
Return type:: bool

class cadquery.PerpendicularDirSelector(vector: Vector, tolerance: float = 0.0001)[source]

Selects objects perpendicular with the provided direction.

Applicability:: Linear Edges Planar Faces

Use the string syntax shortcut #(X|Y|Z) if you want to select based on a cardinal direction.

Example:

CQ(aCube).faces(PerpendicularDirSelector((0, 0, 1)))

selects faces with the normal perpendicular to the z direction, and is equivalent to:

CQ(aCube).faces("#Z")

Parameters:

vector (Vector)
tolerance (float)

test(vec: Vector) → bool[source]

Test a specified vector. Subclasses override to provide other implementations

Parameters:: vec (Vector)
Return type:: bool

class cadquery.Plane(origin: Tuple[float, float, float] | Vector, xDir: Tuple[float, float, float] | Vector | None = None, normal: Tuple[float, float, float] | Vector = (0, 0, 1))[source]

Bases: object

A 2D coordinate system in space

A 2D coordinate system in space, with the x-y axes on the plane, and a particular point as the origin.

A plane allows the use of 2D coordinates, which are later converted to global, 3d coordinates when the operations are complete.

Frequently, it is not necessary to create work planes, as they can be created automatically from faces.

Parameters:

origin (Tuple[float, float, float] | Vector)
xDir (Vector)
normal (Tuple[float, float, float] | Vector)

__eq__(other)[source]: Return self==value.

__getstate__() → Tuple[Vector, Vector, Vector, Vector][source]

Helper for pickle.

Return type:: Tuple[Vector, Vector, Vector, Vector]

__hash__ = None

__init__(origin: Tuple[float, float, float] | Vector, xDir: Tuple[float, float, float] | Vector | None = None, normal: Tuple[float, float, float] | Vector = (0, 0, 1))[source]

Create a Plane with an arbitrary orientation

Parameters:

origin (Tuple[float, float, float] | Vector) – the origin in global coordinates
xDir (Tuple[float, float, float] | Vector | None) – an optional vector representing the xDirection.
normal (Tuple[float, float, float] | Vector) – the normal direction for the plane

Raises:

ValueError – if the specified xDir is not orthogonal to the provided normal

__ne__(other)[source]: Return self!=value.

__repr__()[source]: Return repr(self).

__weakref__: list of weak references to the object (if defined)

classmethod named(stdName: str, origin=(0, 0, 0)) → Plane[source]

Create a predefined Plane based on the conventional names.

Parameters:

stdName (string) – one of (XY|YZ|ZX|XZ|YX|ZY|front|back|left|right|top|bottom)
origin (3-tuple of the origin of the new plane, in global coordinates.) – the desired origin, specified in global coordinates

Return type:

Plane

Available named planes are as follows. Direction references refer to the global directions.

Name	xDir	yDir	zDir
XY	+x	+y	+z
YZ	+y	+z	+x
ZX	+z	+x	+y
XZ	+x	+z	-y
YX	+y	+x	-z
ZY	+z	+y	-x
front	+x	+y	+z
back	-x	+y	-z
left	+z	+y	-x
right	-z	+y	+x
top	+x	-z	+y
bottom	+x	+z	-y

rotated(rotate=(0, 0, 0))[source]

Returns a copy of this plane, rotated about the specified axes

Since the z axis is always normal the plane, rotating around Z will always produce a plane that is parallel to this one.

The origin of the workplane is unaffected by the rotation.

Rotations are done in order x, y, z. If you need a different order, manually chain together multiple rotate() commands.

Parameters:: rotate – Vector [xDegrees, yDegrees, zDegrees]
Returns:: a copy of this plane rotated as requested.

setOrigin2d(x, y)[source]

Set a new origin in the plane itself

Set a new origin in the plane itself. The plane’s orientation and xDrection are unaffected.

Parameters:

x (float) – offset in the x direction
y (float) – offset in the y direction

Returns:

void

The new coordinates are specified in terms of the current 2D system. As an example:

p = Plane.XY() p.setOrigin2d(2, 2) p.setOrigin2d(2, 2)

results in a plane with its origin at (x, y) = (4, 4) in global coordinates. Both operations were relative to local coordinates of the plane.

toLocalCoords(obj)[source]

Project the provided coordinates onto this plane

Parameters:: obj – an object or vector to convert
Returns:: an object of the same type, but converted to local coordinates

Most of the time, the z-coordinate returned will be zero, because most operations based on a plane are all 2D. Occasionally, though, 3D points outside of the current plane are transformed. One such example is Workplane.box(), where 3D corners of a box are transformed to orient the box in space correctly.

toWorldCoords(tuplePoint) → Vector[source]

Convert a point in local coordinates to global coordinates

Parameters:: tuplePoint (a 2 or three tuple of float. The third value is taken to be zero if not supplied.) – point in local coordinates to convert.
Returns:: a Vector in global coordinates
Return type:: Vector

class cadquery.Selector[source]

Bases: object

Filters a list of objects.

Filters must provide a single method that filters objects.

__weakref__: list of weak references to the object (if defined)

filter(objectList: Sequence[Shape]) → List[Shape][source]

Filter the provided list.

The default implementation returns the original list unfiltered.

Parameters:: objectList (list of OCCT primitives) – list to filter
Returns:: filtered list
Return type:: List[Shape]

class cadquery.Shape(obj: TopoDS_Shape)[source]

Bases: object

Represents a shape in the system. Wraps TopoDS_Shape.

Parameters:: obj (TopoDS_Shape)

Area() → float[source]

Returns:: The surface area of all faces in this Shape
Return type:: float

BoundingBox(tolerance: float | None = None) → BoundBox[source]

Create a bounding box for this Shape.

Parameters:: tolerance (float | None) – Tolerance value passed to BoundBox
Returns:: A BoundBox object for this Shape
Return type:: BoundBox

Center() → Vector[source]

Returns:: The point of the center of mass of this Shape
Return type:: Vector

CenterOfBoundBox(tolerance: float | None = None) → Vector[source]

Parameters:: tolerance (float | None) – Tolerance passed to the BoundingBox() method
Returns:: Center of the bounding box of this shape
Return type:: Vector

Closed() → bool[source]

Returns:: The closedness flag
Return type:: bool

static CombinedCenter(objects: Iterable[Shape]) → Vector[source]

Calculates the center of mass of multiple objects.

Parameters:: objects (Iterable[Shape]) – A list of objects with mass
Return type:: Vector

static CombinedCenterOfBoundBox(objects: List[Shape]) → Vector[source]

Calculates the center of a bounding box of multiple objects.

Parameters:: objects (List[Shape]) – A list of objects
Return type:: Vector

CompSolids() → List[CompSolid][source]

Returns:: All the compsolids in this Shape
Return type:: List[CompSolid]

Compounds() → List[Compound][source]

Returns:: All the compounds in this Shape
Return type:: List[Compound]

Edges() → List[Edge][source]

Returns:: All the edges in this Shape
Return type:: List[Edge]

Faces() → List[Face][source]

Returns:: All the faces in this Shape
Return type:: List[Face]

Shells() → List[Shell][source]

Returns:: All the shells in this Shape
Return type:: List[Shell]

Solids() → List[Solid][source]

Returns:: All the solids in this Shape
Return type:: List[Solid]

Vertices() → List[Vertex][source]

Returns:: All the vertices in this Shape
Return type:: List[Vertex]

Volume() → float[source]

Returns:: The volume of this Shape
Return type:: float

Wires() → List[Wire][source]

Returns:: All the wires in this Shape
Return type:: List[Wire]

__add__(other: Shape) → Shape[source]

Fuse self and other.

Parameters:: other (Shape)
Return type:: Shape

__eq__(other) → bool[source]

Return self==value.

Return type:: bool

__getstate__() → Tuple[BytesIO, bool][source]

Helper for pickle.

Return type:: Tuple[BytesIO, bool]

__hash__() → int[source]

Return hash(self).

Return type:: int

__init__(obj: TopoDS_Shape)[source]

Parameters:: obj (TopoDS_Shape)

__iter__() → Iterator[Shape][source]

Iterate over subshapes.

Return type:: Iterator[Shape]

__mul__(other: Shape) → Shape[source]

Intersect self and other.

Parameters:: other (Shape)
Return type:: Shape

__sub__(other: Shape) → Shape[source]

Subtract other from self.

Parameters:: other (Shape)
Return type:: Shape

__truediv__(other: Shape) → Shape[source]

Split self with other.

Parameters:: other (Shape)
Return type:: Shape

__weakref__: list of weak references to the object (if defined)

ancestors(shape: Shape, kind: Literal['Vertex', 'Edge', 'Wire', 'Face', 'Shell', 'Solid', 'CompSolid', 'Compound']) → Compound[source]

Iterate over ancestors, i.e. shapes of same kind within shape that contain self.

Parameters:

shape (Shape)
kind (Literal['Vertex', 'Edge', 'Wire', 'Face', 'Shell', 'Solid', 'CompSolid', 'Compound'])

Return type:

classmethod cast(obj: TopoDS_Shape, forConstruction: bool = False) → Shape[source]

Returns the right type of wrapper, given a OCCT object

Parameters:

obj (TopoDS_Shape)
forConstruction (bool)

Return type:

static centerOfMass(obj: Shape) → Vector[source]

Calculates the center of ‘mass’ of an object.

Parameters:: obj (Shape) – Compute the center of mass of this object
Return type:: Vector

clean() → T[source]

Experimental clean using ShapeUpgrade

Parameters:: self (T)
Return type:: T

static computeMass(obj: Shape) → float[source]

Calculates the ‘mass’ of an object.

Parameters:: obj (Shape) – Compute the mass of this object
Return type:: float

copy(mesh: bool = False) → T[source]

Creates a new object that is a copy of this object.

Parameters:

self (T)
mesh (bool) – should I copy the triangulation too (default: False)

Returns:

a copy of the object

Return type:

T

cut(*toCut: Shape, tol: float | None = None) → Shape[source]

Remove the positional arguments from this Shape.

Parameters:

tol (float | None) – Fuzzy mode tolerance
toCut (Shape)

Return type:

distance(other: Shape) → float[source]

Minimal distance between two shapes

Parameters:: other (Shape)
Return type:: float

distances(*others: Shape) → Iterator[float][source]

Minimal distances to between self and other shapes

Parameters:: others (Shape)
Return type:: Iterator[float]

edges(selector: Selector | str | None = None) → Shape[source]

Select edges.

Parameters:: selector (Selector | str | None)
Return type:: Shape

export(fname: str, tolerance: float = 0.1, angularTolerance: float = 0.1, opt: Dict[str, Any] | None = None)[source]

Export Shape to file.

Parameters:

self (T)
fname (str)
tolerance (float)
angularTolerance (float)
opt (Dict[str, Any] | None)

exportBin(f: str | BytesIO) → bool[source]

Export this shape to a binary BREP file.

Parameters:: f (str | BytesIO)
Return type:: bool

exportBrep(f: str | BytesIO) → bool[source]

Export this shape to a BREP file

Parameters:: f (str | BytesIO)
Return type:: bool

exportStep(fileName: str, **kwargs) → IFSelect_ReturnStatus[source]

Export this shape to a STEP file.

kwargs is used to provide optional keyword arguments to configure the exporter.

Parameters:

fileName (str) – Path and filename for writing.
write_pcurves (bool) –
Enable or disable writing parametric curves to the STEP file. Default True.

If False, writes STEP file without pcurves. This decreases the size of the resulting STEP file.
precision_mode (int) – Controls the uncertainty value for STEP entities. Specify -1, 0, or 1. Default 0. See OCCT documentation.

Return type:

IFSelect_ReturnStatus

exportStl(fileName: str, tolerance: float = 0.001, angularTolerance: float = 0.1, ascii: bool = False, relative: bool = True, parallel: bool = True) → bool[source]

Exports a shape to a specified STL file.

Parameters:

fileName (str) – The path and file name to write the STL output to.
tolerance (float) – A linear deflection setting which limits the distance between a curve and its tessellation. Setting this value too low will result in large meshes that can consume computing resources. Setting the value too high can result in meshes with a level of detail that is too low. Default is 1e-3, which is a good starting point for a range of cases.
angularTolerance (float) – Angular deflection setting which limits the angle between subsequent segments in a polyline. Default is 0.1.
ascii (bool) – Export the file as ASCII (True) or binary (False) STL format. Default is binary.
relative (bool) – If True, tolerance will be scaled by the size of the edge being meshed. Default is True. Setting this value to True may cause large features to become faceted, or small features dense.
parallel (bool) – If True, OCCT will use parallel processing to mesh the shape. Default is True.

Return type:

bool

faces(selector: Selector | str | None = None) → Shape[source]

Select faces.

Parameters:: selector (Selector | str | None)
Return type:: Shape

Computes the intersections between the provided line and the faces of this Shape

Parameters:

point (Vector | Tuple[int | float, int | float] | Tuple[int | float, int | float, int | float]) – Base point for defining a line
axis (Vector | Tuple[int | float, int | float] | Tuple[int | float, int | float, int | float]) – Axis on which the line rests
tol (float) – Intersection tolerance
direction (Literal['AlongAxis', 'Opposite'] | None) – Valid values: “AlongAxis”, “Opposite”; If specified, will ignore all faces that are not in the specified direction including the face where the point lies if it is the case

Returns:

A list of intersected faces sorted by distance from point

fix() → T[source]

Try to fix shape if not valid

Parameters:: self (T)
Return type:: T

fuse(*toFuse: Shape, glue: bool = False, tol: float | None = None) → Shape[source]

Fuse the positional arguments with this Shape.

Parameters:

glue (bool) – Sets the glue option for the algorithm, which allows increasing performance of the intersection of the input shapes
tol (float | None) – Fuzzy mode tolerance
toFuse (Shape)

Return type:

geomType() → Literal['Vertex', 'Wire', 'Shell', 'Solid', 'Compound', 'PLANE', 'CYLINDER', 'CONE', 'SPHERE', 'TORUS', 'BEZIER', 'BSPLINE', 'REVOLUTION', 'EXTRUSION', 'OFFSET', 'OTHER', 'LINE', 'CIRCLE', 'ELLIPSE', 'HYPERBOLA', 'PARABOLA'][source]

Gets the underlying geometry type.

Implementations can return any values desired, but the values the user uses in type filters should correspond to these.

As an example, if a user does:

CQ(object).faces("%mytype")

The expectation is that the geomType attribute will return ‘mytype’

The return values depend on the type of the shape:

Vertex: always ‘Vertex’

Edge: LINE, CIRCLE, ELLIPSE, HYPERBOLA, PARABOLA, BEZIER,

BSPLINE, OFFSET, OTHER

Face: PLANE, CYLINDER, CONE, SPHERE, TORUS, BEZIER, BSPLINE,

REVOLUTION, EXTRUSION, OFFSET, OTHER

Solid: ‘Solid’

Shell: ‘Shell’

Compound: ‘Compound’

Wire: ‘Wire’

Returns:: A string according to the geometry type
Return type:: Literal[‘Vertex’, ‘Wire’, ‘Shell’, ‘Solid’, ‘Compound’, ‘PLANE’, ‘CYLINDER’, ‘CONE’, ‘SPHERE’, ‘TORUS’, ‘BEZIER’, ‘BSPLINE’, ‘REVOLUTION’, ‘EXTRUSION’, ‘OFFSET’, ‘OTHER’, ‘LINE’, ‘CIRCLE’, ‘ELLIPSE’, ‘HYPERBOLA’, ‘PARABOLA’]

hashCode() → int[source]

Returns a hashed value denoting this shape. It is computed from the TShape and the Location. The Orientation is not used.

Return type:: int

classmethod importBin(f: str | BytesIO) → Shape[source]

Import shape from a binary BREP file.

Parameters:: f (str | BytesIO)
Return type:: Shape

classmethod importBrep(f: str | BytesIO) → Shape[source]

Import shape from a BREP file

Parameters:: f (str | BytesIO)
Return type:: Shape

intersect(*toIntersect: Shape, tol: float | None = None) → Shape[source]

Intersection of the positional arguments and this Shape.

Parameters:

tol (float | None) – Fuzzy mode tolerance
toIntersect (Shape)

Return type:

isEqual(other: Shape) → bool[source]

Returns True if two shapes are equal, i.e. if they share the same TShape with the same Locations and Orientations. Also see isSame().

Parameters:: other (Shape)
Return type:: bool

isNull() → bool[source]

Returns true if this shape is null. In other words, it references no underlying shape with the potential to be given a location and an orientation.

Return type:: bool

isSame(other: Shape) → bool[source]

Returns True if other and this shape are same, i.e. if they share the same TShape with the same Locations. Orientations may differ. Also see isEqual()

Parameters:: other (Shape)
Return type:: bool

isValid() → bool[source]

Returns True if no defect is detected on the shape S or any of its subshapes. See the OCCT docs on BRepCheck_Analyzer::IsValid for a full description of what is checked.

Return type:: bool

locate(loc: Location) → T[source]

Apply a location in absolute sense to self.

Parameters:

self (T)
loc (Location)

Return type:

T

located(loc: Location) → T[source]

Apply a location in absolute sense to a copy of self.

Parameters:

self (T)
loc (Location)

Return type:

T

location() → Location[source]

Return the current location

Return type:: Location

static matrixOfInertia(obj: Shape) → List[List[float]][source]

Calculates the matrix of inertia of an object. Since the part’s density is unknown, this result is inertia/density with units of [1/length]. :param obj: Compute the matrix of inertia of this object

Parameters:: obj (Shape)
Return type:: List[List[float]]

mesh(tolerance: float, angularTolerance: float = 0.1)[source]

Generate triangulation if none exists.

Parameters:

tolerance (float)
angularTolerance (float)

Applies a mirror transform to this Shape. Does not duplicate objects about the plane.

Parameters:

mirrorPlane (Literal['XY', 'YX', 'XZ', 'ZX', 'YZ', 'ZY'] | ~cadquery.occ_impl.geom.Vector | ~typing.Tuple[int | float, int | float] | ~typing.Tuple[int | float, int | float, int | float]) – The direction of the plane to mirror about - one of ‘XY’, ‘XZ’ or ‘YZ’
basePointVector (Vector | Tuple[int | float, int | float] | Tuple[int | float, int | float, int | float]) – The origin of the plane to mirror about

Returns:

The mirrored shape

Return type:

move(loc: Location) → T[source]

Apply a location in relative sense (i.e. update current location) to self.

Apply translation and rotation in relative sense (i.e. update current location) to self.

Apply a VectorLike in relative sense (i.e. update current location) to self.

Parameters:

self (T)
loc (Location)

Return type:

T

moved(loc1: Location, loc2: Location, *locs: Location) → T

moved(locs: Sequence[Location]) → T

moved(loc: Location) → T

Apply a location in relative sense (i.e. update current location) to a copy of self.

Apply multiple locations.

Apply translation and rotation in relative sense to a copy of self.

Apply a VectorLike in relative sense to a copy of self.

Apply multiple VectorLikes in relative sense to a copy of self.

Parameters:

self (T)
loc (Location)

Return type:

T

remove(*subshape: Shape) → Self[source]

Remove subshapes.

Parameters:: subshape (Shape)
Return type:: Self

replace(old: Shape, *new: Shape) → Self[source]

Replace old subshape with new subshapes.

Parameters:

old (Shape)
new (Shape)

Return type:

Self

Rotates a shape around an axis.

Parameters:

self (T)
startVector (either a 3-tuple or a Vector) – start point of rotation axis
endVector (either a 3-tuple or a Vector) – end point of rotation axis
angleDegrees (float) – angle to rotate, in degrees

Returns:

a copy of the shape, rotated

Return type:

T

scale(factor: float) → Shape[source]

Scales this shape through a transformation.

Parameters:: factor (float)
Return type:: Shape

shells(selector: Selector | str | None = None) → Shape[source]

Select shells.

Parameters:: selector (Selector | str | None)
Return type:: Shape

siblings(shape: Shape, kind: Literal['Vertex', 'Edge', 'Wire', 'Face', 'Shell', 'Solid', 'CompSolid', 'Compound'], level: int = 1) → Compound[source]

Iterate over siblings, i.e. shapes within shape that share subshapes of kind with self.

Parameters:

shape (Shape)
kind (Literal['Vertex', 'Edge', 'Wire', 'Face', 'Shell', 'Solid', 'CompSolid', 'Compound'])
level (int)

Return type:

solids(selector: Selector | str | None = None) → Shape[source]

Select solids.

Parameters:: selector (Selector | str | None)
Return type:: Shape

split(*splitters: Shape) → Shape[source]

Split this shape with the positional arguments.

Parameters:: splitters (Shape)
Return type:: Shape

toNURBS() → T[source]

Return a NURBS representation of a given shape.

Parameters:: self (T)
Return type:: T

toSplines(degree: int = 3, tolerance: float = 0.001, nurbs: bool = False) → T[source]

Approximate shape with b-splines of the specified degree.

Parameters:

self (T)
degree (int) – Maximum degree.
tolerance (float) – Approximation tolerance.
nurbs (bool) – Use rational splines.

Return type:

T

toVtkPolyData(tolerance: float | None = None, angularTolerance: float | None = None, normals: bool = False) → vtkPolyData[source]

Convert shape to vtkPolyData

Parameters:

tolerance (float | None)
angularTolerance (float | None)
normals (bool)

Return type:

vtkPolyData

transformGeometry(tMatrix: Matrix) → Shape[source]

Transforms this shape by tMatrix.

WARNING: transformGeometry will sometimes convert lines and circles to splines, but it also has the ability to handle skew and stretching transformations.

If your transformation is only translation and rotation, it is safer to use transformShape(), which doesn’t change the underlying type of the geometry, but cannot handle skew transformations.

Parameters:: tMatrix (Matrix) – The transformation matrix
Returns:: a copy of the object, but with geometry transformed instead of just rotated.
Return type:: Shape

transformShape(tMatrix: Matrix) → Shape[source]

Transforms this Shape by tMatrix. Also see transformGeometry().

Parameters:: tMatrix (Matrix) – The transformation matrix
Returns:: a copy of the object, transformed by the provided matrix, with all objects keeping their type
Return type:: Shape

Translates this shape through a transformation.

Parameters:

self (T)
vector (Vector | Tuple[int | float, int | float] | Tuple[int | float, int | float, int | float])

Return type:

T

vertices(selector: Selector | str | None = None) → Shape[source]

Select vertices.

Parameters:: selector (Selector | str | None)
Return type:: Shape

wires(selector: Selector | str | None = None) → Shape[source]

Select wires.

Parameters:: selector (Selector | str | None)
Return type:: Shape

class cadquery.Shell(obj: TopoDS_Shape)[source]

Bases: Shape

the outer boundary of a surface

Parameters:: obj (TopoDS_Shape)

classmethod makeShell(listOfFaces: Iterable[Face]) → Shell[source]

Makes a shell from faces.

Parameters:: listOfFaces (Iterable[Face])
Return type:: Shell

class cadquery.Sketch(parent: ~typing.Any = None, locs: ~typing.Iterable[~cadquery.occ_impl.geom.Location] = (<cadquery.occ_impl.geom.Location object>, ), obj: ~cadquery.occ_impl.shapes.Compound | None = None)[source]

Bases: object

2D sketch. Supports faces, edges and edges with constraints based construction.

Parameters:

parent (Any)
locs (List[Location])
obj (Compound | None)

__add__(other: Sketch) → T[source]

Fuse self and other.

Parameters:

self (T)
other (Sketch)

Return type:

T

__init__(parent: ~typing.Any = None, locs: ~typing.Iterable[~cadquery.occ_impl.geom.Location] = (<cadquery.occ_impl.geom.Location object>, ), obj: ~cadquery.occ_impl.shapes.Compound | None = None)[source]

Construct an empty sketch.

Parameters:

self (T)
parent (Any)
locs (Iterable[Location])
obj (Compound | None)

__iter__() → Iterator[Face][source]

Iterate over faces-locations combinations. If not faces are present iterate over edges:

Return type:: Iterator[Face]

__mul__(other: Sketch) → T[source]

Intersect self and other.

Parameters:

self (T)
other (Sketch)

Return type:

T

__sub__(other: Sketch) → T[source]

Subtract other from self.

Parameters:

self (T)
other (Sketch)

Return type:

T

__truediv__(other: Sketch) → T[source]

Split self with other.

Parameters:

self (T)
other (Sketch)

Return type:

T

__weakref__: list of weak references to the object (if defined)

add() → T[source]

Add selection to the underlying faces.

Parameters:: self (T)
Return type:: T

apply(f: Callable[[Iterable[Shape | Location]], Iterable[Shape | Location]])[source]

Apply a callable to all items at once.

Parameters:

self (T)
f (Callable[[Iterable[Shape | Location]], Iterable[Shape | Location]]) – Callable to be applied.

Returns:

Sketch object with f applied to all items.

Construct an arc.

Parameters:

self (T)
p1 (Vector | Tuple[int | float, int | float])
p2 (Vector | Tuple[int | float, int | float])
p3 (Vector | Tuple[int | float, int | float])
tag (str | None)
forConstruction (bool)

Return type:

T

assemble(mode: Literal['a', 's', 'i', 'c', 'r'] = 'a', tag: str | None = None) → T[source]

Assemble edges into faces.

Parameters:

self (T)
mode (Literal['a', 's', 'i', 'c', 'r'])
tag (str | None)

Return type:

T

bezier(pts: Iterable[Vector | Tuple[int | float, int | float]], tag: str | None = None, forConstruction: bool = False) → T[source]

Construct an bezier curve.

The edge will pass through the last points, and the inner points are bezier control points.

Parameters:

self (T)
pts (Iterable[Vector | Tuple[int | float, int | float]])
tag (str | None)
forConstruction (bool)

Return type:

T

chamfer(d: int | float) → T[source]

Add a chamfer based on current selection.

Parameters:

self (T)
d (int | float)

Return type:

T

circle(r: int | float, mode: Literal['a', 's', 'i', 'c', 'r'] = 'a', tag: str | None = None) → T[source]

Construct a circular face.

Parameters:

self (T)
r (int | float)
mode (Literal['a', 's', 'i', 'c', 'r'])
tag (str | None)

Return type:

T

clean() → T[source]

Remove internal wires.

Parameters:: self (T)
Return type:: T

close(tag: str | None = None) → T[source]

Connect last edge to the first one.

Parameters:

self (T)
tag (str | None)

Return type:

T

constrain(tag: str, constraint: Literal['Fixed', 'FixedPoint', 'Coincident', 'Angle', 'Length', 'Distance', 'Radius', 'Orientation', 'ArcAngle'], arg: Any) → T[source]

constrain(tag1: str, tag2: str, constraint: Literal['Fixed', 'FixedPoint', 'Coincident', 'Angle', 'Length', 'Distance', 'Radius', 'Orientation', 'ArcAngle'], arg: Any) → T

Add a constraint.

Parameters:

self (T)
tag (str)
constraint (Literal['Fixed', 'FixedPoint', 'Coincident', 'Angle', 'Length', 'Distance', 'Radius', 'Orientation', 'ArcAngle'])
arg (Any)

Return type:

T

copy() → T[source]

Create a partial copy of the sketch.

Parameters:: self (T)
Return type:: T

delete() → T[source]

Delete selected object.

Parameters:: self (T)
Return type:: T

distribute(n: int, start: int | float = 0, stop: int | float = 1, rotate: bool = True) → T[source]

Distribute locations along selected edges or wires.

Parameters:

self (T)
n (int)
start (int | float)
stop (int | float)
rotate (bool)

Return type:

T

each(callback: Callable[[Location], Face | Sketch | Compound], mode: Literal['a', 's', 'i', 'c', 'r'] = 'a', tag: str | None = None, ignore_selection: bool = False) → T[source]

Apply a callback on all applicable entities.

Parameters:

self (T)
callback (Callable[[Location], Face | Sketch | Compound])
mode (Literal['a', 's', 'i', 'c', 'r'])
tag (str | None)
ignore_selection (bool)

Return type:

T

edge(val: Edge, tag: str | None = None, forConstruction: bool = False) → T[source]

Add an edge to the sketch.

Parameters:

self (T)
val (Edge)
tag (str | None)
forConstruction (bool)

Return type:

T

edges(s: str | Selector | None = None, tag: str | None = None) → T[source]

Select edges.

Parameters:

self (T)
s (str | Selector | None)
tag (str | None)

Return type:

T

ellipse(a1: int | float, a2: int | float, angle: int | float = 0, mode: Literal['a', 's', 'i', 'c', 'r'] = 'a', tag: str | None = None) → T[source]

Construct an elliptical face.

Parameters:

self (T)
a1 (int | float)
a2 (int | float)
angle (int | float)
mode (Literal['a', 's', 'i', 'c', 'r'])
tag (str | None)

Return type:

T

export(fname: str, tolerance: float = 0.1, angularTolerance: float = 0.1, opt: Dict[str, Any] | None = None) → T[source]

Export Sketch to file.

Parameters:

self (T)
path – Filename.
tolerance (float) – the deflection tolerance, in model units. Default 0.1.
angularTolerance (float) – the angular tolerance, in radians. Default 0.1.
opt (Dict[str, Any] | None) – additional options passed to the specific exporter. Default None.
fname (str)

Returns:

Self.

Return type:

T

Construct a face from a wire or edges.

Parameters:

self (T)
b (Wire | Iterable[Edge] | Shape | T)
angle (int | float)
mode (Literal['a', 's', 'i', 'c', 'r'])
tag (str | None)
ignore_selection (bool)

Return type:

T

faces(s: str | Selector | None = None, tag: str | None = None) → T[source]

Select faces.

Parameters:

self (T)
s (str | Selector | None)
tag (str | None)

Return type:

T

fillet(d: int | float) → T[source]

Add a fillet based on current selection.

Parameters:

self (T)
d (int | float)

Return type:

T

filter(f: Callable[[Shape | Location], bool]) → T[source]

Filter items using a boolean predicate.

Parameters:

self (T)
f (Callable[[Shape | Location], bool]) – Callable to be used for filtering.

Returns:

Sketch object with filtered items.

Return type:

T

finalize() → Any[source]

Finish sketch construction and return the parent.

Return type:: Any

hull(mode: Literal['a', 's', 'i', 'c', 'r'] = 'a', tag: str | None = None) → T[source]

Generate a convex hull from current selection or all objects.

Parameters:

self (T)
mode (Literal['a', 's', 'i', 'c', 'r'])
tag (str | None)

Return type:

T

importDXF(filename: str, tol: float = 1e-06, exclude: List[str] = [], include: List[str] = [], angle: int | float = 0, mode: Literal['a', 's', 'i', 'c', 'r'] = 'a', tag: str | None = None) → T[source]

Import a DXF file and construct face(s)

Parameters:

self (T)
filename (str)
tol (float)
exclude (List[str])
include (List[str])
angle (int | float)
mode (Literal['a', 's', 'i', 'c', 'r'])
tag (str | None)

Return type:

T

invoke(f: Callable[[T], T] | Callable[[T], None] | Callable[[], None])[source]

Invoke a callable mapping Sketch to Sketch or None. Supports also callables that take no arguments such as breakpoint. Returns self if callable returns None.

Parameters:

self (T)
f (Callable[[T], T] | Callable[[T], None] | Callable[[], None]) – Callable to be invoked.

Returns:

Sketch object.

located(loc: Location) → T[source]

Create a partial copy of the sketch with a new location.

Parameters:

self (T)
loc (Location)

Return type:

T

map(f: Callable[[Shape | Location], Shape | Location])[source]

Apply a callable to every item separately.

Parameters:

self (T)
f (Callable[[Shape | Location], Shape | Location]) – Callable to be applied to every item separately.

Returns:

Sketch object with f applied to all items.

moved(loc: Location) → T[source]
moved(loc1: Location, loc2: Location, *locs: Location) → T
moved(locs: Sequence[Location]) → T
moved(x: int | float = 0, y: int | float = 0, z: int | float = 0, rx: int | float = 0, ry: int | float = 0, rz: int | float = 0) → T
moved(loc: Vector | Tuple[int | float, int | float] | Tuple[int | float, int | float, int | float]) → T
moved(loc1: Vector | Tuple[int | float, int | float] | Tuple[int | float, int | float, int | float], loc2: Vector | Tuple[int | float, int | float] | Tuple[int | float, int | float, int | float], *locs: Vector | Tuple[int | float, int | float] | Tuple[int | float, int | float, int | float]) → T
moved(loc: Sequence[Vector | Tuple[int | float, int | float] | Tuple[int | float, int | float, int | float]]) → T: Create a partial copy of the sketch with moved _faces.

offset(d: int | float, mode: Literal['a', 's', 'i', 'c', 'r'] = 'a', tag: str | None = None) → T[source]

Offset selected wires or edges.

Parameters:

self (T)
d (int | float)
mode (Literal['a', 's', 'i', 'c', 'r'])
tag (str | None)

Return type:

T

parray(r: int | float, a1: int | float, da: int | float, n: int, rotate: bool = True) → T[source]

Generate a polar array of locations.

Parameters:

self (T)
r (int | float)
a1 (int | float)
da (int | float)
n (int)
rotate (bool)

Return type:

T

Construct a polygonal face.

Parameters:

self (T)
pts (Iterable[Vector | Tuple[int | float, int | float]])
angle (int | float)
mode (Literal['a', 's', 'i', 'c', 'r'])
tag (str | None)

Return type:

T

Set current selection to given locations or points.

Parameters:

self (T)
locs (Iterable[Location | Vector | Tuple[int | float, int | float]])
tag (str | None)

Return type:

T

rarray(xs: int | float, ys: int | float, nx: int, ny: int) → T[source]

Generate a rectangular array of locations.

Parameters:

self (T)
xs (int | float)
ys (int | float)
nx (int)
ny (int)

Return type:

T

rect(w: int | float, h: int | float, angle: int | float = 0, mode: Literal['a', 's', 'i', 'c', 'r'] = 'a', tag: str | None = None) → T[source]

Construct a rectangular face.

Parameters:

self (T)
w (int | float)
h (int | float)
angle (int | float)
mode (Literal['a', 's', 'i', 'c', 'r'])
tag (str | None)

Return type:

T

regularPolygon(r: int | float, n: int, angle: int | float = 0, mode: Literal['a', 's', 'i', 'c', 'r'] = 'a', tag: str | None = None) → T[source]

Construct a regular polygonal face.

Parameters:

self (T)
r (int | float)
n (int)
angle (int | float)
mode (Literal['a', 's', 'i', 'c', 'r'])
tag (str | None)

Return type:

T

replace() → T[source]

Replace the underlying faces with the selection.

Parameters:: self (T)
Return type:: T

reset() → T[source]

Reset current selection.

Parameters:: self (T)
Return type:: T

segment(p2: Vector | Tuple[int | float, int | float], tag: str | None = None, forConstruction: bool = False) → T[source]

segment(l: int | float, a: int | float, tag: str | None = None, forConstruction: bool = False) → T

Construct a segment.

Parameters:

self (T)
p1 (Vector | Tuple[int | float, int | float])
p2 (Vector | Tuple[int | float, int | float])
tag (str | None)
forConstruction (bool)

Return type:

T

select(*tags: str) → T[source]

Select based on tags.

Parameters:

self (T)
tags (str)

Return type:

T

slot(w: int | float, h: int | float, angle: int | float = 0, mode: Literal['a', 's', 'i', 'c', 'r'] = 'a', tag: str | None = None) → T[source]

Construct a slot-shaped face.

Parameters:

self (T)
w (int | float)
h (int | float)
angle (int | float)
mode (Literal['a', 's', 'i', 'c', 'r'])
tag (str | None)

Return type:

T

solve() → T[source]

Solve current constraints and update edge positions.

Parameters:: self (T)
Return type:: T

sort(key: Callable[[Shape | Location], Any]) → T[source]

Sort items using a callable.

Parameters:

self (T)
key (Callable[[Shape | Location], Any]) – Callable to be used for sorting.

Returns:

Sketch object with items sorted.

Return type:

T

spline(pts: Iterable[Vector | Tuple[int | float, int | float]], tag: str | None = None, forConstruction: bool = False) → T

Construct a spline edge.

Parameters:

self (T)
pts (Iterable[Vector | Tuple[int | float, int | float]])
tangents (Iterable[Vector | Tuple[int | float, int | float]] | None)
periodic (bool)
tag (str | None)
forConstruction (bool)

Return type:

T

subtract() → T[source]

Subtract selection from the underlying faces.

Parameters:: self (T)
Return type:: T

tag(tag: str) → T[source]

Tag current selection.

Parameters:

self (T)
tag (str)

Return type:

T

Construct a trapezoidal face.

Parameters:

self (T)
w (int | float)
h (int | float)
a1 (int | float)
a2 (float | None)
angle (int | float)
mode (Literal['a', 's', 'i', 'c', 'r'])
tag (str | None)

Return type:

T

val() → Shape | Location[source]

Return the first selected item, underlying compound or first edge.

Parameters:: self (T)
Return type:: Shape | Location

vals() → List[Shape | Location][source]

Return all selected items, underlying compound or all edges.

Parameters:: self (T)
Return type:: List[Shape | Location]

vertices(s: str | Selector | None = None, tag: str | None = None) → T[source]

Select vertices.

Parameters:

self (T)
s (str | Selector | None)
tag (str | None)

Return type:

T

wires(s: str | Selector | None = None, tag: str | None = None) → T[source]

Select wires.

Parameters:

self (T)
s (str | Selector | None)
tag (str | None)

Return type:

T

class cadquery.Solid(obj: TopoDS_Shape)[source]

Bases: Shape, Mixin3D

a single solid

Parameters:: obj (TopoDS_Shape)

addCavity(*shells: Shell | Solid) → Self[source]

Add one or more cavities.

Parameters:: shells (Shell | Solid)
Return type:: Self

Attempt to extrude the list of wires into a prismatic solid in the provided direction

Parameters:

outerWire (Wire) – the outermost wire
innerWires (List[Wire]) – a list of inner wires
vecNormal (Vector | Tuple[int | float, int | float] | Tuple[int | float, int | float, int | float]) – a vector along which to extrude the wires
taper (float | int) – taper angle, default=0

Returns:

a Solid object

Return type:

The wires must not intersect

Extruding wires is very non-trivial. Nested wires imply very different geometry, and there are many geometries that are invalid. In general, the following conditions must be met:

all wires must be closed
there cannot be any intersecting or self-intersecting wires
wires must be listed from outside in
more than one levels of nesting is not supported reliably

This method will attempt to sort the wires, but there is much work remaining to make this method reliable.

Creates a ‘twisted prism’ by extruding, while simultaneously rotating around the extrusion vector.

Though the signature may appear to be similar enough to extrudeLinear to merit combining them, the construction methods used here are different enough that they should be separate.

At a high level, the steps followed are:

accept a set of wires
create another set of wires like this one, but which are transformed and rotated
create a ruledSurface between the sets of wires
create a shell and compute the resulting object

Parameters:

outerWire (Wire) – the outermost wire
innerWires (List[Wire]) – a list of inner wires
vecCenter (Vector | Tuple[int | float, int | float] | Tuple[int | float, int | float, int | float]) – the center point about which to rotate. the axis of rotation is defined by vecNormal, located at vecCenter.
vecNormal (Vector | Tuple[int | float, int | float] | Tuple[int | float, int | float, int | float]) – a vector along which to extrude the wires
angleDegrees (float | int) – the angle to rotate through while extruding

Returns:

a Solid object

Return type:

innerShells() → List[Shell][source]

Returns inner shells.

Return type:: List[Shell]

classmethod interpPlate(surf_edges, surf_pts, thickness, degree=3, nbPtsOnCur=15, nbIter=2, anisotropy=False, tol2d=1e-05, tol3d=0.0001, tolAng=0.01, tolCurv=0.1, maxDeg=8, maxSegments=9) → Solid | Face[source]

Returns a plate surface that is ‘thickness’ thick, enclosed by ‘surf_edge_pts’ points, and going through ‘surf_pts’ points.

Parameters:

surf_edges – list of [x,y,z] float ordered coordinates or list of ordered or unordered wires
surf_pts – list of [x,y,z] float coordinates (uses only edges if [])
thickness – thickness may be negative or positive depending on direction, (returns 2D surface if 0)
degree – >=2
nbPtsOnCur – number of points on curve >= 15
nbIter – number of iterations >= 2
anisotropy – bool Anisotropy
tol2d – 2D tolerance >0
tol3d – 3D tolerance >0
tolAng – angular tolerance
tolCurv – tolerance for curvature >0
maxDeg – highest polynomial degree >= 2
maxSegments – greatest number of segments >= 2

Return type:

Solid | Face

static isSolid(obj: Shape) → bool[source]

Returns true if the object is a solid, false otherwise

Parameters:: obj (Shape)
Return type:: bool

classmethod makeBox(length,width,height,[pnt,dir]) -- Make a box located in pnt with the dimensions (length,width,height)[source]

By default pnt=Vector(0,0,0) and dir=Vector(0,0,1)

Parameters:

length (float)
width (float)
height (float)
pnt (Vector | Tuple[int | float, int | float] | Tuple[int | float, int | float, int | float])
dir (Vector | Tuple[int | float, int | float] | Tuple[int | float, int | float, int | float])

Return type:

Make a cone with given radii and height By default pnt=Vector(0,0,0), dir=Vector(0,0,1) and angle=360

Parameters:

radius1 (float)
radius2 (float)
height (float)
pnt (Vector | Tuple[int | float, int | float] | Tuple[int | float, int | float, int | float])
dir (Vector | Tuple[int | float, int | float] | Tuple[int | float, int | float, int | float])
angleDegrees (float)

Return type:

makeCylinder(radius,height,[pnt,dir,angle]) – Make a cylinder with a given radius and height By default pnt=Vector(0,0,0),dir=Vector(0,0,1) and angle=360

Parameters:

radius (float)
height (float)
pnt (Vector | Tuple[int | float, int | float] | Tuple[int | float, int | float, int | float])
dir (Vector | Tuple[int | float, int | float] | Tuple[int | float, int | float, int | float])
angleDegrees (float)

Return type:

classmethod makeLoft(listOfWire: List[Wire], ruled: bool = False) → Solid[source]

makes a loft from a list of wires The wires will be converted into faces when possible– it is presumed that nobody ever actually wants to make an infinitely thin shell for a real FreeCADPart.

Parameters:

listOfWire (List[Wire])
ruled (bool)

Return type:

classmethod makeSolid(shell: Shell) → Solid[source]

Makes a solid from a single shell.

Parameters:: shell (Shell)
Return type:: Solid

Make a sphere with a given radius By default pnt=Vector(0,0,0), dir=Vector(0,0,1), angle1=0, angle2=90 and angle3=360

Parameters:

radius (float)
pnt (Vector | Tuple[int | float, int | float] | Tuple[int | float, int | float, int | float])
dir (Vector | Tuple[int | float, int | float] | Tuple[int | float, int | float, int | float])
angleDegrees1 (float)
angleDegrees2 (float)
angleDegrees3 (float)

Return type:

makeTorus(radius1,radius2,[pnt,dir,angle1,angle2,angle]) – Make a torus with a given radii and angles By default pnt=Vector(0,0,0),dir=Vector(0,0,1),angle1=0 ,angle1=360 and angle=360

Parameters:

radius1 (float)
radius2 (float)
pnt (Vector | Tuple[int | float, int | float] | Tuple[int | float, int | float, int | float])
dir (Vector | Tuple[int | float, int | float] | Tuple[int | float, int | float, int | float])
angleDegrees1 (float)
angleDegrees2 (float)

Return type:

Make a wedge located in pnt By default pnt=Vector(0,0,0) and dir=Vector(0,0,1)

Parameters:

dx (float)
dy (float)
dz (float)
xmin (float)
zmin (float)
xmax (float)
zmax (float)
pnt (Vector | Tuple[int | float, int | float] | Tuple[int | float, int | float, int | float])
dir (Vector | Tuple[int | float, int | float] | Tuple[int | float, int | float, int | float])

Return type:

outerShell() → Shell[source]

Returns outer shell.

Return type:: Shell

Attempt to revolve the list of wires into a solid in the provided direction

Parameters:

outerWire (Wire) – the outermost wire
innerWires (List[Wire]) – a list of inner wires
angleDegrees (float, anything less than 360 degrees will leave the shape open) – the angle to revolve through.
axisStart (Vector | Tuple[int | float, int | float] | Tuple[int | float, int | float, int | float]) – the start point of the axis of rotation
axisEnd (Vector | Tuple[int | float, int | float] | Tuple[int | float, int | float, int | float]) – the end point of the axis of rotation

Returns:

a Solid object

Return type:

The wires must not intersect

all wires must be closed
there cannot be any intersecting or self-intersecting wires
wires must be listed from outside in
more than one levels of nesting is not supported reliably
the wire(s) that you’re revolving cannot be centered

This method will attempt to sort the wires, but there is much work remaining to make this method reliable.

classmethod sweep(outerWire: Wire, innerWires: List[Wire], path: Wire | Edge, makeSolid: bool = True, isFrenet: bool = False, mode: Vector | Wire | Edge | None = None, transitionMode: Literal['transformed', 'round', 'right'] = 'transformed') → Shape[source]

classmethod sweep(face: Face, path: Wire | Edge, makeSolid: bool = True, isFrenet: bool = False, mode: Vector | Wire | Edge | None = None, transitionMode: Literal['transformed', 'round', 'right'] = 'transformed') → Shape

Attempt to sweep the list of wires into a prismatic solid along the provided path

Parameters:

outerWire (Wire) – the outermost wire
innerWires (List[Wire]) – a list of inner wires
path (Wire | Edge) – The wire to sweep the face resulting from the wires over
makeSolid (bool) – return Solid or Shell (default True)
isFrenet (bool) – Frenet mode (default False)
mode (Vector | Wire | Edge | None) – additional sweep mode parameters
transitionMode (Literal['transformed', 'round', 'right']) – handling of profile orientation at C1 path discontinuities. Possible values are {‘transformed’,’round’, ‘right’} (default: ‘right’).

Returns:

a Solid object

Return type:

Multi section sweep. Only single outer profile per section is allowed.

Parameters:

profiles (Iterable[Wire | Face]) – list of profiles
path (Wire | Edge) – The wire to sweep the face resulting from the wires over
mode (Vector | Wire | Edge | None) – additional sweep mode parameters.
makeSolid (bool)
isFrenet (bool)

Returns:

a Solid object

Return type:

class cadquery.StringSyntaxSelector(selectorString)[source]

Bases: Selector

Filter lists objects using a simple string syntax. All of the filters available in the string syntax are also available ( usually with more functionality ) through the creation of full-fledged selector objects. see Selector and its subclasses

Filtering works differently depending on the type of object list being filtered.

Parameters:: selectorString – A two-part selector string, [selector][axis]
Returns:: objects that match the specified selector

*Modifiers* are ('|','+','-','<','>','%')

|:

parallel to ( same as ParallelDirSelector ). Can return multiple objects.

#:

perpendicular to (same as PerpendicularDirSelector )

+:

positive direction (same as DirectionSelector )

-:

negative direction (same as DirectionSelector )

>:

maximize (same as DirectionMinMaxSelector with directionMax=True)

<:

minimize (same as DirectionMinMaxSelector with directionMax=False )

%:

curve/surface type (same as TypeSelector)

*axisStrings* are: X,Y,Z,XY,YZ,XZ or (x,y,z) which defines an arbitrary direction

It is possible to combine simple selectors together using logical operations. The following operations are supported

and:

Logical AND, e.g. >X and >Y

or:

Logical OR, e.g. |X or |Y

not:

Logical NOT, e.g. not #XY

exc(ept):

Set difference (equivalent to AND NOT): |X exc >Z

Finally, it is also possible to use even more complex expressions with nesting and arbitrary number of terms, e.g.

(not >X[0] and #XY) or >XY[0]

Selectors are a complex topic: see Selectors Reference for more information

__init__(selectorString)[source]: Feed the input string through the parser and construct an relevant complex selector object

filter(objectList: Sequence[Shape])[source]

Filter give object list through th already constructed complex selector object

Parameters:: objectList (Sequence[Shape])

class cadquery.TypeSelector(typeString: str)[source]

Bases: Selector

Selects objects having the prescribed geometry type.

Applicability:: Faces: PLANE, CYLINDER, CONE, SPHERE, TORUS, BEZIER, BSPLINE, REVOLUTION, EXTRUSION, OFFSET, OTHER Edges: LINE, CIRCLE, ELLIPSE, HYPERBOLA, PARABOLA, BEZIER, BSPLINE, OFFSET, OTHER

You can use the string selector syntax. For example this:

CQ(aCube).faces(TypeSelector("PLANE"))

will select 6 faces, and is equivalent to:

CQ(aCube).faces("%PLANE")

Parameters:: typeString (str)

__init__(typeString: str)[source]

Parameters:: typeString (str)

filter(objectList: Sequence[Shape]) → List[Shape][source]

Filter the provided list.

The default implementation returns the original list unfiltered.

Parameters:: objectList (list of OCCT primitives) – list to filter
Returns:: filtered list
Return type:: List[Shape]

class cadquery.Vector(x: float, y: float, z: float)[source]

class cadquery.Vector(x: float, y: float)

class cadquery.Vector(v: Vector)

class cadquery.Vector(v: Sequence[float])

class cadquery.Vector(v: gp_Vec | gp_Pnt | gp_Dir | gp_XYZ)

class cadquery.Vector

Bases: object

Create a 3-dimensional vector

Parameters:: args – a 3D vector, with x-y-z parts.

you can either provide:

nothing (in which case the null vector is return)
a gp_Vec
a vector ( in which case it is copied )
a 3-tuple
a 2-tuple (z assumed to be 0)
three float values: x, y, and z
two float values: x,y

Center() → Vector[source]

Return the vector itself

The center of myself is myself. Provided so that vectors, vertices, and other shapes all support a common interface, when Center() is requested for all objects on the stack.

Return type:: Vector

__eq__(other: Vector) → bool[source]

Return self==value.

Parameters:: other (Vector)
Return type:: bool

__getstate__() → tuple[float, float, float][source]

Helper for pickle.

Return type:: tuple[float, float, float]

__hash__ = None

__init__(x: float, y: float, z: float) → None[source]
__init__(x: float, y: float) → None
__init__(v: Vector) → None
__init__(v: Sequence[float]) → None
__init__(v: gp_Vec | gp_Pnt | gp_Dir | gp_XYZ) → None
__init__() → None

__repr__() → str[source]

Return repr(self).

Return type:: str

__str__() → str[source]

Return str(self).

Return type:: str

__weakref__: list of weak references to the object (if defined)

multiply(scale: float) → Vector[source]

Return a copy multiplied by the provided scalar

Parameters:: scale (float)
Return type:: Vector

normalized() → Vector[source]

Return a normalized version of this vector

Return type:: Vector

projectToLine(line: Vector) → Vector[source]

Returns a new vector equal to the projection of this Vector onto the line represented by Vector <line>

Parameters:

args – Vector
line (Vector)

Return type:

Returns the projected vector.

projectToPlane(plane: Plane) → Vector[source]

Vector is projected onto the plane provided as input.

Parameters:

args – Plane object
plane (Plane)

Return type:

Returns the projected vector.

class cadquery.Vertex(obj: TopoDS_Shape, forConstruction: bool = False)[source]

Bases: Shape

A Single Point in Space

Parameters:

obj (TopoDS_Shape)
forConstruction (bool)

Center() → Vector[source]

The center of a vertex is itself!

Return type:: Vector

__init__(obj: TopoDS_Shape, forConstruction: bool = False)[source]

Create a vertex

Parameters:

obj (TopoDS_Shape)
forConstruction (bool)

class cadquery.Wire(obj: TopoDS_Shape)[source]

Bases: Shape, Mixin1D

A series of connected, ordered Edges, that typically bounds a Face

Parameters:: obj (TopoDS_Shape)

Vertices() → List[Vertex][source]

Ordered list of vertices of the wire.

Return type:: List[Vertex]

__iter__() → Iterator[Edge][source]

Iterate over edges in an ordered way.

Return type:: Iterator[Edge]

classmethod assembleEdges(listOfEdges: Iterable[Edge]) → Wire[source]

Attempts to build a wire that consists of the edges in the provided list

Parameters:

cls
listOfEdges (Iterable[Edge]) – a list of Edge objects. The edges are not to be consecutive.

Returns:

a wire with the edges assembled

Return type:

BRepBuilderAPI_MakeWire::Error() values:

BRepBuilderAPI_WireDone = 0
BRepBuilderAPI_EmptyWire = 1
BRepBuilderAPI_DisconnectedWire = 2
BRepBuilderAPI_NonManifoldWire = 3

chamfer2D(d: float, vertices: Iterable[Vertex]) → Wire[source]

Apply 2D chamfer to a wire

Parameters:

d (float)
vertices (Iterable[Vertex])

Return type:

close() → Wire[source]

Close a Wire

Return type:: Wire

classmethod combine(listOfWires: Iterable[Wire | Edge], tol: float = 1e-09) → List[Wire][source]

Attempt to combine a list of wires and edges into a new wire.

Parameters:

cls
listOfWires (Iterable[Wire | Edge])
tol (float) – default 1e-9

Returns:

List[Wire]

Return type:

List[Wire]

fillet(radius: float, vertices: Iterable[Vertex] | None = None) → Wire[source]

Apply 2D or 3D fillet to a wire

Parameters:

radius (float) – the radius of the fillet, must be > zero
vertices (Iterable[Vertex] | None) – the vertices to delete (where the fillet will be applied). By default all vertices are deleted except ends of open wires.

Returns:

A wire with filleted corners

Return type:

fillet2D(radius: float, vertices: Iterable[Vertex]) → Wire[source]

Apply 2D fillet to a wire

Parameters:

radius (float)
vertices (Iterable[Vertex])

Return type:

Makes a Circle centered at the provided point, having normal in the provided direction

Parameters:

radius (float) – floating point radius of the circle, must be > 0
center (Vector | Tuple[int | float, int | float] | Tuple[int | float, int | float, int | float]) – vector representing the center of the circle
normal (Vector | Tuple[int | float, int | float] | Tuple[int | float, int | float, int | float]) – vector representing the direction of the plane the circle should lie in

Return type:

Makes an Ellipse centered at the provided point, having normal in the provided direction

Parameters:

x_radius (float) – floating point major radius of the ellipse (x-axis), must be > 0
y_radius (float) – floating point minor radius of the ellipse (y-axis), must be > 0
center (Vector | Tuple[int | float, int | float] | Tuple[int | float, int | float, int | float]) – vector representing the center of the circle
normal (Vector | Tuple[int | float, int | float] | Tuple[int | float, int | float, int | float]) – vector representing the direction of the plane the circle should lie in
angle1 (float) – start angle of arc
angle2 (float) – end angle of arc
rotation_angle (float) – angle to rotate the created ellipse / arc
xDir (Vector | Tuple[int | float, int | float] | Tuple[int | float, int | float, int | float])
closed (bool)

Return type:

Make a helix with a given pitch, height and radius By default a cylindrical surface is used to create the helix. If the fourth parameter is set (the apex given in degree) a conical surface is used instead’

Parameters:

pitch (float)
height (float)
radius (float)
center (Vector | Tuple[int | float, int | float] | Tuple[int | float, int | float, int | float])
dir (Vector | Tuple[int | float, int | float] | Tuple[int | float, int | float, int | float])
angle (float)
lefthand (bool)

Return type:

Construct a polygonal wire from points.

Parameters:

listOfVertices (Iterable[Vector | Tuple[int | float, int | float] | Tuple[int | float, int | float, int | float]])
forConstruction (bool)
close (bool)

Return type:

offset2D(d: float, kind: Literal['arc', 'intersection', 'tangent'] = 'arc') → List[Wire][source]

Offsets a planar wire

Parameters:

d (float)
kind (Literal['arc', 'intersection', 'tangent'])

Return type:

List[Wire]

stitch(other: Wire) → Wire[source]

Attempt to stitch wires

Parameters:: other (Wire)
Return type:: Wire

class cadquery.Workplane(obj: Vector | Location | Shape | Sketch)[source]

Bases: object

Defines a coordinate system in space, in which 2D coordinates can be used.

Parameters:

plane (a Plane object, or a string in (XY|YZ|XZ|front|back|top|bottom|left|right)) – the plane in which the workplane will be done
origin (a 3-tuple in global coordinates, or None to default to the origin) – the desired origin of the new workplane
obj (a CAD primitive, or None to use the centerpoint of the plane as the initial stack value.) – an object to use initially for the stack

Raises:

ValueError if the provided plane is not a plane, a valid named workplane

Returns:

A Workplane object, with coordinate system matching the supplied plane.

The most common use is:

s = Workplane("XY")

After creation, the stack contains a single point, the origin of the underlying plane, and the current point is on the origin.

Note

You can also create workplanes on the surface of existing faces using workplane()

__add__(other: Workplane | Solid | Compound) → T[source]

Syntactic sugar for union.

Notice that r = a + b is equivalent to r = a.union(b) and r = a | b.

Parameters:

self (T)
other (Workplane | Solid | Compound)

Return type:

T

__and__(other: Workplane | Solid | Compound) → T[source]

Syntactic sugar for intersect.

Notice that r = a & b is equivalent to r = a.intersect(b).

Example:

Box = Workplane("XY").box(1, 1, 1, centered=(False, False, False))
Sphere = Workplane("XY").sphere(1)
result = Box & Sphere

Parameters:

self (T)
other (Workplane | Solid | Compound)

Return type:

T

__init__(obj: Vector | Location | Shape | Sketch) → None[source]

make a workplane from a particular plane

Parameters:

inPlane (a Plane object, or a string in (XY|YZ|XZ|front|back|top|bottom|left|right)) – the plane in which the workplane will be done
origin (a 3-tuple in global coordinates, or None to default to the origin) – the desired origin of the new workplane
obj (a CAD primitive, or None to use the centerpoint of the plane as the initial stack value.) – an object to use initially for the stack

Raises:

ValueError if the provided plane is not a plane, or one of XY|YZ|XZ

Returns:

A Workplane object, with coordinate system matching the supplied plane.

The most common use is:

s = Workplane("XY")

After creation, the stack contains a single point, the origin of the underlying plane, and the current point is on the origin.

__iter__() → Iterator[Shape][source]

Special method for iterating over Shapes in objects

Parameters:: self (T)
Return type:: Iterator[Shape]

__mul__(other: Workplane | Solid | Compound) → T[source]

Syntactic sugar for intersect.

Notice that r = a * b is equivalent to r = a.intersect(b).

Example:

Box = Workplane("XY").box(1, 1, 1, centered=(False, False, False))
Sphere = Workplane("XY").sphere(1)
result = Box * Sphere

Parameters:

self (T)
other (Workplane | Solid | Compound)

Return type:

T

__or__(other: Workplane | Solid | Compound) → T[source]

Syntactic sugar for union.

Notice that r = a | b is equivalent to r = a.union(b) and r = a + b.

Example:

Box = Workplane("XY").box(1, 1, 1, centered=(False, False, False))
Sphere = Workplane("XY").sphere(1)
result = Box | Sphere

Parameters:

self (T)
other (Workplane | Solid | Compound)

Return type:

T

__sub__(other: Workplane | Solid | Compound) → T[source]

Syntactic sugar for cut.

Notice that r = a - b is equivalent to r = a.cut(b).

Example:

Box = Workplane("XY").box(1, 1, 1, centered=(False, False, False))
Sphere = Workplane("XY").sphere(1)
result = Box - Sphere

Parameters:

self (T)
other (Workplane | Solid | Compound)

Return type:

T

__truediv__(other: Workplane | Solid | Compound) → T[source]

Syntactic sugar for intersect.

Notice that r = a / b is equivalent to r = a.split(b).

Example:

Box = Workplane("XY").box(1, 1, 1, centered=(False, False, False))
Sphere = Workplane("XY").sphere(1)
result = Box / Sphere

Parameters:

self (T)
other (Workplane | Solid | Compound)

Return type:

T

__weakref__: list of weak references to the object (if defined)

add(obj: Workplane) → T[source]

add(obj: Vector | Location | Shape | Sketch) → T

add(obj: Iterable[Vector | Location | Shape | Sketch]) → T

Adds an object or a list of objects to the stack

Parameters:: obj (a Workplane, CAD primitive, or list of CAD primitives) – an object to add
Returns:: a Workplane with the requested operation performed

If a Workplane object, the values of that object’s stack are added. If a list of cad primitives, they are all added. If a single CAD primitive then it is added.

Used in rare cases when you need to combine the results of several CQ results into a single Workplane object.

all() → List[T][source]

Return a list of all CQ objects on the stack.

useful when you need to operate on the elements individually.

Contrast with vals, which returns the underlying objects for all of the items on the stack

Parameters:: self (T)
Return type:: List[T]

ancestors(kind: Literal['Vertex', 'Edge', 'Wire', 'Face', 'Shell', 'Solid', 'CompSolid', 'Compound'], tag: str | None = None) → T[source]

Select topological ancestors.

Parameters:

self (T)
kind (Literal['Vertex', 'Edge', 'Wire', 'Face', 'Shell', 'Solid', 'CompSolid', 'Compound']) – kind of ancestor, e.g. “Face” or “Edge”
tag (str | None) – if set, search the tagged object instead of self

Returns:

a Workplane object whose stack contains selected ancestors.

Return type:

T

Apply a callable to all items at once.

Parameters:

self (T)
f (Callable[[Iterable[Vector | Location | Shape | Sketch]], Iterable[Vector | Location | Shape | Sketch]]) – Callable to be applied.

Returns:

Workplane object with f applied to all items.

Return type:

T

bezier(listOfXYTuple: Iterable[Tuple[float, float] | Tuple[float, float, float] | Vector], forConstruction: bool = False, includeCurrent: bool = False, makeWire: bool = False) → T[source]

Make a cubic Bézier curve by the provided points (2D or 3D).

Parameters:

self (T)
listOfXYTuple (Iterable[Tuple[float, float] | Tuple[float, float, float] | Vector]) – Bezier control points and end point. All points except the last point are Bezier control points, and the last point is the end point
includeCurrent (bool) – Use the current point as a starting point of the curve
makeWire (bool) – convert the resulting bezier edge to a wire
forConstruction (bool)

Returns:

a Workplane object with the current point at the end of the bezier

Return type:

T

The Bézier Will begin at either current point or the first point of listOfXYTuple, and end with the last point of listOfXYTuple

box(length: float, width: float, height: float, centered: bool | Tuple[bool, bool, bool] = True, combine: bool | Literal['cut', 'a', 's'] = True, clean: bool = True) → T[source]

Return a 3d box with specified dimensions for each object on the stack.

Parameters:

self (T)
length (float) – box size in X direction
width (float) – box size in Y direction
height (float) – box size in Z direction
centered (bool | Tuple[bool, bool, bool]) – If True, the box will be centered around the reference point. If False, the corner of the box will be on the reference point and it will extend in the positive x, y and z directions. Can also use a 3-tuple to specify centering along each axis.
combine (bool | Literal['cut', 'a', 's']) – should the results be combined with other solids on the stack (and each other)?
clean (bool) – call clean() afterwards to have a clean shape

Return type:

T

One box 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 boxes produced fused onto it otherwise, the result is the combination of all the produced boxes.

If combine is false, the result will be a list of the boxes produced.

Most often boxes form the basis for a part:

# make a single box with lower left corner at origin
s = Workplane().box(1, 2, 3, centered=False)

But sometimes it is useful to create an array of them:

# create 4 small square bumps on a larger base plate:
s = (
    Workplane()
    .box(4, 4, 0.5)
    .faces(">Z")
    .workplane()
    .rect(3, 3, forConstruction=True)
    .vertices()
    .box(0.25, 0.25, 0.25, combine=True)
)

cboreHole(diameter: float, cboreDiameter: float, cboreDepth: float, depth: float | None = None, clean: bool = True) → T[source]

Makes a counterbored hole for each item on the stack.

Parameters:

self (T)
diameter (float) – the diameter of the hole
cboreDiameter (float) – the diameter of the cbore, must be greater than hole diameter
cboreDepth (float > 0) – depth of the counterbore
depth (float > 0 or None to drill thru the entire part) – the depth of the hole
clean (bool) – call clean() afterwards to have a clean shape

Return type:

T

The surface of the hole is at the current workplane plane.

One hole is created for each item on the stack. A very common use case is to use a construction rectangle to define the centers of a set of holes, like so:

s = (
    Workplane()
    .box(2, 4, 0.5)
    .faces(">Z")
    .workplane()
    .rect(1.5, 3.5, forConstruction=True)
    .vertices()
    .cboreHole(0.125, 0.25, 0.125, depth=None)
)

This sample creates a plate with a set of holes at the corners.

Plugin Note: this is one example of the power of plugins. Counterbored holes are quite time consuming to create, but are quite easily defined by users.

see cskHole() to make countersinks instead of counterbores

center(x: float, y: float) → T[source]

Shift local coordinates to the specified location.

The location is specified in terms of local coordinates.

Parameters:

self (T)
x (float) – the new x location
y (float) – the new y location

Returns:

the Workplane object, with the center adjusted.

Return type:

T

The current point is set to the new center. This method is useful to adjust the center point after it has been created automatically on a face, but not where you’d like it to be.

In this example, we adjust the workplane center to be at the corner of a cube, instead of the center of a face, which is the default:

# this workplane is centered at x=0.5,y=0.5, the center of the upper face
s = Workplane().box(1, 1, 1).faces(">Z").workplane()

s = s.center(-0.5, -0.5)  # move the center to the corner
t = s.circle(0.25).extrude(0.2)
assert t.faces().size() == 9  # a cube with a cylindrical nub at the top right corner

The result is a cube with a round boss on the corner

chamfer(length: float, length2: float | None = None) → T[source]

Chamfers a solid on the selected edges.

The edges on the stack are chamfered. The solid to which the edges belong must be in the parent chain of the selected edges.

Optional parameter length2 can be supplied with a different value than length for a chamfer that is shorter on one side longer on the other side.

Parameters:

self (T)
length (float) – the length of the chamfer, must be greater than zero
length2 (float | None) – optional parameter for asymmetrical chamfer

Raises:

ValueError – if at least one edge is not selected
ValueError – if the solid containing the edge is not in the chain

Returns:

CQ object with the resulting solid selected.

Return type:

T

This example will create a unit cube, with the top edges chamfered:

s = Workplane("XY").box(1, 1, 1).faces("+Z").chamfer(0.1)

This example will create chamfers longer on the sides:

s = Workplane("XY").box(1, 1, 1).faces("+Z").chamfer(0.2, 0.1)

circle(radius: float, forConstruction: bool = False) → T[source]

Make a circle for each item on the stack.

Parameters:

self (T)
radius (float) – radius of the circle
forConstruction (true if the wires are for reference, false if they are creating part geometry) – should the new wires be reference geometry only?

Returns:

a new CQ object with the created wires on the stack

Return type:

T

A common use case is to use a for-construction rectangle to define the centers of a hole pattern:

s = Workplane().rect(4.0, 4.0, forConstruction=True).vertices().circle(0.25)

Creates 4 circles at the corners of a square centered on the origin. Another common case is to use successive circle() calls to create concentric circles. This works because the center of a circle is its reference point:

s = Workplane().circle(2.0).circle(1.0)

Creates two concentric circles, which when extruded will form a ring.

Future Enhancements:: better way to handle forConstruction project points not in the workplane plane onto the workplane plane

clean() → T[source]

Cleans the current solid by removing unwanted edges from the faces.

Normally you don’t have to call this function. It is automatically called after each related operation. You can disable this behavior with clean=False parameter if method has any. In some cases this can improve performance drastically but is generally dis-advised since it may break some operations such as fillet.

Note that in some cases where lots of solid operations are chained, clean() may actually improve performance since the shape is ‘simplified’ at each step and thus next operation is easier.

Also note that, due to limitation of the underlying engine, clean may fail to produce a clean output in some cases such as spherical faces.

Parameters:: self (T)
Return type:: T

close() → T[source]

End construction, and attempt to build a closed wire.

Returns:: a CQ object with a completed wire on the stack, if possible.
Parameters:: self (T)
Return type:: T

After 2D (or 3D) drafting with methods such as lineTo, threePointArc, tangentArcPoint and polyline, it is necessary to convert the edges produced by these into one or more wires.

When a set of edges is closed, CadQuery assumes it is safe to build the group of edges into a wire. This example builds a simple triangular prism:

s = Workplane().lineTo(1, 0).lineTo(1, 1).close().extrude(0.2)

combine(clean: bool = True, glue: bool = False, tol: float | None = None) → T[source]

Attempts to combine all of the items on the stack into a single item.

WARNING: all of the items must be of the same type!

Parameters:

self (T)
clean (bool) – call clean() afterwards to have a clean shape
glue (bool) – use a faster gluing mode for non-overlapping shapes (default False)
tol (float | None) – tolerance value for fuzzy bool operation mode (default None)

Raises:

ValueError if there are no items on the stack, or if they cannot be combined

Returns:

a CQ object with the resulting object selected

Return type:

T

combineSolids(otherCQToCombine: Workplane | None = None) → Workplane[source]

!!!DEPRECATED!!! use union() Combines all solids on the current stack, and any context object, together into a single object.

After the operation, the returned solid is also the context solid.

Parameters:: otherCQToCombine (Workplane | None) – another CadQuery to combine.
Returns:: a CQ object with the resulting combined solid on the stack.
Return type:: Workplane

Most of the time, both objects will contain a single solid, which is combined and returned on the stack of the new object.

compounds(selector: str | Selector | None = None, tag: str | None = None) → T[source]

Select compounds on the stack, optionally filtering the selection. If there are multiple objects on the stack, they are collected and a list of all the distinct compounds is returned.

Parameters:

self (T)
selector (str | Selector | None) – optional Selector object, or string selector expression (see StringSyntaxSelector)
tag (str | None) – if set, search the tagged object instead of self

Returns:

a CQ object whose stack contains all of the distinct compounds of all objects on the current stack, filtered by the provided selector.

Return type:

T

A compound contains multiple CAD primitives that resulted from a single operation, such as a union, cut, split, or fillet. Compounds can contain multiple edges, wires, or solids.

consolidateWires() → T[source]

Attempt to consolidate wires on the stack into a single. If possible, a new object with the results are returned. if not possible, the wires remain separated

Parameters:: self (T)
Return type:: T

copyWorkplane(obj: T) → T[source]

Copies the workplane from obj.

Parameters:: obj (a CQ object) – an object to copy the workplane from
Returns:: a CQ object with obj’s workplane
Return type:: T

cskHole(diameter: float, cskDiameter: float, cskAngle: float, depth: float | None = None, clean: bool = True) → T[source]

Makes a countersunk hole for each item on the stack.

Parameters:

self (T)
diameter (float > 0) – the diameter of the hole
cskDiameter (float) – the diameter of the countersink, must be greater than hole diameter
cskAngle (float > 0) – angle of the countersink, in degrees ( 82 is common )
depth (float > 0 or None to drill thru the entire part.) – the depth of the hole
clean (bool) – call clean() afterwards to have a clean shape

Return type:

T

The surface of the hole is at the current workplane.

One hole is created for each item on the stack. A very common use case is to use a construction rectangle to define the centers of a set of holes, like so:

s = (
    Workplane()
    .box(2, 4, 0.5)
    .faces(">Z")
    .workplane()
    .rect(1.5, 3.5, forConstruction=True)
    .vertices()
    .cskHole(0.125, 0.25, 82, depth=None)
)

This sample creates a plate with a set of holes at the corners.

Plugin Note: this is one example of the power of plugins. CounterSunk holes are quite time consuming to create, but are quite easily defined by users.

see cboreHole() to make counterbores instead of countersinks

cut(toCut: Workplane | Solid | Compound, clean: bool = True, tol: float | None = None) → T[source]

Cuts the provided solid from the current solid, IE, perform a solid subtraction.

Parameters:

self (T)
toCut (Workplane | Solid | Compound) – a solid object, or a Workplane object having a solid
clean (bool) – call clean() afterwards to have a clean shape
tol (float | None) – tolerance value for fuzzy bool operation mode (default None)

Raises:

ValueError – if there is no solid to subtract from in the chain

Returns:

a Workplane object with the resulting object selected

Return type:

T

cutBlind(until: float | Literal['next', 'last'] | Face, clean: bool = True, both: bool = False, taper: float | None = None) → T[source]

Use all un-extruded wires in the parent chain to create a prismatic cut from existing solid.

Specify either a distance value, or one of “next”, “last” to indicate a face to cut to.

Similar to extrude, except that a solid in the parent chain is required to remove material from. cutBlind always removes material from a part.

Parameters:

self (T)
until (float | Literal['next', 'last'] | ~cadquery.occ_impl.shapes.Face) – The distance to cut to, normal to the workplane plane. When a negative float is passed the cut extends this far in the opposite direction to the normal of the plane (i.e in the solid). The string “next” cuts until the next face orthogonal to the wire normal. “last” cuts to the last face. If an object of type Face is passed, then the cut will extend until this face.
clean (bool) – call clean() afterwards to have a clean shape
both (bool) – cut in both directions symmetrically
taper (float | None) – angle for optional tapered extrusion

Raises:

ValueError – if there is no solid to subtract from in the chain

Returns:

a CQ object with the resulting object selected

Return type:

T

see cutThruAll() to cut material from the entire part

cutEach(fcn: Callable[[Location], Shape], useLocalCoords: bool = False, clean: bool = True) → T[source]

Evaluates the provided function at each point on the stack (ie, eachpoint) and then cuts the result from the context solid.

Parameters:

self (T)
fcn (Callable[[Location], Shape]) – a function suitable for use in the eachpoint method: ie, that accepts a vector
useLocalCoords (bool) – same as for eachpoint()
clean (bool) – call clean() afterwards to have a clean shape

Raises:

ValueError – if no solids or compounds are found in the stack or parent chain

Returns:

a CQ object that contains the resulting solid

Return type:

T

cutThruAll(clean: bool = True, taper: float = 0) → T[source]

Use all un-extruded wires in the parent chain to create a prismatic cut from existing solid. Cuts through all material in both normal directions of workplane.

Similar to extrude, except that a solid in the parent chain is required to remove material from. cutThruAll always removes material from a part.

Parameters:

self (T)
clean (bool) – call clean() afterwards to have a clean shape
taper (float)

Raises:

ValueError – if there is no solid to subtract from in the chain
ValueError – if there are no pending wires to cut with

Returns:

a CQ object with the resulting object selected

Return type:

T

see cutBlind() to cut material to a limited depth

cylinder(height: float, radius: float, direct: ~typing.Tuple[float, float, float] | ~cadquery.occ_impl.geom.Vector = Vector: (0.0, 0.0, 1.0), angle: float = 360, centered: bool | ~typing.Tuple[bool, bool, bool] = True, combine: bool | ~typing.Literal['cut', 'a', 's'] = True, clean: bool = True) → T[source]

Returns a cylinder with the specified radius and height for each point on the stack

Parameters:

self (T)
height (float) – The height of the cylinder
radius (float) – The radius of the cylinder
direct (A three-tuple) – The direction axis for the creation of the cylinder
angle (float > 0) – The angle to sweep the cylinder arc through
centered (bool | Tuple[bool, bool, bool]) – If True, the cylinder will be centered around the reference point. If False, the corner of a bounding box around the cylinder will be on the reference point and it will extend in the positive x, y and z directions. Can also use a 3-tuple to specify centering along each axis.
combine (true to combine shapes, false otherwise) – Whether the results should be combined with other solids on the stack (and each other)
clean (bool) – call clean() afterwards to have a clean shape

Returns:

A cylinder object for each point on the stack

Return type:

T

One cylinder is created for each item on the current stack. If no items are on the stack, one cylinder is created using the current workplane center.

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 cylinders produced fused onto it otherwise, the result is the combination of all the produced cylinders.

If combine is false, the result will be a list of the cylinders produced.

each(callback: Callable[[Vector | Location | Shape | Sketch], Shape], useLocalCoordinates: bool = False, combine: bool | Literal['cut', 'a', 's'] = True, clean: bool = True) → T[source]

Runs the provided function on each value in the stack, and collects the return values into a new CQ object.

Special note: a newly created workplane always has its center point as its only stack item

Parameters:

self (T)
callBackFunction – the function to call for each item on the current stack.
useLocalCoordinates (bool) – should values be converted from local coordinates first?
combine (bool | Literal['cut', 'a', 's']) – True or “a” to combine the resulting solid with parent solids if found, “cut” or “s” to remove the resulting solid from the parent solids if found. False to keep the resulting solid separated from the parent solids.
clean (bool) – call clean() afterwards to have a clean shape
callback (Callable[[Vector | Location | Shape | Sketch], Shape])

Return type:

T

The callback function must accept one argument, which is the item on the stack, and return one object, which is collected. If the function returns None, nothing is added to the stack. The object passed into the callBackFunction is potentially transformed to local coordinates, if useLocalCoordinates is true

useLocalCoordinates is very useful for plugin developers.

If false, the callback function is assumed to be working in global coordinates. Objects created are added as-is, and objects passed into the function are sent in using global coordinates

If true, the calling function is assumed to be working in local coordinates. Objects are transformed to local coordinates before they are passed into the callback method, and result objects are transformed to global coordinates after they are returned.

This allows plugin developers to create objects in local coordinates, without worrying about the fact that the working plane is different than the global coordinate system.

TODO: wrapper object for Wire will clean up forConstruction flag everywhere

eachpoint(arg: Shape | Workplane | Callable[[Location], Shape], useLocalCoordinates: bool = False, combine: bool | Literal['cut', 'a', 's'] = False, clean: bool = True) → T[source]

Same as each(), except arg is translated by the positions on the stack. If arg is a callback function, then the function is called for each point on the stack, and the resulting shape is used. :return: CadQuery object which contains a list of vectors (points ) on its stack.

Parameters:

self (T)
useLocalCoordinates (bool) – should points be in local or global coordinates
combine (bool | Literal['cut', 'a', 's']) – True or “a” to combine the resulting solid with parent solids if found, “cut” or “s” to remove the resulting solid from the parent solids if found. False to keep the resulting solid separated from the parent solids.
clean (bool) – call clean() afterwards to have a clean shape
arg (Shape | Workplane | Callable[[Location], Shape])

Return type:

T

The resulting object has a point on the stack for each object on the original stack. Vertices and points remain a point. Faces, Wires, Solids, Edges, and Shells are converted to a point by using their center of mass.

If the stack has zero length, a single point is returned, which is the center of the current workplane/coordinate system

edges(selector: str | Selector | None = None, tag: str | None = None) → T[source]

Select the edges of objects on the stack, optionally filtering the selection. If there are multiple objects on the stack, the edges of all objects are collected and a list of all the distinct edges is returned.

Parameters:

self (T)
selector (str | Selector | None) – optional Selector object, or string selector expression (see StringSyntaxSelector)
tag (str | None) – if set, search the tagged object instead of self

Returns:

a CQ object whose stack contains all of the distinct edges of all objects on the current stack, filtered by the provided selector.

Return type:

T

If there are no edges for any objects on the current stack, an empty CQ object is returned

The typical use is to select the edges of a single object on the stack. For example:

Workplane().box(1, 1, 1).faces("+Z").edges().size()

returns 4, because the topmost face of a cube will contain four edges. Similarly:

Workplane().box(1, 1, 1).edges().size()

returns 12, because a cube has a total of 12 edges, And:

Workplane().box(1, 1, 1).edges("|Z").size()

returns 4, because a cube has 4 edges parallel to the z direction

ellipse(x_radius: float, y_radius: float, rotation_angle: float = 0.0, forConstruction: bool = False) → T[source]

Make an ellipse for each item on the stack.

Parameters:

self (T)
x_radius (float) – x radius of the ellipse (x-axis of plane the ellipse should lie in)
y_radius (float) – y radius of the ellipse (y-axis of plane the ellipse should lie in)
rotation_angle (float) – angle to rotate the ellipse
forConstruction (true if the wires are for reference, false if they are creating part geometry) – should the new wires be reference geometry only?

Returns:

a new CQ object with the created wires on the stack

Return type:

T

NOTE Due to a bug in opencascade (https://tracker.dev.opencascade.org/view.php?id=31290) the center of mass (equals center for next shape) is shifted. To create concentric ellipses use:

Workplane("XY").center(10, 20).ellipse(100, 10).center(0, 0).ellipse(50, 5)

ellipseArc(x_radius: float, y_radius: float, angle1: float = 360, angle2: float = 360, rotation_angle: float = 0.0, sense: Literal[-1, 1] = 1, forConstruction: bool = False, startAtCurrent: bool = True, makeWire: bool = False) → T[source]

Draw an elliptical arc with x and y radiuses either with start point at current point or or current point being the center of the arc

Parameters:

self (T)
x_radius (float) – x radius of the ellipse (along the x-axis of plane the ellipse should lie in)
y_radius (float) – y radius of the ellipse (along the y-axis of plane the ellipse should lie in)
angle1 (float) – start angle of arc
angle2 (float) – end angle of arc (angle2 == angle1 return closed ellipse = default)
rotation_angle (float) – angle to rotate the created ellipse / arc
sense (Literal[-1, 1]) – clockwise (-1) or counter clockwise (1)
startAtCurrent (bool) – True: start point of arc is moved to current point; False: center of arc is on current point
makeWire (bool) – convert the resulting arc edge to a wire
forConstruction (bool)

Return type:

T

end(n: int = 1) → Workplane[source]

Return the nth parent of this CQ element

Parameters:: n (int) – number of ancestor to return (default: 1)
Return type:: a CQ object
Raises:: ValueError if there are no more parents in the chain.

For example:

CQ(obj).faces("+Z").vertices().end()

will return the same as:

CQ(obj).faces("+Z")

export(fname: str, tolerance: float = 0.1, angularTolerance: float = 0.1, opt: Dict[str, Any] | None = None) → T[source]

Export Workplane to file.

Parameters:

self (T)
path – Filename.
tolerance (float) – the deflection tolerance, in model units. Default 0.1.
angularTolerance (float) – the angular tolerance, in radians. Default 0.1.
opt (Dict[str, Any] | None) – additional options passed to the specific exporter. Default None.
fname (str)

Returns:

Self.

Return type:

T

exportSvg(fileName: str) → None[source]

Exports the first item on the stack as an SVG file

For testing purposes mainly.

Parameters:: fileName (str) – the filename to export, absolute path to the file
Return type:: None

extrude(until: float | Literal['next', 'last'] | Face, combine: bool | Literal['cut', 'a', 's'] = True, clean: bool = True, both: bool = False, taper: float | None = None) → T[source]

Use all un-extruded wires in the parent chain to create a prismatic solid.

Parameters:

self (T)
until (float | Literal['next', 'last'] | ~cadquery.occ_impl.shapes.Face) – The distance to extrude, normal to the workplane plane. When a float is passed, the extrusion extends this far and a negative value is in the opposite direction to the normal of the plane. The string “next” extrudes until the next face orthogonal to the wire normal. “last” extrudes to the last face. If a object of type Face is passed then the extrusion will extend until this face. Note that the Workplane must contain a Solid for extruding to a given face.
combine (bool | Literal['cut', 'a', 's']) – True or “a” to combine the resulting solid with parent solids if found, “cut” or “s” to remove the resulting solid from the parent solids if found. False to keep the resulting solid separated from the parent solids.
clean (bool) – call clean() afterwards to have a clean shape
both (bool) – extrude in both directions symmetrically
taper (float | None) – angle for optional tapered extrusion

Returns:

a CQ object with the resulting solid selected.

Return type:

T

The returned object is always a CQ object, and depends on whether combine is True, and whether a context solid is already defined:

if combine is False, the new value is pushed onto the stack. Note that when extruding
until a specified face, combine can not be False
if combine is true, the value is combined with the context solid if it exists,
and the resulting solid becomes the new context solid.

faces(selector: str | Selector | None = None, tag: str | None = None) → T[source]

Select the faces of objects on the stack, optionally filtering the selection. If there are multiple objects on the stack, the faces of all objects are collected and a list of all the distinct faces is returned.

Parameters:

self (T)
selector (str | Selector | None) – optional Selector object, or string selector expression (see StringSyntaxSelector)
tag (str | None) – if set, search the tagged object instead of self

Returns:

a CQ object whose stack contains all of the distinct faces of all objects on the current stack, filtered by the provided selector.

Return type:

T

If there are no faces for any objects on the current stack, an empty CQ object is returned.

The typical use is to select the faces of a single object on the stack. For example:

Workplane().box(1, 1, 1).faces("+Z").size()

returns 1, because a cube has one face with a normal in the +Z direction. Similarly:

Workplane().box(1, 1, 1).faces().size()

returns 6, because a cube has a total of 6 faces, And:

Workplane().box(1, 1, 1).faces("|Z").size()

returns 2, because a cube has 2 faces having normals parallel to the z direction

fillet(radius: float) → T[source]

Fillets a solid on the selected edges.

The edges on the stack are filleted. The solid to which the edges belong must be in the parent chain of the selected edges.

Parameters:

self (T)
radius (float) – the radius of the fillet, must be > zero

Raises:

ValueError – if at least one edge is not selected
ValueError – if the solid containing the edge is not in the chain

Returns:

CQ object with the resulting solid selected.

Return type:

T

This example will create a unit cube, with the top edges filleted:

s = Workplane().box(1, 1, 1).faces("+Z").edges().fillet(0.1)

filter(f: Callable[[Vector | Location | Shape | Sketch], bool]) → T[source]

Filter items using a boolean predicate.

Parameters:

self (T)
f (Callable[[Vector | Location | Shape | Sketch], bool]) – Callable to be used for filtering.

Returns:

Workplane object with filtered items.

Return type:

T

findFace(searchStack: bool = True, searchParents: bool = True) → Face[source]

Finds the first face object in the chain, searching from the current node backwards through parents until one is found.

Parameters:

searchStack (bool) – should objects on the stack be searched first.
searchParents (bool) – should parents be searched?

Returns:

A face or None if no face is found.

Return type:

findSolid(searchStack: bool = True, searchParents: bool = True) → Solid | Compound[source]

Finds the first solid object in the chain, searching from the current node backwards through parents until one is found.

Parameters:

searchStack (bool) – should objects on the stack be searched first?
searchParents (bool) – should parents be searched?

Raises:

ValueError – if no solid is found

Return type:

Solid | Compound

This function is very important for chains that are modifying a single parent object, most often a solid.

Most of the time, a chain defines or selects a solid, and then modifies it using workplanes or other operations.

Plugin Developers should make use of this method to find the solid that should be modified, if the plugin implements a unary operation, or if the operation will automatically merge its results with an object already on the stack.

first() → T[source]

Return the first item on the stack

Returns:: the first item on the stack.
Return type:: a CQ object
Parameters:: self (T)

hLine(distance: float, forConstruction: bool = False) → T[source]

Make a horizontal line from the current point the provided distance

Parameters:

self (T)
distance (float) –
1. distance from current point
forConstruction (bool)

Returns:

the Workplane object with the current point at the end of the new line

Return type:

T

hLineTo(xCoord: float, forConstruction: bool = False) → T[source]

Make a horizontal line from the current point to the provided x coordinate.

Useful if it is more convenient to specify the end location rather than distance, as in hLine()

Parameters:

self (T)
xCoord (float) – x coordinate for the end of the line
forConstruction (bool)

Returns:

the Workplane object with the current point at the end of the new line

Return type:

T

hole(diameter: float, depth: float | None = None, clean: bool = True) → T[source]

Makes a hole for each item on the stack.

Parameters:

self (T)
diameter (float) – the diameter of the hole
depth (float > 0 or None to drill thru the entire part.) – the depth of the hole
clean (bool) – call clean() afterwards to have a clean shape

Return type:

T

The surface of the hole is at the current workplane.

One hole is created for each item on the stack. A very common use case is to use a construction rectangle to define the centers of a set of holes, like so:

s = (
    Workplane()
    .box(2, 4, 0.5)
    .faces(">Z")
    .workplane()
    .rect(1.5, 3.5, forConstruction=True)
    .vertices()
    .hole(0.125, 82)
)

This sample creates a plate with a set of holes at the corners.

Plugin Note: this is one example of the power of plugins. CounterSunk holes are quite time consuming to create, but are quite easily defined by users.

see cboreHole() and cskHole() to make counterbores or countersinks

interpPlate(surf_edges: Sequence[Tuple[float, float] | Tuple[float, float, float] | Vector] | Sequence[Edge | Wire] | Workplane, surf_pts: Sequence[Tuple[float, float] | Tuple[float, float, float] | Vector] = [], thickness: float = 0, combine: bool | Literal['cut', 'a', 's'] = False, clean: bool = True, degree: int = 3, nbPtsOnCur: int = 15, nbIter: int = 2, anisotropy: bool = False, tol2d: float = 1e-05, tol3d: float = 0.0001, tolAng: float = 0.01, tolCurv: float = 0.1, maxDeg: int = 8, maxSegments: int = 9) → T[source]

Returns a plate surface that is ‘thickness’ thick, enclosed by ‘surf_edge_pts’ points, and going through ‘surf_pts’ points. Using pushPoints directly with interpPlate and combine=True, can be very resource intensive depending on the complexity of the shape. In this case set combine=False.

Parameters:

self (T)
surf_edges (Sequence[Tuple[float, float] | Tuple[float, float, float] | Vector] | Sequence[Edge | Wire] | Workplane) – list of [x,y,z] ordered coordinates or list of ordered or unordered edges, wires
surf_pts (Sequence[Tuple[float, float] | Tuple[float, float, float] | Vector]) – list of points (uses only edges if [])
thickness (float) – value may be negative or positive depending on thickening direction (2D surface if 0)
combine (bool | Literal['cut', 'a', 's']) – should the results be combined with other solids on the stack (and each other)?
clean (bool) – call clean() afterwards to have a clean shape
degree (int) – >= 2
nbPtsOnCur (int) – number of points on curve >= 15
nbIter (int) – number of iterations >= 2
anisotropy (bool) – = bool Anisotropy
tol2d (float) – 2D tolerance
tol3d (float) – 3D tolerance
tolAng (float) – angular tolerance
tolCurv (float) – tolerance for curvature
maxDeg (int) – highest polynomial degree >= 2
maxSegments (int) – greatest number of segments >= 2

Return type:

T

intersect(toIntersect: Workplane | Solid | Compound, clean: bool = True, tol: float | None = None) → T[source]

Intersects the provided solid from the current solid.

Parameters:

self (T)
toIntersect (Workplane | Solid | Compound) – a solid object, or a Workplane object having a solid
clean (bool) – call clean() afterwards to have a clean shape
tol (float | None) – tolerance value for fuzzy bool operation mode (default None)

Raises:

ValueError – if there is no solid to intersect with in the chain

Returns:

a Workplane object with the resulting object selected

Return type:

T

invoke(f: Callable[[T], T] | Callable[[T], None] | Callable[[], None]) → T[source]

Invoke a callable mapping Workplane to Workplane or None. Supports also callables that take no arguments such as breakpoint. Returns self if callable returns None.

Parameters:

self (T)
f (Callable[[T], T] | Callable[[T], None] | Callable[[], None]) – Callable to be invoked.

Returns:

Workplane object.

Return type:

T

item(i: int) → T[source]

Return the ith item on the stack.

Return type:

a CQ object

Parameters:

self (T)
i (int)

largestDimension() → float[source]

Finds the largest dimension in the stack.

Used internally to create thru features, this is how you can compute how long or wide a feature must be to make sure to cut through all of the material

Raises:: ValueError – if no solids or compounds are found
Returns:: A value representing the largest dimension of the first solid on the stack
Return type:: float

last() → T[source]

Return the last item on the stack.

Return type:: a CQ object
Parameters:: self (T)

line(xDist: float, yDist: float, forConstruction: bool = False) → T[source]

Make a line from the current point to the provided point, using dimensions relative to the current point

Parameters:

self (T)
xDist (float) – x distance from current point
yDist (float) – y distance from current point
forConstruction (bool)

Returns:

the workplane object with the current point at the end of the new line

Return type:

T

see lineTo() if you want to use absolute coordinates to make a line instead.

lineTo(x: float, y: float, forConstruction: bool = False) → T[source]

Make a line from the current point to the provided point

Parameters:

self (T)
x (float) – the x point, in workplane plane coordinates
y (float) – the y point, in workplane plane coordinates
forConstruction (bool)

Returns:

the Workplane object with the current point at the end of the new line

Return type:

T

See line() if you want to use relative dimensions to make a line instead.

loft(ruled: bool = False, combine: bool | Literal['cut', 'a', 's'] = True, clean: bool = True) → T[source]

Make a lofted solid, through the set of wires.

Parameters:

self (T)
ruled (bool) – When set to True connects each section linearly and without continuity
combine (bool | Literal['cut', 'a', 's']) – True or “a” to combine the resulting solid with parent solids if found, “cut” or “s” to remove the resulting solid from the parent solids if found. False to keep the resulting solid separated from the parent solids.
clean (bool) – call clean() afterwards to have a clean shape

Returns:

a Workplane object containing the created loft

Return type:

T

Apply a callable to every item separately.

Parameters:

self (T)
f (Callable[[Vector | Location | Shape | Sketch], Vector | Location | Shape | Sketch]) – Callable to be applied to every item separately.

Returns:

Workplane object with f applied to all items.

Return type:

T

Mirror a single CQ object.

Parameters:

self (T)
mirrorPlane (string, one of "XY", "YX", "XZ", "ZX", "YZ", "ZY" the planes or the normal vector of the plane eg (1,0,0) or a Face object) – the plane to mirror about
basePointVector (Tuple[float, float] | Tuple[float, float, float] | Vector | None) – the base point to mirror about (this is overwritten if a Face is passed)
union (bool) – If true will perform a union operation on the mirrored object

Return type:

T

mirrorX() → T[source]

Mirror entities around the x axis of the workplane plane.

Returns:: a new object with any free edges consolidated into as few wires as possible.
Parameters:: self (T)
Return type:: T

All free edges are collected into a wire, and then the wire is mirrored, and finally joined into a new wire

Typically used to make creating wires with symmetry easier.

mirrorY() → T[source]

Mirror entities around the y axis of the workplane plane.

Returns:: a new object with any free edges consolidated into as few wires as possible.
Parameters:: self (T)
Return type:: T

All free edges are collected into a wire, and then the wire is mirrored, and finally joined into a new wire

Typically used to make creating wires with symmetry easier. This line of code:

s = Workplane().lineTo(2, 2).threePointArc((3, 1), (2, 0)).mirrorX().extrude(0.25)

Produces a flat, heart shaped object

move(xDist: float = 0, yDist: float = 0) → T[source]

Move the specified distance from the current point, without drawing.

Parameters:

self (T)
xDist (float, or none for zero) – desired x distance, in local coordinates
yDist (float, or none for zero.) – desired y distance, in local coordinates

Return type:

T

Not to be confused with center(), which moves the center of the entire workplane, this method only moves the current point ( and therefore does not affect objects already drawn ).

See moveTo() to do the same thing but using absolute coordinates

moveTo(x: float = 0, y: float = 0) → T[source]

Move to the specified point, without drawing.

Parameters:

self (T)
x (float, or none for zero) – desired x location, in local coordinates
y (float, or none for zero.) – desired y location, in local coordinates

Return type:

T

Not to be confused with center(), which moves the center of the entire workplane, this method only moves the current point ( and therefore does not affect objects already drawn ).

See move() to do the same thing but using relative dimensions

newObject(objlist: Iterable[Vector | Location | Shape | Sketch]) → T[source]

Create a new workplane object from this one.

Overrides CQ.newObject, and should be used by extensions, plugins, and subclasses to create new objects.

Parameters:

self (T)
objlist (a list of CAD primitives) – new objects to put on the stack

Returns:

a new Workplane object with the current workplane as a parent.

Return type:

T

offset2D(d: float, kind: Literal['arc', 'intersection', 'tangent'] = 'arc', forConstruction: bool = False) → T[source]

Creates a 2D offset wire.

Parameters:

self (T)
d (float) – thickness. Negative thickness denotes offset to inside.
kind (Literal['arc', 'intersection', 'tangent']) – offset kind. Use “arc” for rounded and “intersection” for sharp edges (default: “arc”)
forConstruction (bool) – Should the result be added to pending wires?

Returns:

CQ object with resulting wire(s).

Return type:

T

parametricCurve(func: Callable[[float], Tuple[float, float] | Tuple[float, float, float] | Vector], N: int = 400, start: float = 0, stop: float = 1, tol: float = 1e-06, minDeg: int = 1, maxDeg: int = 6, smoothing: Tuple[float, float, float] | None = (1, 1, 1), makeWire: bool = True) → T[source]

Create a spline curve approximating the provided function.

Parameters:

self (T)
func (float --> (float,float,float)) – function f(t) that will generate (x,y,z) pairs
N (int) – number of points for discretization
start (float) – starting value of the parameter t
stop (float) – final value of the parameter t
tol (float) – tolerance of the algorithm (default: 1e-6)
minDeg (int) – minimum spline degree (default: 1)
maxDeg (int) – maximum spline degree (default: 6)
smoothing (Tuple[float, float, float] | None) – optional parameters for the variational smoothing algorithm (default: (1,1,1))
makeWire (bool) – convert the resulting spline edge to a wire

Returns:

a Workplane object with the current point unchanged

Return type:

T

parametricSurface(func: Callable[[float, float], Tuple[float, float] | Tuple[float, float, float] | Vector], N: int = 20, start: float = 0, stop: float = 1, tol: float = 0.01, minDeg: int = 1, maxDeg: int = 6, smoothing: Tuple[float, float, float] | None = (1, 1, 1)) → T[source]

Create a spline surface approximating the provided function.

Parameters:

self (T)
func ((float,float) --> (float,float,float)) – function f(u,v) that will generate (x,y,z) pairs
N (int) – number of points for discretization in one direction
start (float) – starting value of the parameters u,v
stop (float) – final value of the parameters u,v
tol (float) – tolerance used by the approximation algorithm (default: 1e-3)
minDeg (int) – minimum spline degree (default: 1)
maxDeg (int) – maximum spline degree (default: 3)
smoothing (Tuple[float, float, float] | None) – optional parameters for the variational smoothing algorithm (default: (1,1,1))

Returns:

a Workplane object with the current point unchanged

Return type:

T

This method might be unstable and may require tuning of the tol parameter.

placeSketch(*sketches: Sketch) → T[source]

Place the provided sketch(es) based on the current items on the stack.

Returns:

Workplane object with the sketch added.

Parameters:

self (T)
sketches (Sketch)

Return type:

T

polarArray(radius: float, startAngle: float, angle: float, count: int, fill: bool = True, rotate: bool = True) → T[source]

Creates a polar array of points and pushes them onto the stack. The zero degree reference angle is located along the local X-axis.

Parameters:

self (T)
radius (float) – Radius of the array.
startAngle (float) – Starting angle (degrees) of array. Zero degrees is situated along the local X-axis.
angle (float) – The angle (degrees) to fill with elements. A positive value will fill in the counter-clockwise direction. If fill is False, angle is the angle between elements.
count (int) – Number of elements in array. (count >= 1)
fill (bool) – Interpret the angle as total if True (default: True).
rotate (bool) – Rotate every item (default: True).

Return type:

T

polarLine(distance: float, angle: float, forConstruction: bool = False) → T[source]

Make a line of the given length, at the given angle from the current point

Parameters:

self (T)
distance (float) – distance of the end of the line from the current point
angle (float) – angle of the vector to the end of the line with the x-axis
forConstruction (bool)

Returns:

the Workplane object with the current point at the end of the new line

Return type:

T

polarLineTo(distance: float, angle: float, forConstruction: bool = False) → T[source]

Make a line from the current point to the given polar coordinates

Useful if it is more convenient to specify the end location rather than the distance and angle from the current point

Parameters:

self (T)
distance (float) – distance of the end of the line from the origin
angle (float) – angle of the vector to the end of the line with the x-axis
forConstruction (bool)

Returns:

the Workplane object with the current point at the end of the new line

Return type:

T

polygon(nSides: int, diameter: float, forConstruction: bool = False, circumscribed: bool = False) → T[source]

Make a polygon for each item on the stack.

By default, each polygon is created by inscribing it in a circle of the specified diameter, such that the first vertex is oriented in the x direction. Alternatively, each polygon can be created by circumscribing it around a circle of the specified diameter, such that the midpoint of the first edge is oriented in the x direction. Circumscribed polygons are thus rotated by pi/nSides radians relative to the inscribed polygon. This ensures the extent of the polygon along the positive x-axis is always known. This has the advantage of not requiring additional formulae for purposes such as tiling on the x-axis (at least for even sided polygons).

Parameters:

self (T)
nSides (int) – number of sides, must be >= 3
diameter (float) – the diameter of the circle for constructing the polygon
circumscribed (true to create the polygon by circumscribing it about a circle, false to create the polygon by inscribing it in a circle) – circumscribe the polygon about a circle
forConstruction (bool)

Returns:

a polygon wire

Return type:

T

polyline(listOfXYTuple: Sequence[Tuple[float, float] | Tuple[float, float, float] | Vector], forConstruction: bool = False, includeCurrent: bool = False) → T[source]

Create a polyline from a list of points

Parameters:

self (T)
listOfXYTuple (Sequence[Tuple[float, float] | Tuple[float, float, float] | Vector]) – a list of points in Workplane coordinates (2D or 3D)
forConstruction (true if the edges are for reference, false if they are for creating geometry part geometry) – whether or not the edges are used for reference
includeCurrent (bool) – use current point as a starting point of the polyline

Returns:

a new CQ object with a list of edges on the stack

Return type:

T

NOTE most commonly, the resulting wire should be closed.

pushPoints(pntList: Iterable[Tuple[float, float] | Tuple[float, float, float] | Vector | Location]) → T[source]

Pushes a list of points onto the stack as vertices. The points are in the 2D coordinate space of the workplane face

Parameters:

self (T)
pntList (list of 2-tuples, in local coordinates) – a list of points to push onto the stack

Returns:

a new workplane with the desired points on the stack.

Return type:

T

A common use is to provide a list of points for a subsequent operation, such as creating circles or holes. This example creates a cube, and then drills three holes through it, based on three points:

s = (
    Workplane()
    .box(1, 1, 1)
    .faces(">Z")
    .workplane()
    .pushPoints([(-0.3, 0.3), (0.3, 0.3), (0, 0)])
)
body = s.circle(0.05).cutThruAll()

Here the circle function operates on all three points, and is then extruded to create three holes. See circle() for how it works.

radiusArc(endPoint: Tuple[float, float] | Tuple[float, float, float] | Vector, radius: float, forConstruction: bool = False) → T[source]

Draw an arc from the current point to endPoint with an arc defined by the radius.

Parameters:

self (T)
endPoint (2-tuple, in workplane coordinates) – end point for the arc
radius (float, the radius of the arc between start point and end point.) – the radius of the arc
forConstruction (bool)

Returns:

a workplane with the current point at the end of the arc

Return type:

T

Given that a closed contour is drawn clockwise; A positive radius means convex arc and negative radius means concave arc.

rarray(xSpacing: float, ySpacing: float, xCount: int, yCount: int, center: bool | Tuple[bool, bool] = True) → T[source]

Creates an array of points and pushes them onto the stack. If you want to position the array at another point, create another workplane that is shifted to the position you would like to use as a reference

Parameters:

self (T)
xSpacing (float) – spacing between points in the x direction ( must be >= 0)
ySpacing (float) – spacing between points in the y direction ( must be >= 0)
xCount (int) – number of points ( > 0 )
yCount (int) – number of points ( > 0 )
center (bool | Tuple[bool, bool]) – If True, the array will be centered around the workplane center. If False, the lower corner will be on the reference point and the array will extend in the positive x and y directions. Can also use a 2-tuple to specify centering along each axis.

Return type:

T

rect(xLen: float, yLen: float, centered: bool | Tuple[bool, bool] = True, forConstruction: bool = False) → T[source]

Make a rectangle for each item on the stack.

Parameters:

self (T)
xLen (float) – length in the x direction (in workplane coordinates)
yLen (float) – length in the y direction (in workplane coordinates)
centered (bool | Tuple[bool, bool]) – If True, the rectangle will be centered around the reference point. If False, the corner of the rectangle will be on the reference point and it will extend in the positive x and y directions. Can also use a 2-tuple to specify centering along each axis.
forConstruction (true if the wires are for reference, false if they are creating part geometry) – should the new wires be reference geometry only?

Returns:

a new CQ object with the created wires on the stack

Return type:

T

A common use case is to use a for-construction rectangle to define the centers of a hole pattern:

s = Workplane().rect(4.0, 4.0, forConstruction=True).vertices().circle(0.25)

Creates 4 circles at the corners of a square centered on the origin.

Negative values for xLen and yLen are permitted, although they only have an effect when centered is False.

Future Enhancements:

project points not in the workplane plane onto the workplane plane

Use all un-revolved wires in the parent chain to create a solid.

Parameters:

self (T)
angleDegrees (float, anything less than 360 degrees will leave the shape open) – the angle to revolve through.
axisStart (Tuple[float, float] | Tuple[float, float, float] | Vector | None) – the start point of the axis of rotation
axisEnd (Tuple[float, float] | Tuple[float, float, float] | Vector | None) – the end point of the axis of rotation
combine (bool | Literal['cut', 'a', 's']) – True or “a” to combine the resulting solid with parent solids if found, “cut” or “s” to remove the resulting solid from the parent solids if found. False to keep the resulting solid separated from the parent solids.
clean (bool) – call clean() afterwards to have a clean shape

Returns:

a CQ object with the resulting solid selected.

Return type:

T

The returned object is always a CQ object, and depends on whether combine is True, and whether a context solid is already defined:

if combine is False, the new value is pushed onto the stack.
if combine is true, the value is combined with the context solid if it exists, and the resulting solid becomes the new context solid.

Note

Keep in mind that axisStart and axisEnd are defined relative to the current Workplane center position. So if for example you want to revolve a circle centered at (10,0,0) around the Y axis, be sure to either move() (or moveTo()) the current Workplane position or specify axisStart and axisEnd with the correct vector position. In this example (0,0,0), (0,1,0) as axis coords would fail.

rotate(axisStartPoint: Tuple[float, float] | Tuple[float, float, float] | Vector, axisEndPoint: Tuple[float, float] | Tuple[float, float, float] | Vector, angleDegrees: float) → T[source]

Returns a copy of all of the items on the stack rotated through and angle around the axis of rotation.

Parameters:

self (T)
axisStartPoint (a 3-tuple of floats) – The first point of the axis of rotation
axisEndPoint (a 3-tuple of floats) – The second point of the axis of rotation
angleDegrees (float) – the rotation angle, in degrees

Returns:

a CQ object

Return type:

T

rotateAboutCenter(axisEndPoint: Tuple[float, float] | Tuple[float, float, float] | Vector, angleDegrees: float) → T[source]

Rotates all items on the stack by the specified angle, about the specified axis

The center of rotation is a vector starting at the center of the object on the stack, and ended at the specified point.

Parameters:

self (T)
axisEndPoint (a three-tuple in global coordinates) – the second point of axis of rotation
angleDegrees (float) – the rotation angle, in degrees

Returns:

a CQ object, with all items rotated.

Return type:

T

WARNING: This version returns the same CQ object instead of a new one– the old object is not accessible.

Future Enhancements:

A version of this method that returns a transformed copy, rather than modifying the originals
This method doesn’t expose a very good interface, because the axis of rotation could be inconsistent between multiple objects. This is because the beginning of the axis is variable, while the end is fixed. This is fine when operating on one object, but is not cool for multiple.

sagittaArc(endPoint: Tuple[float, float] | Tuple[float, float, float] | Vector, sag: float, forConstruction: bool = False) → T[source]

Draw an arc from the current point to endPoint with an arc defined by the sag (sagitta).

Parameters:

self (T)
endPoint (2-tuple, in workplane coordinates) – end point for the arc
sag (float, perpendicular distance from arc center to arc baseline.) – the sagitta of the arc
forConstruction (bool)

Returns:

a workplane with the current point at the end of the arc

Return type:

T

The sagitta is the distance from the center of the arc to the arc base. Given that a closed contour is drawn clockwise; A positive sagitta means convex arc and negative sagitta means concave arc. See https://en.wikipedia.org/wiki/Sagitta_(geometry) for more information.

section(height: float = 0.0) → T[source]

Slices current solid at the given height.

Parameters:

self (T)
height (float) – height to slice at (default: 0)

Raises:

ValueError – if no solids or compounds are found

Returns:

a CQ object with the resulting face(s).

Return type:

T

shell(thickness: float, kind: Literal['arc', 'intersection'] = 'arc') → T[source]

Remove the selected faces to create a shell of the specified thickness.

To shell, first create a solid, and in the same chain select the faces you wish to remove.

Parameters:

self (T)
thickness (float) – thickness of the desired shell. Negative values shell inwards, positive values shell outwards.
kind (Literal['arc', 'intersection']) – kind of join, arc or intersection (default: arc).

Raises:

ValueError – if the current stack contains objects that are not faces of a solid further up in the chain.

Returns:

a CQ object with the resulting shelled solid selected.

Return type:

T

This example will create a hollowed out unit cube, where the top most face is open, and all other walls are 0.2 units thick:

Workplane().box(1, 1, 1).faces("+Z").shell(0.2)

You can also select multiple faces at once. Here is an example that creates a three-walled corner, by removing three faces of a cube:

Workplane().box(10, 10, 10).faces(">Z or >X or <Y").shell(1)

Note: When sharp edges are shelled inwards, they remain sharp corners, but outward shells are automatically filleted (unless kind=”intersection”), because an outward offset from a corner generates a radius.

shells(selector: str | Selector | None = None, tag: str | None = None) → T[source]

Select the shells of objects on the stack, optionally filtering the selection. If there are multiple objects on the stack, the shells of all objects are collected and a list of all the distinct shells is returned.

Parameters:

self (T)
selector (str | Selector | None) – optional Selector object, or string selector expression (see StringSyntaxSelector)
tag (str | None) – if set, search the tagged object instead of self

Returns:

a CQ object whose stack contains all of the distinct shells of all objects on the current stack, filtered by the provided selector.

Return type:

T

If there are no shells for any objects on the current stack, an empty CQ object is returned

Most solids will have a single shell, which represents the outer surface. A shell will typically be composed of multiple faces.

siblings(kind: Literal['Vertex', 'Edge', 'Wire', 'Face', 'Shell', 'Solid', 'CompSolid', 'Compound'], level: int = 1, tag: str | None = None) → T[source]

Select topological siblings.

Parameters:

self (T)
kind (Literal['Vertex', 'Edge', 'Wire', 'Face', 'Shell', 'Solid', 'CompSolid', 'Compound']) – kind of linking element, e.g. “Vertex” or “Edge”
level (int) – level of relation - how many elements of kind are in the link
tag (str | None) – if set, search the tagged object instead of self

Returns:

a Workplane object whose stack contains selected siblings.

Return type:

T

size() → int[source]

Return the number of objects currently on the stack

Return type:: int

sketch() → Sketch[source]

Initialize and return a sketch

Returns:: Sketch object with the current workplane as a parent.
Parameters:: self (T)
Return type:: Sketch

slot2D(length: float, diameter: float, angle: float = 0) → T[source]

Creates a rounded slot for each point on the stack.

Parameters:

self (T)
diameter (float) – desired diameter, or width, of slot
length (float) – desired end to end length of slot
angle (float) – angle of slot in degrees, with 0 being along x-axis

Returns:

a new CQ object with the created wires on the stack

Return type:

T

Can be used to create arrays of slots, such as in cooling applications:

Workplane().box(10, 25, 1).rarray(1, 2, 1, 10).slot2D(8, 1, 0).cutThruAll()

solids(selector: str | Selector | None = None, tag: str | None = None) → T[source]

Select the solids of objects on the stack, optionally filtering the selection. If there are multiple objects on the stack, the solids of all objects are collected and a list of all the distinct solids is returned.

Parameters:

self (T)
selector (str | Selector | None) – optional Selector object, or string selector expression (see StringSyntaxSelector)
tag (str | None) – if set, search the tagged object instead of self

Returns:

a CQ object whose stack contains all of the distinct solids of all objects on the current stack, filtered by the provided selector.

Return type:

T

If there are no solids for any objects on the current stack, an empty CQ object is returned

The typical use is to select a single object on the stack. For example:

Workplane().box(1, 1, 1).solids().size()

returns 1, because a cube consists of one solid.

It is possible for a single CQ object ( or even a single CAD primitive ) to contain multiple solids.

sort(key: Callable[[Vector | Location | Shape | Sketch], Any]) → T[source]

Sort items using a callable.

Parameters:

self (T)
key (Callable[[Vector | Location | Shape | Sketch], Any]) – Callable to be used for sorting.

Returns:

Workplane object with items sorted.

Return type:

T

sphere(radius: float, direct: Tuple[float, float] | Tuple[float, float, float] | Vector = (0, 0, 1), angle1: float = -90, angle2: float = 90, angle3: float = 360, centered: bool | Tuple[bool, bool, bool] = True, combine: bool | Literal['cut', 'a', 's'] = True, clean: bool = True) → T[source]

Returns a 3D sphere with the specified radius for each point on the stack.

Parameters:

self (T)
radius (float) – The radius of the sphere
direct (A three-tuple) – The direction axis for the creation of the sphere
angle1 (float > 0) – The first angle to sweep the sphere arc through
angle2 (float > 0) – The second angle to sweep the sphere arc through
angle3 (float > 0) – The third angle to sweep the sphere arc through
centered (bool | Tuple[bool, bool, bool]) – If True, the sphere will be centered around the reference point. If False, the corner of a bounding box around the sphere will be on the reference point and it will extend in the positive x, y and z directions. Can also use a 3-tuple to specify centering along each axis.
combine (true to combine shapes, false otherwise) – Whether the results should be combined with other solids on the stack (and each other)
clean (bool) – call clean() afterwards to have a clean shape

Returns:

A sphere object for each point on the stack

Return type:

T

One sphere 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 spheres produced fused onto it otherwise, the result is the combination of all the produced spheres.

If combine is false, the result will be a list of the spheres produced.

spline(listOfXYTuple: Iterable[Tuple[float, float] | Tuple[float, float, float] | Vector], tangents: Sequence[Tuple[float, float] | Tuple[float, float, float] | Vector] | None = None, periodic: bool = False, parameters: Sequence[float] | None = None, scale: bool = True, tol: float | None = None, forConstruction: bool = False, includeCurrent: bool = False, makeWire: bool = False) → T[source]

Create a spline interpolated through the provided points (2D or 3D).

Parameters:

self (T)
listOfXYTuple (Iterable[Tuple[float, float] | Tuple[float, float, float] | Vector]) – points to interpolate through
tangents (Sequence[Tuple[float, float] | Tuple[float, float, float] | Vector] | None) –
vectors specifying the direction of the tangent to the curve at each of the specified interpolation points.

If only 2 tangents are given, they will be used as the initial and final tangent.

If some tangents are not specified (i.e., are None), no tangent constraint will be applied to the corresponding interpolation point.

The spline will be C2 continuous at the interpolation points where no tangent constraint is specified, and C1 continuous at the points where a tangent constraint is specified.
periodic (bool) – creation of periodic curves
parameters (Sequence[float] | None) –
the value of the parameter at each interpolation point. (The interpolated curve is represented as a vector-valued function of a scalar parameter.)

If periodic == True, then len(parameters) must be len(interpolation points) + 1, otherwise len(parameters) must be equal to len(interpolation points).
scale (bool) –
whether to scale the specified tangent vectors before interpolating.

Each tangent is scaled, so it’s length is equal to the derivative of the Lagrange interpolated curve.

I.e., set this to True, if you want to use only the direction of the tangent vectors specified by tangents, but not their magnitude.
tol (float | None) –
tolerance of the algorithm (consult OCC documentation)

Used to check that the specified points are not too close to each other, and that tangent vectors are not too short. (In either case interpolation may fail.)

Set to None to use the default tolerance.
includeCurrent (bool) – use current point as a starting point of the curve
makeWire (bool) – convert the resulting spline edge to a wire
forConstruction (bool)

Returns:

a Workplane object with the current point at the end of the spline

Return type:

T

The spline will begin at the current point, and end with the last point in the XY tuple list.

This example creates a block with a spline for one side:

s = Workplane(Plane.XY())
sPnts = [
    (2.75, 1.5),
    (2.5, 1.75),
    (2.0, 1.5),
    (1.5, 1.0),
    (1.0, 1.25),
    (0.5, 1.0),
    (0, 1.0),
]
r = s.lineTo(3.0, 0).lineTo(3.0, 1.0).spline(sPnts).close()
r = r.extrude(0.5)

WARNING It is fairly easy to create a list of points that cannot be correctly interpreted as a spline.

splineApprox(points: Iterable[Tuple[float, float] | Tuple[float, float, float] | Vector], tol: float | None = 1e-06, minDeg: int = 1, maxDeg: int = 6, smoothing: Tuple[float, float, float] | None = (1, 1, 1), forConstruction: bool = False, includeCurrent: bool = False, makeWire: bool = False) → T[source]

Create a spline interpolated through the provided points (2D or 3D).

Parameters:

self (T)
points (Iterable[Tuple[float, float] | Tuple[float, float, float] | Vector]) – points to interpolate through
tol (float | None) – tolerance of the algorithm (default: 1e-6)
minDeg (int) – minimum spline degree (default: 1)
maxDeg (int) – maximum spline degree (default: 6)
smoothing (Tuple[float, float, float] | None) – optional parameters for the variational smoothing algorithm (default: (1,1,1))
includeCurrent (bool) – use current point as a starting point of the curve
makeWire (bool) – convert the resulting spline edge to a wire
forConstruction (bool)

Returns:

a Workplane object with the current point at the end of the spline

Return type:

T

WARNING for advanced users.

split(keepTop: bool = False, keepBottom: bool = False) → T[source]

split(splitter: Workplane | Shape) → T

Splits a solid on the stack into two parts, optionally keeping the separate parts.

Parameters:

self
keepTop (bool) – True to keep the top, False or None to discard it
keepBottom (bool) – True to keep the bottom, False or None to discard it

Raises:

ValueError – if keepTop and keepBottom are both false.
ValueError – if there is no solid in the current stack or parent chain

Returns:

CQ object with the desired objects on the stack.

The most common operation splits a solid and keeps one half. This sample creates a split bushing:

# drill a hole in the side
c = Workplane().box(1, 1, 1).faces(">Z").workplane().circle(0.25).cutThruAll()

# now cut it in half sideways
c = c.faces(">Y").workplane(-0.5).split(keepTop=True)

sweep(path: Workplane | Wire | Edge, multisection: bool = False, sweepAlongWires: bool | None = None, makeSolid: bool = True, isFrenet: bool = False, combine: bool | Literal['cut', 'a', 's'] = True, clean: bool = True, transition: Literal['right', 'round', 'transformed'] = 'right', normal: Tuple[float, float] | Tuple[float, float, float] | Vector | None = None, auxSpine: Workplane | None = None) → T[source]

Use all un-extruded wires in the parent chain to create a swept solid.

Parameters:

self (T)
path (Workplane | Wire | Edge) – A wire along which the pending wires will be swept
multiSection – False to create multiple swept from wires on the chain along path. True to create only one solid swept along path with shape following the list of wires on the chain
combine (bool | Literal['cut', 'a', 's']) – True or “a” to combine the resulting solid with parent solids if found, “cut” or “s” to remove the resulting solid from the parent solids if found. False to keep the resulting solid separated from the parent solids.
clean (bool) – call clean() afterwards to have a clean shape
transition (Literal['right', 'round', 'transformed']) – handling of profile orientation at C1 path discontinuities. Possible values are {‘transformed’,’round’, ‘right’} (default: ‘right’).
normal (Tuple[float, float] | Tuple[float, float, float] | Vector | None) – optional fixed normal for extrusion
auxSpine (Workplane | None) – a wire defining the binormal along the extrusion path
multisection (bool)
sweepAlongWires (bool | None)
makeSolid (bool)
isFrenet (bool)

Returns:

a CQ object with the resulting solid selected.

Return type:

T

tag(name: str) → T[source]

Tags the current CQ object for later reference.

Parameters:

self (T)
name (str) – the name to tag this object with

Returns:

self, a CQ object with tag applied

Return type:

T

tangentArcPoint(endpoint: Tuple[float, float] | Tuple[float, float, float] | Vector, forConstruction: bool = False, relative: bool = True) → T[source]

Draw an arc as a tangent from the end of the current edge to endpoint.

Parameters:

self (T)
endpoint (2-tuple, 3-tuple or Vector) – point for the arc to end at
relative (bool) – True if endpoint is specified relative to the current point, False if endpoint is in workplane coordinates
forConstruction (bool)

Returns:

a Workplane object with an arc on the stack

Return type:

T

Requires the the current first object on the stack is an Edge, as would be the case after a lineTo operation or similar.

text(txt: str, fontsize: float, distance: float, cut: bool = True, combine: bool | Literal['cut', 'a', 's'] = False, clean: bool = True, font: str = 'Arial', fontPath: str | None = None, kind: Literal['regular', 'bold', 'italic'] = 'regular', halign: Literal['center', 'left', 'right'] = 'center', valign: Literal['center', 'top', 'bottom'] = 'center') → T[source]

Returns a 3D text.

Parameters:

self (T)
txt (str) – text to be rendered
fontsize (float) – size of the font in model units
distance (float, negative means opposite the normal direction) – the distance to extrude or cut, normal to the workplane plane
cut (bool) – True to cut the resulting solid from the parent solids if found
combine (bool | Literal['cut', 'a', 's']) – True or “a” to combine the resulting solid with parent solids if found, “cut” or “s” to remove the resulting solid from the parent solids if found. False to keep the resulting solid separated from the parent solids.
clean (bool) – call clean() afterwards to have a clean shape
font (str) – font name
fontPath (str | None) – path to font file
kind (Literal['regular', 'bold', 'italic']) – font type
halign (Literal['center', 'left', 'right']) – horizontal alignment
valign (Literal['center', 'top', 'bottom']) – vertical alignment

Returns:

a CQ object with the resulting solid selected

Return type:

T

The returned object is always a Workplane object, and depends on whether combine is True, and whether a context solid is already defined:

if combine is False, the new value is pushed onto the stack.
if combine is true, the value is combined with the context solid if it exists, and the resulting solid becomes the new context solid.

Examples:

cq.Workplane().text("CadQuery", 5, 1)

Specify the font (name), and kind to use an installed system font:

cq.Workplane().text("CadQuery", 5, 1, font="Liberation Sans Narrow", kind="italic")

Specify fontPath to use a font from a given file:

cq.Workplane().text("CadQuery", 5, 1, fontPath="/opt/fonts/texgyrecursor-bold.otf")

Cutting text into a solid:

cq.Workplane().box(8, 8, 8).faces(">Z").workplane().text("Z", 5, -1.0)

threePointArc(point1: Tuple[float, float] | Tuple[float, float, float] | Vector, point2: Tuple[float, float] | Tuple[float, float, float] | Vector, forConstruction: bool = False) → T[source]

Draw an arc from the current point, through point1, and ending at point2

Parameters:

self (T)
point1 (2-tuple, in workplane coordinates) – point to draw through
point2 (2-tuple, in workplane coordinates) – end point for the arc
forConstruction (bool)

Returns:

a workplane with the current point at the end of the arc

Return type:

T

Future Enhancements:: provide a version that allows an arc using relative measures provide a centerpoint arc provide tangent arcs

toOCC() → Any[source]

Directly returns the wrapped OCCT object.

Returns:: The wrapped OCCT object
Return type:: TopoDS_Shape or a subclass

toPending() → T[source]

Adds wires/edges to pendingWires/pendingEdges.

Returns:: same CQ object with updated context.
Parameters:: self (T)
Return type:: T

toSvg(opts: Any = None) → str[source]

Returns svg text that represents the first item on the stack.

for testing purposes.

Parameters:: opts (dictionary, width and height) – svg formatting options
Returns:: a string that contains SVG that represents this item.
Return type:: str

transformed(rotate: Tuple[float, float] | Tuple[float, float, float] | Vector = (0, 0, 0), offset: Tuple[float, float] | Tuple[float, float, float] | Vector = (0, 0, 0)) → T[source]

Create a new workplane based on the current one. The origin of the new plane is located at the existing origin+offset vector, where offset is given in coordinates local to the current plane The new plane is rotated through the angles specified by the components of the rotation vector.

Parameters:

self (T)
rotate (Tuple[float, float] | Tuple[float, float, float] | Vector) – 3-tuple of angles to rotate, in degrees relative to work plane coordinates
offset (Tuple[float, float] | Tuple[float, float, float] | Vector) – 3-tuple to offset the new plane, in local work plane coordinates

Returns:

a new work plane, transformed as requested

Return type:

T

translate(vec: Tuple[float, float] | Tuple[float, float, float] | Vector) → T[source]

Returns a copy of all of the items on the stack moved by the specified translation vector.

Parameters:

self (T)
tupleDistance (a 3-tuple of float) – distance to move, in global coordinates
vec (Tuple[float, float] | Tuple[float, float, float] | Vector)

Returns:

a CQ object

Return type:

T

twistExtrude(distance: float, angleDegrees: float, combine: bool | Literal['cut', 'a', 's'] = True, clean: bool = True) → T[source]

Extrudes a wire in the direction normal to the plane, but also twists by the specified angle over the length of the extrusion.

The center point of the rotation will be the center of the workplane.

See extrude for more details, since this method is the same except for the the addition of the angle. In fact, if angle=0, the result is the same as a linear extrude.

NOTE This method can create complex calculations, so be careful using it with complex geometries

Parameters:

self (T)
distance (float) – the distance to extrude normal to the workplane
angle – angle (in degrees) to rotate through the extrusion
combine (bool | Literal['cut', 'a', 's']) – True or “a” to combine the resulting solid with parent solids if found, “cut” or “s” to remove the resulting solid from the parent solids if found. False to keep the resulting solid separated from the parent solids.
clean (bool) – call clean() afterwards to have a clean shape
angleDegrees (float)

Returns:

a CQ object with the resulting solid selected.

Return type:

T

union(toUnion: Workplane | Solid | Compound | None = None, clean: bool = True, glue: bool = False, tol: float | None = None) → T[source]

Unions all of the items on the stack of toUnion with the current solid. If there is no current solid, the items in toUnion are unioned together.

Parameters:

self (T)
toUnion (Workplane | Solid | Compound | None) – a solid object, or a Workplane object having a solid
clean (bool) – call clean() afterwards to have a clean shape (default True)
glue (bool) – use a faster gluing mode for non-overlapping shapes (default False)
tol (float | None) – tolerance value for fuzzy bool operation mode (default None)

Raises:

ValueError if there is no solid to add to in the chain

Returns:

a Workplane object with the resulting object selected

Return type:

T

vLine(distance: float, forConstruction: bool = False) → T[source]

Make a vertical line from the current point the provided distance

Parameters:

self (T)
distance (float) –
1. distance from current point
forConstruction (bool)

Returns:

the Workplane object with the current point at the end of the new line

Return type:

T

vLineTo(yCoord: float, forConstruction: bool = False) → T[source]

Make a vertical line from the current point to the provided y coordinate.

Useful if it is more convenient to specify the end location rather than distance, as in vLine()

Parameters:

self (T)
yCoord (float) – y coordinate for the end of the line
forConstruction (bool)

Returns:

the Workplane object with the current point at the end of the new line

Return type:

T

val() → Vector | Location | Shape | Sketch[source]

Return the first value on the stack. If no value is present, current plane origin is returned.

Returns:: the first value on the stack.
Return type:: A CAD primitive

vals() → List[Vector | Location | Shape | Sketch][source]

get the values in the current list

Return type:: list of occ_impl objects
Returns:: the values of the objects on the stack.

Contrast with all(), which returns CQ objects for all of the items on the stack

vertices(selector: str | Selector | None = None, tag: str | None = None) → T[source]

Select the vertices of objects on the stack, optionally filtering the selection. If there are multiple objects on the stack, the vertices of all objects are collected and a list of all the distinct vertices is returned.

Parameters:

self (T)
selector (str | Selector | None) – optional Selector object, or string selector expression (see StringSyntaxSelector)
tag (str | None) – if set, search the tagged object instead of self

Returns:

a CQ object whose stack contains the distinct vertices of all objects on the current stack, after being filtered by the selector, if provided

Return type:

T

If there are no vertices for any objects on the current stack, an empty CQ object is returned

The typical use is to select the vertices of a single object on the stack. For example:

Workplane().box(1, 1, 1).faces("+Z").vertices().size()

returns 4, because the topmost face of a cube will contain four vertices. While this:

Workplane().box(1, 1, 1).faces().vertices().size()

returns 8, because a cube has a total of 8 vertices

Note Circles are peculiar, they have a single vertex at the center!

wedge(dx: float, dy: float, dz: float, xmin: float, zmin: float, xmax: float, zmax: float, pnt: ~typing.Tuple[float, float] | ~typing.Tuple[float, float, float] | ~cadquery.occ_impl.geom.Vector = Vector: (0.0, 0.0, 0.0), dir: ~typing.Tuple[float, float] | ~typing.Tuple[float, float, float] | ~cadquery.occ_impl.geom.Vector = Vector: (0.0, 0.0, 1.0), centered: bool | ~typing.Tuple[bool, bool, bool] = True, combine: bool | ~typing.Literal['cut', 'a', 's'] = True, clean: bool = True) → T[source]

Returns a 3D wedge with the specified dimensions for each point on the stack.

Parameters:

self (T)
dx (float) – Distance along the X axis
dy (float) – Distance along the Y axis
dz (float) – Distance along the Z axis
xmin (float) – The minimum X location
zmin (float) – The minimum Z location
xmax (float) – The maximum X location
zmax (float) – The maximum Z location
pnt (Tuple[float, float] | Tuple[float, float, float] | Vector) – A vector (or tuple) for the origin of the direction for the wedge
dir (Tuple[float, float] | Tuple[float, float, float] | Vector) – The direction vector (or tuple) for the major axis of the wedge
centered (bool | Tuple[bool, bool, bool]) – If True, the wedge will be centered around the reference point. If False, the corner of the wedge will be on the reference point and it will extend in the positive x, y and z directions. Can also use a 3-tuple to specify centering along each axis.
combine (bool | Literal['cut', 'a', 's']) – Whether the results should be combined with other solids on the stack (and each other)
clean (bool) – True to attempt to have the kernel clean up the geometry, False otherwise

Returns:

A wedge object for each point on the stack

Return type:

T

One wedge is created for each item on the current stack. If no items are on the stack, one wedge 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 wedges produced fused onto it otherwise, the result is the combination of all the produced wedges.

If combine is False, the result will be a list of the wedges produced.

wire(forConstruction: bool = False) → T[source]

Returns a CQ object with all pending edges connected into a wire.

All edges on the stack that can be combined will be combined into a single wire object, and other objects will remain on the stack unmodified. If there are no pending edges, this method will just return self.

Parameters:

self (T)
forConstruction (bool) – whether the wire should be used to make a solid, or if it is just for reference

Return type:

T

This method is primarily of use to plugin developers making utilities for 2D construction. This method should be called when a user operation implies that 2D construction is finished, and we are ready to begin working in 3d.

SEE ‘2D construction concepts’ for a more detailed explanation of how CadQuery handles edges, wires, etc.

Any non edges will still remain.

wires(selector: str | Selector | None = None, tag: str | None = None) → T[source]

Select the wires of objects on the stack, optionally filtering the selection. If there are multiple objects on the stack, the wires of all objects are collected and a list of all the distinct wires is returned.

Parameters:

self (T)
selector (str | Selector | None) – optional Selector object, or string selector expression (see StringSyntaxSelector)
tag (str | None) – if set, search the tagged object instead of self

Returns:

a CQ object whose stack contains all of the distinct wires of all objects on the current stack, filtered by the provided selector.

Return type:

T

If there are no wires for any objects on the current stack, an empty CQ object is returned

The typical use is to select the wires of a single object on the stack. For example:

Workplane().box(1, 1, 1).faces("+Z").wires().size()

returns 1, because a face typically only has one outer wire

workplane(offset: float = 0.0, invert: bool = False, centerOption: Literal['CenterOfMass', 'ProjectedOrigin', 'CenterOfBoundBox'] = 'ProjectedOrigin', origin: Tuple[float, float] | Tuple[float, float, float] | Vector | None = None) → T[source]

Creates a new 2D workplane, located relative to the first face on the stack.

Parameters:

self (T)
offset (float) – offset for the workplane in its normal direction . Default
invert (bool) – invert the normal direction from that of the face.
centerOption (string or None='ProjectedOrigin') – how local origin of workplane is determined.
origin (Tuple[float, float] | Tuple[float, float, float] | Vector | None) – origin for plane center, requires ‘ProjectedOrigin’ centerOption.

Return type:

Workplane object

The first element on the stack must be a face, a set of co-planar faces or a vertex. If a vertex, then the parent item on the chain immediately before the vertex must be a face.

The result will be a 2D working plane with a new coordinate system set up as follows:

The centerOption parameter sets how the center is defined. Options are ‘CenterOfMass’, ‘CenterOfBoundBox’, or ‘ProjectedOrigin’. ‘CenterOfMass’ and ‘CenterOfBoundBox’ are in relation to the selected face(s) or vertex (vertices). ‘ProjectedOrigin’ uses by default the current origin or the optional origin parameter (if specified) and projects it onto the plane defined by the selected face(s).

The Z direction will be the normal of the face, computed at the center point.

The X direction will be parallel to the x-y plane. If the workplane is parallel to the global x-y plane, the x direction of the workplane will co-incide with the global x direction.

Most commonly, the selected face will be planar, and the workplane lies in the same plane of the face ( IE, offset=0). Occasionally, it is useful to define a face offset from an existing surface, and even more rarely to define a workplane based on a face that is not planar.

workplaneFromTagged(name: str) → Workplane[source]

Copies the workplane from a tagged parent.

Parameters:: name (str) – tag to search for
Returns:: a CQ object with name’s workplane
Return type:: Workplane

cadquery.sortWiresByBuildOrder(wireList: List[Wire]) → List[List[Wire]][source]

Tries to determine how wires should be combined into faces.

Assume:: The wires make up one or more faces, which could have ‘holes’ Outer wires are listed ahead of inner wires there are no wires inside wires inside wires ( IE, islands – we can deal with that later on ) none of the wires are construction wires
Compute:: one or more sets of wires, with the outer wire listed first, and inner ones

Returns, list of lists.

Parameters:: wireList (List[Wire])
Return type:: List[List[Wire]]

class cadquery.occ_impl.shapes.CompSolid(obj: TopoDS_Shape)[source]

Bases: Shape, Mixin3D

a single compsolid

Parameters:: obj (TopoDS_Shape)

class cadquery.occ_impl.shapes.Compound(obj: TopoDS_Shape)[source]

Bases: Shape, Mixin3D

a collection of disconnected solids

Parameters:: obj (TopoDS_Shape)

ancestors(shape: Shape, kind: Literal['Vertex', 'Edge', 'Wire', 'Face', 'Shell', 'Solid', 'CompSolid', 'Compound']) → Compound[source]

Iterate over ancestors, i.e. shapes of same kind within shape that contain elements of self.

Parameters:

shape (Shape)
kind (Literal['Vertex', 'Edge', 'Wire', 'Face', 'Shell', 'Solid', 'CompSolid', 'Compound'])

Return type:

cut(*toCut: Shape, tol: float | None = None) → Compound[source]

Remove the positional arguments from this Shape.

Parameters:

tol (float | None) – Fuzzy mode tolerance
toCut (Shape)

Return type:

fuse(*toFuse: Shape, glue: bool = False, tol: float | None = None) → Compound[source]

Fuse shapes together

Parameters:

toFuse (Shape)
glue (bool)
tol (float | None)

Return type:

intersect(*toIntersect: Shape, tol: float | None = None) → Compound[source]

Intersection of the positional arguments and this Shape.

Parameters:

tol (float | None) – Fuzzy mode tolerance
toIntersect (Shape)

Return type:

classmethod makeCompound(listOfShapes: Iterable[Shape]) → Compound[source]

Create a compound out of a list of shapes

Parameters:: listOfShapes (Iterable[Shape])
Return type:: Compound

classmethod makeText(text: str, size: float, height: float, font: str = 'Arial', fontPath: str | None = None, kind: Literal['regular', 'bold', 'italic'] = 'regular', halign: Literal['center', 'left', 'right'] = 'center', valign: Literal['center', 'top', 'bottom'] = 'center', position: Plane = Plane(origin=(0.0, 0.0, 0.0), xDir=(1.0, 0.0, 0.0), normal=(0.0, 0.0, 1.0))) → Shape[source]

Create a 3D text

Parameters:

text (str)
size (float)
height (float)
font (str)
fontPath (str | None)
kind (Literal['regular', 'bold', 'italic'])
halign (Literal['center', 'left', 'right'])
valign (Literal['center', 'top', 'bottom'])
position (Plane)

Return type:

remove(*shape: Shape)[source]

Remove the specified shapes.

Parameters:: shape (Shape)

siblings(shape: Shape, kind: Literal['Vertex', 'Edge', 'Wire', 'Face', 'Shell', 'Solid', 'CompSolid', 'Compound'], level: int = 1) → Compound[source]

Iterate over siblings, i.e. shapes within shape that share subshapes of kind with the elements of self.

Parameters:

shape (Shape)
kind (Literal['Vertex', 'Edge', 'Wire', 'Face', 'Shell', 'Solid', 'CompSolid', 'Compound'])
level (int)

Return type:

class cadquery.occ_impl.shapes.Edge(obj: TopoDS_Shape)[source]

Bases: Shape, Mixin1D

A trimmed curve that represents the border of a face

Parameters:: obj (TopoDS_Shape)

arcCenter() → Vector[source]

Center of an underlying circle or ellipse geometry.

Return type:: Vector

close() → Edge | Wire[source]

Close an Edge

Return type:: Edge | Wire

hasPCurve(f: Face) → bool[source]

Check if self has a pcurve defined on f.

Parameters:: f (Face)
Return type:: bool

classmethod makeBezier(points: List[Vector]) → Edge[source]

Create a cubic Bézier Curve from the points.

Parameters:: points (List[Vector]) – a list of Vectors that represent the points. The edge will pass through the first and the last point, and the inner points are Bézier control points.
Returns:: An edge
Return type:: Edge

Makes an Ellipse centered at the provided point, having normal in the provided direction.

Parameters:

cls
x_radius (float) – x radius of the ellipse (along the x-axis of plane the ellipse should lie in)
y_radius (float) – y radius of the ellipse (along the y-axis of plane the ellipse should lie in)
pnt (Vector | Tuple[int | float, int | float] | Tuple[int | float, int | float, int | float]) – vector representing the center of the ellipse
dir (Vector | Tuple[int | float, int | float] | Tuple[int | float, int | float, int | float]) – vector representing the direction of the plane the ellipse should lie in
angle1 (float) – start angle of arc
angle2 (float) – end angle of arc (angle2 == angle1 return closed ellipse = default)
sense (Literal[-1, 1]) – clockwise (-1) or counter clockwise (1)
xdir (Vector | Tuple[int | float, int | float] | Tuple[int | float, int | float, int | float])

Returns:

an Edge

Return type:

Create a line between two points

Parameters:

v1 (Vector | Tuple[int | float, int | float] | Tuple[int | float, int | float, int | float]) – Vector that represents the first point
v2 (Vector | Tuple[int | float, int | float] | Tuple[int | float, int | float, int | float]) – Vector that represents the second point

Returns:

A linear edge between the two provided points

Return type:

classmethod makeSpline(listOfVector: List[Vector], tangents: Sequence[Vector] | None = None, periodic: bool = False, parameters: Sequence[float] | None = None, scale: bool = True, tol: float = 1e-06) → Edge[source]

Interpolate a spline through the provided points.

Parameters:

listOfVector (List[Vector]) – a list of Vectors that represent the points
tangents (Sequence[Vector] | None) – tuple of Vectors specifying start and finish tangent
periodic (bool) – creation of periodic curves
parameters (Sequence[float] | None) – the value of the parameter at each interpolation point. (The interpolated curve is represented as a vector-valued function of a scalar parameter.) If periodic == True, then len(parameters) must be len(intepolation points) + 1, otherwise len(parameters) must be equal to len(interpolation points).
scale (bool) – whether to scale the specified tangent vectors before interpolating. Each tangent is scaled, so it’s length is equal to the derivative of the Lagrange interpolated curve. I.e., set this to True, if you want to use only the direction of the tangent vectors specified by tangents, but not their magnitude.
tol (float) – tolerance of the algorithm (consult OCC documentation). Used to check that the specified points are not too close to each other, and that tangent vectors are not too short. (In either case interpolation may fail.)

Returns:

an Edge

Return type:

classmethod makeSplineApprox(listOfVector: List[Vector], tol: float = 0.001, smoothing: Tuple[float, float, float] | None = None, minDeg: int = 1, maxDeg: int = 6) → Edge[source]

Approximate a spline through the provided points.

Parameters:

listOfVector (List[Vector]) – a list of Vectors that represent the points
tol (float) – tolerance of the algorithm (consult OCC documentation).
smoothing (Tuple[float, float, float] | None) – optional tuple of 3 weights use for variational smoothing (default: None)
minDeg (int) – minimum spline degree. Enforced only when smothing is None (default: 1)
maxDeg (int) – maximum spline degree (default: 6)

Returns:

an Edge

Return type:

Makes a tangent arc from point v1, in the direction of v2 and ends at v3.

Parameters:

cls
v1 (Vector | Tuple[int | float, int | float] | Tuple[int | float, int | float, int | float]) – start vector
v2 (Vector | Tuple[int | float, int | float] | Tuple[int | float, int | float, int | float]) – tangent vector
v3 (Vector | Tuple[int | float, int | float] | Tuple[int | float, int | float, int | float]) – end vector

Returns:

an edge

Return type:

Makes a three point arc through the provided points

Parameters:

cls
v1 (Vector | Tuple[int | float, int | float] | Tuple[int | float, int | float, int | float]) – start vector
v2 (Vector | Tuple[int | float, int | float] | Tuple[int | float, int | float, int | float]) – middle vector
v3 (Vector | Tuple[int | float, int | float] | Tuple[int | float, int | float, int | float]) – end vector

Returns:

an edge object through the three points

Return type:

trim(u0: float | int, u1: float | int) → Edge[source]

Trim the edge in the parametric space to (u0, u1).

NB: this operation is done on the base geometry.

Parameters:

u0 (float | int)
u1 (float | int)

Return type:

class cadquery.occ_impl.shapes.Face(obj: TopoDS_Shape)[source]

Bases: Shape

a bounded surface that represents part of the boundary of a solid

Parameters:: obj (TopoDS_Shape)

Center() → Vector[source]

Returns:: The point of the center of mass of this Shape
Return type:: Vector

addHole(*inner: Wire | Edge) → Self[source]

Add one or more holes.

Parameters:: inner (Wire | Edge)
Return type:: Self

chamfer2D(d: float, vertices: Iterable[Vertex]) → Face[source]

Apply 2D chamfer to a face

Parameters:

d (float)
vertices (Iterable[Vertex])

Return type:

extend(d: float, umin: bool = True, umax: bool = True, vmin: bool = True, vmax: bool = True) → Face[source]

Extend a face. Does not work well in periodic directions.

Parameters:

d (float) – length of the extension.
umin (bool) – extend along the umin isoline.
umax (bool) – extend along the umax isoline.
vmin (bool) – extend along the vmin isoline.
vmax (bool) – extend along the vmax isoline.

Return type:

fillet2D(radius: float, vertices: Iterable[Vertex]) → Face[source]

Apply 2D fillet to a face

Parameters:

radius (float)
vertices (Iterable[Vertex])

Return type:

isoline(param: float | int, direction: Literal['u', 'v'] = 'v') → Edge[source]

Construct an isoline.

Parameters:

param (float | int)
direction (Literal['u', 'v'])

Return type:

isolines(params: Iterable[float | int], direction: Literal['u', 'v'] = 'v') → List[Edge][source]

Construct multiple isolines.

Parameters:

params (Iterable[float | int])
direction (Literal['u', 'v'])

Return type:

List[Edge]

classmethod makeFromWires(outerWire: Wire, innerWires: List[Wire] = []) → Face[source]

Makes a planar face from one or more wires

Parameters:

outerWire (Wire)
innerWires (List[Wire])

Return type:

classmethod makeNSidedSurface(edges: ~typing.Iterable[~cadquery.occ_impl.shapes.Edge | ~cadquery.occ_impl.shapes.Wire], constraints: ~typing.Iterable[~cadquery.occ_impl.shapes.Edge | ~cadquery.occ_impl.shapes.Wire | ~cadquery.occ_impl.geom.Vector | ~typing.Tuple[int | float, int | float] | ~typing.Tuple[int | float, int | float, int | float] | ~OCP.gp.gp_Pnt], continuity: ~OCP.GeomAbs.GeomAbs_Shape = <GeomAbs_Shape.GeomAbs_C0: 0>, degree: int = 3, nbPtsOnCur: int = 15, nbIter: int = 2, anisotropy: bool = False, tol2d: float = 1e-05, tol3d: float = 0.0001, tolAng: float = 0.01, tolCurv: float = 0.1, maxDeg: int = 8, maxSegments: int = 9) → Face[source]

Returns a surface enclosed by a closed polygon defined by ‘edges’ and ‘constraints’.

Parameters:

edges (list of edges or wires) – edges
constraints (list of points or edges) – constraints
continuity (GeomAbs_Shape) – OCC.Core.GeomAbs continuity condition
degree (int) – >=2
nbPtsOnCur (int) – number of points on curve >= 15
nbIter (int) – number of iterations >= 2
anisotropy (bool) – bool Anisotropy
tol2d (float) – 2D tolerance >0
tol3d (float) – 3D tolerance >0
tolAng (float) – angular tolerance
tolCurv (float) – tolerance for curvature >0
maxDeg (int) – highest polynomial degree >= 2
maxSegments (int) – greatest number of segments >= 2

Return type:

classmethod makeRuledSurface(edgeOrWire1: Edge, edgeOrWire2: Edge) → Face[source]
classmethod makeRuledSurface(edgeOrWire1: Wire, edgeOrWire2: Wire) → Face: makeRuledSurface(Edge|Wire,Edge|Wire) – Make a ruled surface Create a ruled surface out of two edges or wires. If wires are used then these must have the same number of edges

classmethod makeSplineApprox(points: List[List[Vector]], tol: float = 0.01, smoothing: Tuple[float, float, float] | None = None, minDeg: int = 1, maxDeg: int = 3) → Face[source]

Approximate a spline surface through the provided points.

Parameters:

points (List[List[Vector]]) – a 2D list of Vectors that represent the points
tol (float) – tolerance of the algorithm (consult OCC documentation).
smoothing (Tuple[float, float, float] | None) – optional tuple of 3 weights use for variational smoothing (default: None)
minDeg (int) – minimum spline degree. Enforced only when smothing is None (default: 1)
maxDeg (int) – maximum spline degree (default: 6)

Return type:

normalAt(u: float | int, v: float | int) → Tuple[Vector, Vector]

Computes the normal vector at the desired location on the face.

Returns:: a vector representing the direction
Parameters:: locationVector (a vector that lies on the surface.) – the location to compute the normal at. If none, the center of the face is used.
Return type:: Vector

Computes the normal vector at the desired location in the u,v parameter space.

Returns:

a vector representing the normal direction and the position

Parameters:

u – the u parametric location to compute the normal at.
v – the v parametric location to compute the normal at.
locationVector (Vector | Tuple[int | float, int | float] | Tuple[int | float, int | float, int | float] | None)

Return type:

normals(us: Iterable[float | int], vs: Iterable[float | int]) → Tuple[List[Vector], List[Vector]][source]

Computes the normal vectors at the desired locations in the u,v parameter space.

Returns:

a tuple of list of vectors representing the normal directions and the positions

Parameters:

us (Iterable[float | int]) – the u parametric locations to compute the normal at.
vs (Iterable[float | int]) – the v parametric locations to compute the normal at.

Return type:

Tuple[List[Vector], List[Vector]]

Computes the (u,v) pair closest to a given vector.

Returns:: (u, v) tuple
Parameters:: pt (a vector that lies on or close to the surface.) – the location to compute the normal at.
Return type:: Tuple[float, float]

Computes (u,v) pairs closest to given vectors.

Returns:

list of (u, v) tuples

Parameters:

pts (a list of vectors that lie on the surface.) – the points to compute the normals at.
tol (float)

Return type:

Tuple[List[float], List[float]]

positionAt(u: float | int, v: float | int) → Vector[source]

Computes the position vector at the desired location in the u,v parameter space.

Returns:

a vector representing the position

Parameters:

u (float | int) – the u parametric location to compute the normal at.
v (float | int) – the v parametric location to compute the normal at.

Return type:

positions(uvs: Iterable[Tuple[int | float, int | float]]) → List[Vector][source]

Computes position vectors at the desired locations in the u,v parameter space.

Returns:: list of vectors corresponding to the requested u,v positions
Parameters:: uvs (Iterable[Tuple[int | float, int | float]]) – iterable of u,v pairs.
Return type:: List[Vector]

thicken(thickness: float) → Solid[source]

Return a thickened face

Parameters:: thickness (float)
Return type:: Solid

toArcs(tolerance: float = 0.001) → Face[source]

Approximate planar face with arcs and straight line segments.

Parameters:: tolerance (float) – Approximation tolerance.
Return type:: Face

toPln() → gp_Pln[source]

Convert this face to a gp_Pln.

Note the Location of the resulting plane may not equal the center of this face, however the resulting plane will still contain the center of this face.

Return type:: gp_Pln

trim(outer: Wire, *inner: Wire) → Self

Trim the face in the (u,v) space to (u0, u1)x(v1, v2).

NB: this operation is done on the base geometry.

Trim the face using a polyline defined in the (u,v) space.

Trim using wires. The provided wires need to have a pcurve on self.

Parameters:

u0 (float | int)
u1 (float | int)
v0 (float | int)
v1 (float | int)
tol (float | int)

Return type:

Self

uvBounds() → Tuple[float, float, float, float][source]

Parametric bounds (u_min, u_max, v_min, v_max).

Return type:: Tuple[float, float, float, float]

class cadquery.occ_impl.shapes.Mixin1DProtocol(wrapped: TopoDS_Shape)[source]

Bases: ShapeProtocol, Protocol

Parameters:: wrapped (TopoDS_Shape)

class cadquery.occ_impl.shapes.Shape(obj: TopoDS_Shape)[source]

Bases: object

Represents a shape in the system. Wraps TopoDS_Shape.

Parameters:: obj (TopoDS_Shape)

Area() → float[source]

Returns:: The surface area of all faces in this Shape
Return type:: float

BoundingBox(tolerance: float | None = None) → BoundBox[source]

Create a bounding box for this Shape.

Parameters:: tolerance (float | None) – Tolerance value passed to BoundBox
Returns:: A BoundBox object for this Shape
Return type:: BoundBox

Center() → Vector[source]

Returns:: The point of the center of mass of this Shape
Return type:: Vector

CenterOfBoundBox(tolerance: float | None = None) → Vector[source]

Parameters:: tolerance (float | None) – Tolerance passed to the BoundingBox() method
Returns:: Center of the bounding box of this shape
Return type:: Vector

Closed() → bool[source]

Returns:: The closedness flag
Return type:: bool

static CombinedCenter(objects: Iterable[Shape]) → Vector[source]

Calculates the center of mass of multiple objects.

Parameters:: objects (Iterable[Shape]) – A list of objects with mass
Return type:: Vector

static CombinedCenterOfBoundBox(objects: List[Shape]) → Vector[source]

Calculates the center of a bounding box of multiple objects.

Parameters:: objects (List[Shape]) – A list of objects
Return type:: Vector

CompSolids() → List[CompSolid][source]

Returns:: All the compsolids in this Shape
Return type:: List[CompSolid]

Compounds() → List[Compound][source]

Returns:: All the compounds in this Shape
Return type:: List[Compound]

Edges() → List[Edge][source]

Returns:: All the edges in this Shape
Return type:: List[Edge]

Faces() → List[Face][source]

Returns:: All the faces in this Shape
Return type:: List[Face]

Shells() → List[Shell][source]

Returns:: All the shells in this Shape
Return type:: List[Shell]

Solids() → List[Solid][source]

Returns:: All the solids in this Shape
Return type:: List[Solid]

Vertices() → List[Vertex][source]

Returns:: All the vertices in this Shape
Return type:: List[Vertex]

Volume() → float[source]

Returns:: The volume of this Shape
Return type:: float

Wires() → List[Wire][source]

Returns:: All the wires in this Shape
Return type:: List[Wire]

ancestors(shape: Shape, kind: Literal['Vertex', 'Edge', 'Wire', 'Face', 'Shell', 'Solid', 'CompSolid', 'Compound']) → Compound[source]

Iterate over ancestors, i.e. shapes of same kind within shape that contain self.

Parameters:

shape (Shape)
kind (Literal['Vertex', 'Edge', 'Wire', 'Face', 'Shell', 'Solid', 'CompSolid', 'Compound'])

Return type:

classmethod cast(obj: TopoDS_Shape, forConstruction: bool = False) → Shape[source]

Returns the right type of wrapper, given a OCCT object

Parameters:

obj (TopoDS_Shape)
forConstruction (bool)

Return type:

static centerOfMass(obj: Shape) → Vector[source]

Calculates the center of ‘mass’ of an object.

Parameters:: obj (Shape) – Compute the center of mass of this object
Return type:: Vector

clean() → T[source]

Experimental clean using ShapeUpgrade

Parameters:: self (T)
Return type:: T

static computeMass(obj: Shape) → float[source]

Calculates the ‘mass’ of an object.

Parameters:: obj (Shape) – Compute the mass of this object
Return type:: float

copy(mesh: bool = False) → T[source]

Creates a new object that is a copy of this object.

Parameters:

self (T)
mesh (bool) – should I copy the triangulation too (default: False)

Returns:

a copy of the object

Return type:

T

cut(*toCut: Shape, tol: float | None = None) → Shape[source]

Remove the positional arguments from this Shape.

Parameters:

tol (float | None) – Fuzzy mode tolerance
toCut (Shape)

Return type:

distance(other: Shape) → float[source]

Minimal distance between two shapes

Parameters:: other (Shape)
Return type:: float

distances(*others: Shape) → Iterator[float][source]

Minimal distances to between self and other shapes

Parameters:: others (Shape)
Return type:: Iterator[float]

edges(selector: Selector | str | None = None) → Shape[source]

Select edges.

Parameters:: selector (Selector | str | None)
Return type:: Shape

export(fname: str, tolerance: float = 0.1, angularTolerance: float = 0.1, opt: Dict[str, Any] | None = None)[source]

Export Shape to file.

Parameters:

self (T)
fname (str)
tolerance (float)
angularTolerance (float)
opt (Dict[str, Any] | None)

exportBin(f: str | BytesIO) → bool[source]

Export this shape to a binary BREP file.

Parameters:: f (str | BytesIO)
Return type:: bool

exportBrep(f: str | BytesIO) → bool[source]

Export this shape to a BREP file

Parameters:: f (str | BytesIO)
Return type:: bool

exportStep(fileName: str, **kwargs) → IFSelect_ReturnStatus[source]

Export this shape to a STEP file.

kwargs is used to provide optional keyword arguments to configure the exporter.

Parameters:

fileName (str) – Path and filename for writing.
write_pcurves (bool) –
Enable or disable writing parametric curves to the STEP file. Default True.

If False, writes STEP file without pcurves. This decreases the size of the resulting STEP file.
precision_mode (int) – Controls the uncertainty value for STEP entities. Specify -1, 0, or 1. Default 0. See OCCT documentation.

Return type:

IFSelect_ReturnStatus

exportStl(fileName: str, tolerance: float = 0.001, angularTolerance: float = 0.1, ascii: bool = False, relative: bool = True, parallel: bool = True) → bool[source]

Exports a shape to a specified STL file.

Parameters:

fileName (str) – The path and file name to write the STL output to.
tolerance (float) – A linear deflection setting which limits the distance between a curve and its tessellation. Setting this value too low will result in large meshes that can consume computing resources. Setting the value too high can result in meshes with a level of detail that is too low. Default is 1e-3, which is a good starting point for a range of cases.
angularTolerance (float) – Angular deflection setting which limits the angle between subsequent segments in a polyline. Default is 0.1.
ascii (bool) – Export the file as ASCII (True) or binary (False) STL format. Default is binary.
relative (bool) – If True, tolerance will be scaled by the size of the edge being meshed. Default is True. Setting this value to True may cause large features to become faceted, or small features dense.
parallel (bool) – If True, OCCT will use parallel processing to mesh the shape. Default is True.

Return type:

bool

faces(selector: Selector | str | None = None) → Shape[source]

Select faces.

Parameters:: selector (Selector | str | None)
Return type:: Shape

Computes the intersections between the provided line and the faces of this Shape

Parameters:

point (Vector | Tuple[int | float, int | float] | Tuple[int | float, int | float, int | float]) – Base point for defining a line
axis (Vector | Tuple[int | float, int | float] | Tuple[int | float, int | float, int | float]) – Axis on which the line rests
tol (float) – Intersection tolerance
direction (Literal['AlongAxis', 'Opposite'] | None) – Valid values: “AlongAxis”, “Opposite”; If specified, will ignore all faces that are not in the specified direction including the face where the point lies if it is the case

Returns:

A list of intersected faces sorted by distance from point

fix() → T[source]

Try to fix shape if not valid

Parameters:: self (T)
Return type:: T

fuse(*toFuse: Shape, glue: bool = False, tol: float | None = None) → Shape[source]

Fuse the positional arguments with this Shape.

Parameters:

glue (bool) – Sets the glue option for the algorithm, which allows increasing performance of the intersection of the input shapes
tol (float | None) – Fuzzy mode tolerance
toFuse (Shape)

Return type:

geomType() → Literal['Vertex', 'Wire', 'Shell', 'Solid', 'Compound', 'PLANE', 'CYLINDER', 'CONE', 'SPHERE', 'TORUS', 'BEZIER', 'BSPLINE', 'REVOLUTION', 'EXTRUSION', 'OFFSET', 'OTHER', 'LINE', 'CIRCLE', 'ELLIPSE', 'HYPERBOLA', 'PARABOLA'][source]

Gets the underlying geometry type.

Implementations can return any values desired, but the values the user uses in type filters should correspond to these.

As an example, if a user does:

CQ(object).faces("%mytype")

The expectation is that the geomType attribute will return ‘mytype’

The return values depend on the type of the shape:

Vertex: always ‘Vertex’

Edge: LINE, CIRCLE, ELLIPSE, HYPERBOLA, PARABOLA, BEZIER,

BSPLINE, OFFSET, OTHER

Face: PLANE, CYLINDER, CONE, SPHERE, TORUS, BEZIER, BSPLINE,

REVOLUTION, EXTRUSION, OFFSET, OTHER

Solid: ‘Solid’

Shell: ‘Shell’

Compound: ‘Compound’

Wire: ‘Wire’

Returns:: A string according to the geometry type
Return type:: Literal[‘Vertex’, ‘Wire’, ‘Shell’, ‘Solid’, ‘Compound’, ‘PLANE’, ‘CYLINDER’, ‘CONE’, ‘SPHERE’, ‘TORUS’, ‘BEZIER’, ‘BSPLINE’, ‘REVOLUTION’, ‘EXTRUSION’, ‘OFFSET’, ‘OTHER’, ‘LINE’, ‘CIRCLE’, ‘ELLIPSE’, ‘HYPERBOLA’, ‘PARABOLA’]

hashCode() → int[source]

Returns a hashed value denoting this shape. It is computed from the TShape and the Location. The Orientation is not used.

Return type:: int

classmethod importBin(f: str | BytesIO) → Shape[source]

Import shape from a binary BREP file.

Parameters:: f (str | BytesIO)
Return type:: Shape

classmethod importBrep(f: str | BytesIO) → Shape[source]

Import shape from a BREP file

Parameters:: f (str | BytesIO)
Return type:: Shape

intersect(*toIntersect: Shape, tol: float | None = None) → Shape[source]

Intersection of the positional arguments and this Shape.

Parameters:

tol (float | None) – Fuzzy mode tolerance
toIntersect (Shape)

Return type:

isEqual(other: Shape) → bool[source]

Returns True if two shapes are equal, i.e. if they share the same TShape with the same Locations and Orientations. Also see isSame().

Parameters:: other (Shape)
Return type:: bool

isNull() → bool[source]

Returns true if this shape is null. In other words, it references no underlying shape with the potential to be given a location and an orientation.

Return type:: bool

isSame(other: Shape) → bool[source]

Returns True if other and this shape are same, i.e. if they share the same TShape with the same Locations. Orientations may differ. Also see isEqual()

Parameters:: other (Shape)
Return type:: bool

isValid() → bool[source]

Returns True if no defect is detected on the shape S or any of its subshapes. See the OCCT docs on BRepCheck_Analyzer::IsValid for a full description of what is checked.

Return type:: bool

locate(loc: Location) → T[source]

Apply a location in absolute sense to self.

Parameters:

self (T)
loc (Location)

Return type:

T

located(loc: Location) → T[source]

Apply a location in absolute sense to a copy of self.

Parameters:

self (T)
loc (Location)

Return type:

T

location() → Location[source]

Return the current location

Return type:: Location

static matrixOfInertia(obj: Shape) → List[List[float]][source]

Calculates the matrix of inertia of an object. Since the part’s density is unknown, this result is inertia/density with units of [1/length]. :param obj: Compute the matrix of inertia of this object

Parameters:: obj (Shape)
Return type:: List[List[float]]

mesh(tolerance: float, angularTolerance: float = 0.1)[source]

Generate triangulation if none exists.

Parameters:

tolerance (float)
angularTolerance (float)

Applies a mirror transform to this Shape. Does not duplicate objects about the plane.

Parameters:

mirrorPlane (Literal['XY', 'YX', 'XZ', 'ZX', 'YZ', 'ZY'] | ~cadquery.occ_impl.geom.Vector | ~typing.Tuple[int | float, int | float] | ~typing.Tuple[int | float, int | float, int | float]) – The direction of the plane to mirror about - one of ‘XY’, ‘XZ’ or ‘YZ’
basePointVector (Vector | Tuple[int | float, int | float] | Tuple[int | float, int | float, int | float]) – The origin of the plane to mirror about

Returns:

The mirrored shape

Return type:

move(loc: Location) → T[source]

Apply a location in relative sense (i.e. update current location) to self.

Apply translation and rotation in relative sense (i.e. update current location) to self.

Apply a VectorLike in relative sense (i.e. update current location) to self.

Parameters:

self (T)
loc (Location)

Return type:

T

moved(loc1: Location, loc2: Location, *locs: Location) → T

moved(locs: Sequence[Location]) → T

moved(loc: Location) → T

Apply a location in relative sense (i.e. update current location) to a copy of self.

Apply multiple locations.

Apply translation and rotation in relative sense to a copy of self.

Apply a VectorLike in relative sense to a copy of self.

Apply multiple VectorLikes in relative sense to a copy of self.

Parameters:

self (T)
loc (Location)

Return type:

T

remove(*subshape: Shape) → Self[source]

Remove subshapes.

Parameters:: subshape (Shape)
Return type:: Self

replace(old: Shape, *new: Shape) → Self[source]

Replace old subshape with new subshapes.

Parameters:

old (Shape)
new (Shape)

Return type:

Self

Rotates a shape around an axis.

Parameters:

self (T)
startVector (either a 3-tuple or a Vector) – start point of rotation axis
endVector (either a 3-tuple or a Vector) – end point of rotation axis
angleDegrees (float) – angle to rotate, in degrees

Returns:

a copy of the shape, rotated

Return type:

T

scale(factor: float) → Shape[source]

Scales this shape through a transformation.

Parameters:: factor (float)
Return type:: Shape

shells(selector: Selector | str | None = None) → Shape[source]

Select shells.

Parameters:: selector (Selector | str | None)
Return type:: Shape

siblings(shape: Shape, kind: Literal['Vertex', 'Edge', 'Wire', 'Face', 'Shell', 'Solid', 'CompSolid', 'Compound'], level: int = 1) → Compound[source]

Iterate over siblings, i.e. shapes within shape that share subshapes of kind with self.

Parameters:

shape (Shape)
kind (Literal['Vertex', 'Edge', 'Wire', 'Face', 'Shell', 'Solid', 'CompSolid', 'Compound'])
level (int)

Return type:

solids(selector: Selector | str | None = None) → Shape[source]

Select solids.

Parameters:: selector (Selector | str | None)
Return type:: Shape

split(*splitters: Shape) → Shape[source]

Split this shape with the positional arguments.

Parameters:: splitters (Shape)
Return type:: Shape

toNURBS() → T[source]

Return a NURBS representation of a given shape.

Parameters:: self (T)
Return type:: T

toSplines(degree: int = 3, tolerance: float = 0.001, nurbs: bool = False) → T[source]

Approximate shape with b-splines of the specified degree.

Parameters:

self (T)
degree (int) – Maximum degree.
tolerance (float) – Approximation tolerance.
nurbs (bool) – Use rational splines.

Return type:

T

toVtkPolyData(tolerance: float | None = None, angularTolerance: float | None = None, normals: bool = False) → vtkPolyData[source]

Convert shape to vtkPolyData

Parameters:

tolerance (float | None)
angularTolerance (float | None)
normals (bool)

Return type:

vtkPolyData

transformGeometry(tMatrix: Matrix) → Shape[source]

Transforms this shape by tMatrix.

WARNING: transformGeometry will sometimes convert lines and circles to splines, but it also has the ability to handle skew and stretching transformations.

If your transformation is only translation and rotation, it is safer to use transformShape(), which doesn’t change the underlying type of the geometry, but cannot handle skew transformations.

Parameters:: tMatrix (Matrix) – The transformation matrix
Returns:: a copy of the object, but with geometry transformed instead of just rotated.
Return type:: Shape

transformShape(tMatrix: Matrix) → Shape[source]

Transforms this Shape by tMatrix. Also see transformGeometry().

Parameters:: tMatrix (Matrix) – The transformation matrix
Returns:: a copy of the object, transformed by the provided matrix, with all objects keeping their type
Return type:: Shape

Translates this shape through a transformation.

Parameters:

self (T)
vector (Vector | Tuple[int | float, int | float] | Tuple[int | float, int | float, int | float])

Return type:

T

vertices(selector: Selector | str | None = None) → Shape[source]

Select vertices.

Parameters:: selector (Selector | str | None)
Return type:: Shape

wires(selector: Selector | str | None = None) → Shape[source]

Select wires.

Parameters:: selector (Selector | str | None)
Return type:: Shape

class cadquery.occ_impl.shapes.ShapeProtocol(wrapped: TopoDS_Shape)[source]

Bases: Protocol

Parameters:: wrapped (TopoDS_Shape)

class cadquery.occ_impl.shapes.Shell(obj: TopoDS_Shape)[source]

Bases: Shape

the outer boundary of a surface

Parameters:: obj (TopoDS_Shape)

classmethod makeShell(listOfFaces: Iterable[Face]) → Shell[source]

Makes a shell from faces.

Parameters:: listOfFaces (Iterable[Face])
Return type:: Shell

class cadquery.occ_impl.shapes.Solid(obj: TopoDS_Shape)[source]

Bases: Shape, Mixin3D

a single solid

Parameters:: obj (TopoDS_Shape)

addCavity(*shells: Shell | Solid) → Self[source]

Add one or more cavities.

Parameters:: shells (Shell | Solid)
Return type:: Self

Attempt to extrude the list of wires into a prismatic solid in the provided direction

Parameters:

outerWire (Wire) – the outermost wire
innerWires (List[Wire]) – a list of inner wires
vecNormal (Vector | Tuple[int | float, int | float] | Tuple[int | float, int | float, int | float]) – a vector along which to extrude the wires
taper (float | int) – taper angle, default=0

Returns:

a Solid object

Return type:

The wires must not intersect

Extruding wires is very non-trivial. Nested wires imply very different geometry, and there are many geometries that are invalid. In general, the following conditions must be met:

all wires must be closed
there cannot be any intersecting or self-intersecting wires
wires must be listed from outside in
more than one levels of nesting is not supported reliably

This method will attempt to sort the wires, but there is much work remaining to make this method reliable.

Creates a ‘twisted prism’ by extruding, while simultaneously rotating around the extrusion vector.

Though the signature may appear to be similar enough to extrudeLinear to merit combining them, the construction methods used here are different enough that they should be separate.

At a high level, the steps followed are:

accept a set of wires
create another set of wires like this one, but which are transformed and rotated
create a ruledSurface between the sets of wires
create a shell and compute the resulting object

Parameters:

outerWire (Wire) – the outermost wire
innerWires (List[Wire]) – a list of inner wires
vecCenter (Vector | Tuple[int | float, int | float] | Tuple[int | float, int | float, int | float]) – the center point about which to rotate. the axis of rotation is defined by vecNormal, located at vecCenter.
vecNormal (Vector | Tuple[int | float, int | float] | Tuple[int | float, int | float, int | float]) – a vector along which to extrude the wires
angleDegrees (float | int) – the angle to rotate through while extruding

Returns:

a Solid object

Return type:

innerShells() → List[Shell][source]

Returns inner shells.

Return type:: List[Shell]

classmethod interpPlate(surf_edges, surf_pts, thickness, degree=3, nbPtsOnCur=15, nbIter=2, anisotropy=False, tol2d=1e-05, tol3d=0.0001, tolAng=0.01, tolCurv=0.1, maxDeg=8, maxSegments=9) → Solid | Face[source]

Returns a plate surface that is ‘thickness’ thick, enclosed by ‘surf_edge_pts’ points, and going through ‘surf_pts’ points.

Parameters:

surf_edges – list of [x,y,z] float ordered coordinates or list of ordered or unordered wires
surf_pts – list of [x,y,z] float coordinates (uses only edges if [])
thickness – thickness may be negative or positive depending on direction, (returns 2D surface if 0)
degree – >=2
nbPtsOnCur – number of points on curve >= 15
nbIter – number of iterations >= 2
anisotropy – bool Anisotropy
tol2d – 2D tolerance >0
tol3d – 3D tolerance >0
tolAng – angular tolerance
tolCurv – tolerance for curvature >0
maxDeg – highest polynomial degree >= 2
maxSegments – greatest number of segments >= 2

Return type:

Solid | Face

static isSolid(obj: Shape) → bool[source]

Returns true if the object is a solid, false otherwise

Parameters:: obj (Shape)
Return type:: bool

classmethod makeBox(length,width,height,[pnt,dir]) -- Make a box located in pnt with the dimensions (length,width,height)[source]

By default pnt=Vector(0,0,0) and dir=Vector(0,0,1)

Parameters:

length (float)
width (float)
height (float)
pnt (Vector | Tuple[int | float, int | float] | Tuple[int | float, int | float, int | float])
dir (Vector | Tuple[int | float, int | float] | Tuple[int | float, int | float, int | float])

Return type:

Make a cone with given radii and height By default pnt=Vector(0,0,0), dir=Vector(0,0,1) and angle=360

Parameters:

radius1 (float)
radius2 (float)
height (float)
pnt (Vector | Tuple[int | float, int | float] | Tuple[int | float, int | float, int | float])
dir (Vector | Tuple[int | float, int | float] | Tuple[int | float, int | float, int | float])
angleDegrees (float)

Return type:

makeCylinder(radius,height,[pnt,dir,angle]) – Make a cylinder with a given radius and height By default pnt=Vector(0,0,0),dir=Vector(0,0,1) and angle=360

Parameters:

radius (float)
height (float)
pnt (Vector | Tuple[int | float, int | float] | Tuple[int | float, int | float, int | float])
dir (Vector | Tuple[int | float, int | float] | Tuple[int | float, int | float, int | float])
angleDegrees (float)

Return type:

classmethod makeLoft(listOfWire: List[Wire], ruled: bool = False) → Solid[source]

makes a loft from a list of wires The wires will be converted into faces when possible– it is presumed that nobody ever actually wants to make an infinitely thin shell for a real FreeCADPart.

Parameters:

listOfWire (List[Wire])
ruled (bool)

Return type:

classmethod makeSolid(shell: Shell) → Solid[source]

Makes a solid from a single shell.

Parameters:: shell (Shell)
Return type:: Solid

Make a sphere with a given radius By default pnt=Vector(0,0,0), dir=Vector(0,0,1), angle1=0, angle2=90 and angle3=360

Parameters:

radius (float)
pnt (Vector | Tuple[int | float, int | float] | Tuple[int | float, int | float, int | float])
dir (Vector | Tuple[int | float, int | float] | Tuple[int | float, int | float, int | float])
angleDegrees1 (float)
angleDegrees2 (float)
angleDegrees3 (float)

Return type:

makeTorus(radius1,radius2,[pnt,dir,angle1,angle2,angle]) – Make a torus with a given radii and angles By default pnt=Vector(0,0,0),dir=Vector(0,0,1),angle1=0 ,angle1=360 and angle=360

Parameters:

radius1 (float)
radius2 (float)
pnt (Vector | Tuple[int | float, int | float] | Tuple[int | float, int | float, int | float])
dir (Vector | Tuple[int | float, int | float] | Tuple[int | float, int | float, int | float])
angleDegrees1 (float)
angleDegrees2 (float)

Return type:

Make a wedge located in pnt By default pnt=Vector(0,0,0) and dir=Vector(0,0,1)

Parameters:

dx (float)
dy (float)
dz (float)
xmin (float)
zmin (float)
xmax (float)
zmax (float)
pnt (Vector | Tuple[int | float, int | float] | Tuple[int | float, int | float, int | float])
dir (Vector | Tuple[int | float, int | float] | Tuple[int | float, int | float, int | float])

Return type:

outerShell() → Shell[source]

Returns outer shell.

Return type:: Shell

Attempt to revolve the list of wires into a solid in the provided direction

Parameters:

outerWire (Wire) – the outermost wire
innerWires (List[Wire]) – a list of inner wires
angleDegrees (float, anything less than 360 degrees will leave the shape open) – the angle to revolve through.
axisStart (Vector | Tuple[int | float, int | float] | Tuple[int | float, int | float, int | float]) – the start point of the axis of rotation
axisEnd (Vector | Tuple[int | float, int | float] | Tuple[int | float, int | float, int | float]) – the end point of the axis of rotation

Returns:

a Solid object

Return type:

The wires must not intersect

all wires must be closed
there cannot be any intersecting or self-intersecting wires
wires must be listed from outside in
more than one levels of nesting is not supported reliably
the wire(s) that you’re revolving cannot be centered

This method will attempt to sort the wires, but there is much work remaining to make this method reliable.

classmethod sweep(outerWire: Wire, innerWires: List[Wire], path: Wire | Edge, makeSolid: bool = True, isFrenet: bool = False, mode: Vector | Wire | Edge | None = None, transitionMode: Literal['transformed', 'round', 'right'] = 'transformed') → Shape[source]

classmethod sweep(face: Face, path: Wire | Edge, makeSolid: bool = True, isFrenet: bool = False, mode: Vector | Wire | Edge | None = None, transitionMode: Literal['transformed', 'round', 'right'] = 'transformed') → Shape

Attempt to sweep the list of wires into a prismatic solid along the provided path

Parameters:

outerWire (Wire) – the outermost wire
innerWires (List[Wire]) – a list of inner wires
path (Wire | Edge) – The wire to sweep the face resulting from the wires over
makeSolid (bool) – return Solid or Shell (default True)
isFrenet (bool) – Frenet mode (default False)
mode (Vector | Wire | Edge | None) – additional sweep mode parameters
transitionMode (Literal['transformed', 'round', 'right']) – handling of profile orientation at C1 path discontinuities. Possible values are {‘transformed’,’round’, ‘right’} (default: ‘right’).

Returns:

a Solid object

Return type:

Multi section sweep. Only single outer profile per section is allowed.

Parameters:

profiles (Iterable[Wire | Face]) – list of profiles
path (Wire | Edge) – The wire to sweep the face resulting from the wires over
mode (Vector | Wire | Edge | None) – additional sweep mode parameters.
makeSolid (bool)
isFrenet (bool)

Returns:

a Solid object

Return type:

class cadquery.occ_impl.shapes.Vertex(obj: TopoDS_Shape, forConstruction: bool = False)[source]

Bases: Shape

A Single Point in Space

Parameters:

obj (TopoDS_Shape)
forConstruction (bool)

Center() → Vector[source]

The center of a vertex is itself!

Return type:: Vector

class cadquery.occ_impl.shapes.Wire(obj: TopoDS_Shape)[source]

Bases: Shape, Mixin1D

A series of connected, ordered Edges, that typically bounds a Face

Parameters:: obj (TopoDS_Shape)

Vertices() → List[Vertex][source]

Ordered list of vertices of the wire.

Return type:: List[Vertex]

classmethod assembleEdges(listOfEdges: Iterable[Edge]) → Wire[source]

Attempts to build a wire that consists of the edges in the provided list

Parameters:

cls
listOfEdges (Iterable[Edge]) – a list of Edge objects. The edges are not to be consecutive.

Returns:

a wire with the edges assembled

Return type:

BRepBuilderAPI_MakeWire::Error() values:

BRepBuilderAPI_WireDone = 0
BRepBuilderAPI_EmptyWire = 1
BRepBuilderAPI_DisconnectedWire = 2
BRepBuilderAPI_NonManifoldWire = 3

chamfer2D(d: float, vertices: Iterable[Vertex]) → Wire[source]

Apply 2D chamfer to a wire

Parameters:

d (float)
vertices (Iterable[Vertex])

Return type:

close() → Wire[source]

Close a Wire

Return type:: Wire

classmethod combine(listOfWires: Iterable[Wire | Edge], tol: float = 1e-09) → List[Wire][source]

Attempt to combine a list of wires and edges into a new wire.

Parameters:

cls
listOfWires (Iterable[Wire | Edge])
tol (float) – default 1e-9

Returns:

List[Wire]

Return type:

List[Wire]

fillet(radius: float, vertices: Iterable[Vertex] | None = None) → Wire[source]

Apply 2D or 3D fillet to a wire

Parameters:

radius (float) – the radius of the fillet, must be > zero
vertices (Iterable[Vertex] | None) – the vertices to delete (where the fillet will be applied). By default all vertices are deleted except ends of open wires.

Returns:

A wire with filleted corners

Return type:

fillet2D(radius: float, vertices: Iterable[Vertex]) → Wire[source]

Apply 2D fillet to a wire

Parameters:

radius (float)
vertices (Iterable[Vertex])

Return type:

Makes a Circle centered at the provided point, having normal in the provided direction

Parameters:

radius (float) – floating point radius of the circle, must be > 0
center (Vector | Tuple[int | float, int | float] | Tuple[int | float, int | float, int | float]) – vector representing the center of the circle
normal (Vector | Tuple[int | float, int | float] | Tuple[int | float, int | float, int | float]) – vector representing the direction of the plane the circle should lie in

Return type:

Makes an Ellipse centered at the provided point, having normal in the provided direction

Parameters:

x_radius (float) – floating point major radius of the ellipse (x-axis), must be > 0
y_radius (float) – floating point minor radius of the ellipse (y-axis), must be > 0
center (Vector | Tuple[int | float, int | float] | Tuple[int | float, int | float, int | float]) – vector representing the center of the circle
normal (Vector | Tuple[int | float, int | float] | Tuple[int | float, int | float, int | float]) – vector representing the direction of the plane the circle should lie in
angle1 (float) – start angle of arc
angle2 (float) – end angle of arc
rotation_angle (float) – angle to rotate the created ellipse / arc
xDir (Vector | Tuple[int | float, int | float] | Tuple[int | float, int | float, int | float])
closed (bool)

Return type:

Make a helix with a given pitch, height and radius By default a cylindrical surface is used to create the helix. If the fourth parameter is set (the apex given in degree) a conical surface is used instead’

Parameters:

pitch (float)
height (float)
radius (float)
center (Vector | Tuple[int | float, int | float] | Tuple[int | float, int | float, int | float])
dir (Vector | Tuple[int | float, int | float] | Tuple[int | float, int | float, int | float])
angle (float)
lefthand (bool)

Return type:

Construct a polygonal wire from points.

Parameters:

listOfVertices (Iterable[Vector | Tuple[int | float, int | float] | Tuple[int | float, int | float, int | float]])
forConstruction (bool)
close (bool)

Return type:

offset2D(d: float, kind: Literal['arc', 'intersection', 'tangent'] = 'arc') → List[Wire][source]

Offsets a planar wire

Parameters:

d (float)
kind (Literal['arc', 'intersection', 'tangent'])

Return type:

List[Wire]

stitch(other: Wire) → Wire[source]

Attempt to stitch wires

Parameters:: other (Wire)
Return type:: Wire

cadquery.occ_impl.shapes.box(w: float, l: float, h: float) → Shape[source]

Construct a solid box.

Parameters:

w (float)
l (float)
h (float)

Return type:

Fill edges/wire possibly obeying constraints and try to connect smoothly to the context shape.

Parameters:

s (Shape)
ctx (Shape)
constraints (Sequence[Shape | Vector | Tuple[int | float, int | float] | Tuple[int | float, int | float, int | float]])

Return type:

cadquery.occ_impl.shapes.chamfer(s: Shape, e: Shape, d: float) → Shape[source]

Chamfer selected edges in a given shell or solid.

Parameters:

s (Shape)
e (Shape)
d (float)

Return type:

cadquery.occ_impl.shapes.check(s: Shape, results: List[Tuple[List[Shape], Any]] | None = None, tol: float | None = None) → bool[source]

Check if a shape is valid.

Parameters:

s (Shape)
results (List[Tuple[List[Shape], Any]] | None)
tol (float | None)

Return type:

bool

cadquery.occ_impl.shapes.circle(r: float) → Shape[source]

Construct a circle.

Parameters:: r (float)
Return type:: Shape

cadquery.occ_impl.shapes.clean(s: Shape) → Shape[source]

Clean superfluous edges and faces.

Parameters:: s (Shape)
Return type:: Shape

cadquery.occ_impl.shapes.closest(s1: Shape, s2: Shape) → Tuple[Vector, Vector][source]

Closest points between two shapes.

Parameters:

s1 (Shape)
s2 (Shape)

Return type:

Tuple[Vector, Vector]

cadquery.occ_impl.shapes.compound(*s: cadquery.occ_impl.shapes.Shape) → cadquery.occ_impl.shapes.Shape[source]

Build compound from shapes.

compound(s: Sequence[cadquery.occ_impl.shapes.Shape]) -> cadquery.occ_impl.shapes.Shape

Build compound from a sequence of shapes.

Parameters:: s (Shape)
Return type:: Shape

cadquery.occ_impl.shapes.cone(d1: float | int, d2: float | int, h: float | int) → cadquery.occ_impl.shapes.Shape[source]

Construct a partial solid cone.

cone(d: Union[float, int], h: Union[float, int]) -> cadquery.occ_impl.shapes.Shape

Construct a full solid cone.

Parameters:

d1 (float | int)
d2 (float | int)
h (float | int)

Return type:

cadquery.occ_impl.shapes.cut(s1: Shape, s2: Shape, tol: float = 0.0, glue: Literal['partial', 'full', None] = None) → Shape[source]

Subtract two shapes.

Parameters:

s1 (Shape)
s2 (Shape)
tol (float)
glue (Literal['partial', 'full', None])

Return type:

cadquery.occ_impl.shapes.cylinder(d: float, h: float) → Shape[source]

Construct a solid cylinder.

Parameters:

d (float)
h (float)

Return type:

cadquery.occ_impl.shapes.downcast(obj: TopoDS_Shape) → TopoDS_Shape[source]

Downcasts a TopoDS object to suitable specialized type

Parameters:: obj (TopoDS_Shape)
Return type:: TopoDS_Shape

cadquery.occ_impl.shapes.edgeOn(base: cadquery.occ_impl.shapes.Shape, pts: Sequence[Tuple[int | float, int | float]], periodic: bool = False, tol: float = 1e-06) → cadquery.occ_impl.shapes.Shape[source]

Build an edge on a face from points in (u,v) space.

_(fbase: cadquery.occ_impl.shapes.Shape, edg: cadquery.occ_impl.shapes.Shape, *edgs: cadquery.occ_impl.shapes.Shape, tol: float = 1e-06, N: int = 20)

Map one or more edges onto a base face in the u,v space.

Parameters:

base (Shape)
pts (Sequence[Tuple[int | float, int | float]])
periodic (bool)
tol (float)

Return type:

cadquery.occ_impl.shapes.edgesToWires(edges: Iterable[Edge], tol: float = 1e-06) → List[Wire][source]

Convert edges to a list of wires.

Parameters:

edges (Iterable[Edge])
tol (float)

Return type:

List[Wire]

cadquery.occ_impl.shapes.ellipse(r1: float, r2: float) → Shape[source]

Construct an ellipse.

Parameters:

r1 (float)
r2 (float)

Return type:

Extrude a shape.

Parameters:

s (Shape)
d (Vector | Tuple[int | float, int | float] | Tuple[int | float, int | float, int | float])

Return type:

cadquery.occ_impl.shapes.face(*s: cadquery.occ_impl.shapes.Shape) → cadquery.occ_impl.shapes.Shape[source]

Build face from edges or wires.

face(s: Sequence[cadquery.occ_impl.shapes.Shape]) -> cadquery.occ_impl.shapes.Shape

Build face from a sequence of edges or wires.

Parameters:: s (Shape)
Return type:: Shape

cadquery.occ_impl.shapes.faceOn(base: Shape, *fcs: Shape, tol=1e-06, N=20) → Shape[source]

Build face(s) on base by mapping planar face(s) onto the (u,v) space of base.

Parameters:

base (Shape)
fcs (Shape)

Return type:

Fill edges/wire possibly obeying constraints.

Parameters:

s (Shape)
constraints (Sequence[Shape | Vector | Tuple[int | float, int | float] | Tuple[int | float, int | float, int | float]])

Return type:

cadquery.occ_impl.shapes.fillet(s: Shape, e: Shape, r: float) → Shape[source]

Fillet selected edges in a given shell or solid.

Parameters:

s (Shape)
e (Shape)
r (float)

Return type:

cadquery.occ_impl.shapes.fix(obj: TopoDS_Shape) → TopoDS_Shape[source]

Fix a TopoDS object to suitable specialized type

Parameters:: obj (TopoDS_Shape)
Return type:: TopoDS_Shape

cadquery.occ_impl.shapes.fuse(s1: Shape, s2: Shape, *shapes: Shape, tol: float = 0.0, glue: Literal['partial', 'full', None] = None) → Shape[source]

Fuse at least two shapes.

Parameters:

s1 (Shape)
s2 (Shape)
shapes (Shape)
tol (float)
glue (Literal['partial', 'full', None])

Return type:

cadquery.occ_impl.shapes.imprint(*shapes: Shape, tol: float = 0.0, glue: Literal['partial', 'full', None] = 'full', history: Dict[Shape | str, Shape] | None = None) → Shape[source]

Imprint arbitrary number of shapes.

Parameters:

shapes (Shape)
tol (float)
glue (Literal['partial', 'full', None])
history (Dict[Shape | str, Shape] | None)

Return type:

cadquery.occ_impl.shapes.intersect(s1: Shape, s2: Shape, tol: float = 0.0, glue: Literal['partial', 'full', None] = None) → Shape[source]

Intersect two shapes.

Parameters:

s1 (Shape)
s2 (Shape)
tol (float)
glue (Literal['partial', 'full', None])

Return type:

cadquery.occ_impl.shapes.loft(s: Sequence[cadquery.occ_impl.shapes.Shape], cap: bool = False, ruled: bool = False, continuity: Literal['C1', 'C2', 'C3'] = 'C2', parametrization: Literal['uniform', 'chordal', 'centripetal'] = 'uniform', degree: int = 3, compat: bool = True, smoothing: bool = False, weights: Tuple[float, float, float] = (1, 1, 1)) → cadquery.occ_impl.shapes.Shape[source]

Loft edges, wires or faces. For faces cap has no effect. Do not mix faces with other types.

loft(*s: cadquery.occ_impl.shapes.Shape, cap: bool = False, ruled: bool = False, continuity: Literal[‘C1’, ‘C2’, ‘C3’] = ‘C2’, parametrization: Literal[‘uniform’, ‘chordal’, ‘centripetal’] = ‘uniform’, degree: int = 3, compat: bool = True, smoothing: bool = False, weights: Tuple[float, float, float] = (1, 1, 1)) -> cadquery.occ_impl.shapes.Shape

Variadic loft overload.

Parameters:

s (Sequence[Shape])
cap (bool)
ruled (bool)
continuity (Literal['C1', 'C2', 'C3'])
parametrization (Literal['uniform', 'chordal', 'centripetal'])
degree (int)
compat (bool)
smoothing (bool)
weights (Tuple[float, float, float])

Return type:

cadquery.occ_impl.shapes.offset(s: Shape, t: float, cap=True, both: bool = False, tol: float = 1e-06) → Shape[source]

Offset or thicken faces or shells.

Parameters:

s (Shape)
t (float)
both (bool)
tol (float)

Return type:

cadquery.occ_impl.shapes.plane(w: float | int, l: float | int) → cadquery.occ_impl.shapes.Shape[source]

Construct a finite planar face.

plane() -> cadquery.occ_impl.shapes.Shape

Construct an infinite planar face.

This is a crude approximation. Truly infinite faces in OCCT do not work as expected in all contexts.

Parameters:

w (float | int)
l (float | int)

Return type:

Construct a polygon (closed polyline) from points.

Parameters:: pts (Vector | Tuple[int | float, int | float] | Tuple[int | float, int | float, int | float])
Return type:: Shape

Construct a polyline from points.

Parameters:: pts (Vector | Tuple[int | float, int | float] | Tuple[int | float, int | float, int | float])
Return type:: Shape

cadquery.occ_impl.shapes.project(s: Shape, base: Shape, continuity: Literal['C1', 'C2', 'C3'] = 'C2', degree: int = 3, maxseg: int = 30, tol: float = 0.0001)[source]

Project s onto base using normal projection.

Parameters:

s (Shape)
base (Shape)
continuity (Literal['C1', 'C2', 'C3'])
degree (int)
maxseg (int)
tol (float)

cadquery.occ_impl.shapes.rect(w: float, h: float) → Shape[source]

Construct a rectangle.

Parameters:

w (float)
h (float)

Return type:

Revolve a shape.

Parameters:

s (Shape)
p (Vector | Tuple[int | float, int | float] | Tuple[int | float, int | float, int | float])
d (Vector | Tuple[int | float, int | float] | Tuple[int | float, int | float, int | float])
a (float)

Construct a segment from two points.

Parameters:

p1 (Vector | Tuple[int | float, int | float] | Tuple[int | float, int | float, int | float])
p2 (Vector | Tuple[int | float, int | float] | Tuple[int | float, int | float, int | float])

Return type:

cadquery.occ_impl.shapes.setThreads(n: int)[source]

Set number of threads to be used by boolean operations.

Parameters:: n (int)

cadquery.occ_impl.shapes.shell(*s: cadquery.occ_impl.shapes.Shape, tol: float = 1e-06, manifold: bool = True, ctx: Sequence[cadquery.occ_impl.shapes.Shape] | cadquery.occ_impl.shapes.Shape | NoneType = None, history: Dict[cadquery.occ_impl.shapes.Shape | str, cadquery.occ_impl.shapes.Shape] | None = None) → cadquery.occ_impl.shapes.Shape[source]

Build shell from faces. If ctx is specified, local sewing is performed.

shell(s: Sequence[cadquery.occ_impl.shapes.Shape], tol: float = 1e-06, manifold: bool = True, ctx: Union[Sequence[cadquery.occ_impl.shapes.Shape], cadquery.occ_impl.shapes.Shape, NoneType] = None, history: Optional[Dict[Union[cadquery.occ_impl.shapes.Shape, str], cadquery.occ_impl.shapes.Shape]] = None) -> cadquery.occ_impl.shapes.Shape

Build shell from a sequence of faces. If ctx is specified, local sewing is performed.

Parameters:

s (Shape)
tol (float)
manifold (bool)
ctx (Sequence[Shape] | Shape | None)
history (Dict[Shape | str, Shape] | None)

Return type:

cadquery.occ_impl.shapes.solid(s1: cadquery.occ_impl.shapes.Shape, *sn: cadquery.occ_impl.shapes.Shape, tol: float = 1e-06, history: Dict[cadquery.occ_impl.shapes.Shape | str, cadquery.occ_impl.shapes.Shape] | None = None) → cadquery.occ_impl.shapes.Shape[source]

Build solid from faces or shells.

solid(s: Sequence[cadquery.occ_impl.shapes.Shape], inner: Optional[Sequence[cadquery.occ_impl.shapes.Shape]] = None, tol: float = 1e-06, history: Optional[Dict[Union[cadquery.occ_impl.shapes.Shape, str], cadquery.occ_impl.shapes.Shape]] = None) -> cadquery.occ_impl.shapes.Shape

Build solid from a sequence of faces.

Parameters:

s1 (Shape)
sn (Shape)
tol (float)
history (Dict[Shape | str, Shape] | None)

Return type:

cadquery.occ_impl.shapes.sortWiresByBuildOrder(wireList: List[Wire]) → List[List[Wire]][source]

Tries to determine how wires should be combined into faces.

Assume:: The wires make up one or more faces, which could have ‘holes’ Outer wires are listed ahead of inner wires there are no wires inside wires inside wires ( IE, islands – we can deal with that later on ) none of the wires are construction wires
Compute:: one or more sets of wires, with the outer wire listed first, and inner ones

Returns, list of lists.

Parameters:: wireList (List[Wire])
Return type:: List[List[Wire]]

cadquery.occ_impl.shapes.sphere(d: float) → Shape[source]

Construct a solid sphere.

Parameters:: d (float)
Return type:: Shape

Construct a spline from points.

spline(pts: Sequence[Union[ForwardRef(‘Vector’), Tuple[Union[int, float], Union[int, float]], Tuple[Union[int, float], Union[int, float], Union[int, float]]]], tgts: Optional[Sequence[Union[ForwardRef(‘Vector’), Tuple[Union[int, float], Union[int, float]], Tuple[Union[int, float], Union[int, float], Union[int, float]]]]] = None, params: Optional[Sequence[float]] = None, tol: float = 1e-06, periodic: bool = False, scale: bool = True) -> cadquery.occ_impl.shapes.Shape

Construct a spline from a sequence points.

Parameters:

pts (Vector | Tuple[int | float, int | float] | Tuple[int | float, int | float, int | float])
tol (float)
periodic (bool)

Return type:

cadquery.occ_impl.shapes.split(s1: Shape, s2: Shape, tol: float = 0.0) → Shape[source]

Split one shape with another.

Parameters:

s1 (Shape)
s2 (Shape)
tol (float)

Return type:

cadquery.occ_impl.shapes.sweep(s: cadquery.occ_impl.shapes.Shape, path: cadquery.occ_impl.shapes.Shape, aux: cadquery.occ_impl.shapes.Shape | None = None, cap: bool = False) → cadquery.occ_impl.shapes.Shape[source]

Sweep edge, wire or face along a path. For faces cap has no effect. Do not mix faces with other types.

sweep(s: Sequence[cadquery.occ_impl.shapes.Shape], path: cadquery.occ_impl.shapes.Shape, aux: Optional[cadquery.occ_impl.shapes.Shape] = None, cap: bool = False) -> cadquery.occ_impl.shapes.Shape

Sweep edges, wires or faces along a path, multiple sections are supported. For faces cap has no effect. Do not mix faces with other types.

Parameters:

s (Shape)
path (Shape)
aux (Shape | None)
cap (bool)

Return type:

cadquery.occ_impl.shapes.text(txt: str, size: float | int, font: str = 'Arial', path: str | None = None, kind: Literal['regular', 'bold', 'italic'] = 'regular', halign: Literal['center', 'left', 'right'] = 'center', valign: Literal['center', 'top', 'bottom'] = 'center') → cadquery.occ_impl.shapes.Shape[source]

Create a flat text.

text(txt: str, size: Union[float, int], spine: cadquery.occ_impl.shapes.Shape, planar: bool = False, font: str = ‘Arial’, path: Optional[str] = None, kind: Literal[‘regular’, ‘bold’, ‘italic’] = ‘regular’, halign: Literal[‘center’, ‘left’, ‘right’] = ‘center’, valign: Literal[‘center’, ‘top’, ‘bottom’] = ‘center’) -> cadquery.occ_impl.shapes.Shape

Create a text on a spine.

text(txt: str, size: Union[float, int], spine: cadquery.occ_impl.shapes.Shape, base: cadquery.occ_impl.shapes.Shape, font: str = ‘Arial’, path: Optional[str] = None, kind: Literal[‘regular’, ‘bold’, ‘italic’] = ‘regular’, halign: Literal[‘center’, ‘left’, ‘right’] = ‘center’, valign: Literal[‘center’, ‘top’, ‘bottom’] = ‘center’) -> cadquery.occ_impl.shapes.Shape

Create a text on a spine and a base surface.

Parameters:

txt (str)
size (float | int)
font (str)
path (str | None)
kind (Literal['regular', 'bold', 'italic'])
halign (Literal['center', 'left', 'right'])
valign (Literal['center', 'top', 'bottom'])

Return type:

cadquery.occ_impl.shapes.torus(d1: float, d2: float) → Shape[source]

Construct a solid torus.

Parameters:

d1 (float)
d2 (float)

Return type:

cadquery.occ_impl.shapes.vertex(x: float | int, y: float | int, z: float | int) → cadquery.occ_impl.shapes.Shape[source]

Construct a vertex from coordinates.

vertex(p: Union[ForwardRef(‘Vector’), Tuple[Union[int, float], Union[int, float]], Tuple[Union[int, float], Union[int, float], Union[int, float]]])

Construct a vertex from VectorLike.

Parameters:

x (float | int)
y (float | int)
z (float | int)

Return type:

cadquery.occ_impl.shapes.wire(*s: cadquery.occ_impl.shapes.Shape) → cadquery.occ_impl.shapes.Shape[source]

Build wire from edges.

Parameters:: s (Shape)
Return type:: Shape

cadquery.occ_impl.shapes.wireOn(base: Shape, w: Shape, tol=1e-06, N=20) → Shape[source]

Map a wire onto a base face in the u,v space.

Parameters:

base (Shape)
w (Shape)

Return type:

cadquery.occ_impl.shapes.wiresToFaces(wireList: List[Wire]) → List[Face][source]

Convert wires to a list of faces.

Parameters:: wireList (List[Wire])
Return type:: List[Face]

class cadquery.occ_impl.shapes.Mixin1D[source]

Bases: object

bounds() → Tuple[float, float][source]

Parametric bounds of the curve.

Parameters:: self (Mixin1DProtocol)
Return type:: Tuple[float, float]

curvatureAt(d: float, mode: Literal['length', 'parameter'] = 'length', resolution: float = 1e-06) → float[source]

Calculate mean curvature along the underlying curve.

Parameters:

self (Mixin1DProtocol)
d (float) – distance or parameter value
mode (Literal['length', 'parameter']) – position calculation mode (default: length)
resolution (float) – resolution of the calculation (default: 1e-6)

Returns:

mean curvature value at the specified d value.

Return type:

float

curvatures(ds: Iterable[float], mode: Literal['length', 'parameter'] = 'length', resolution: float = 1e-06) → List[float][source]

Calculate mean curvatures along the underlying curve.

Parameters:

self (Mixin1DProtocol)
d – distance or parameter values
mode (Literal['length', 'parameter']) – position calculation mode (default: length)
resolution (float) – resolution of the calculation (default: 1e-6)
ds (Iterable[float])

Returns:

mean curvature value at the specified d value.

Return type:

List[float]

endPoint() → Vector[source]

Returns:: a vector representing the end point of this edge.
Parameters:: self (Mixin1DProtocol)
Return type:: Vector

Note, circles may have the start and end points the same

locationAt(d: float, mode: Literal['length', 'parameter'] = 'length', frame: Literal['frenet', 'corrected'] = 'frenet', planar: bool = False) → Location[source]

Generate a location along the underlying curve.

Parameters:

self (Mixin1DProtocol)
d (float) – distance or parameter value
mode (Literal['length', 'parameter']) – position calculation mode (default: length)
frame (Literal['frenet', 'corrected']) – moving frame calculation method (default: frenet)
planar (bool) – planar mode

Returns:

A Location object representing local coordinate system at the specified distance.

Return type:

Location

locations(ds: Iterable[float], mode: Literal['length', 'parameter'] = 'length', frame: Literal['frenet', 'corrected'] = 'frenet', planar: bool = False) → List[Location][source]

Generate locations along the curve.

Parameters:

self (Mixin1DProtocol)
ds (Iterable[float]) – distance or parameter values
mode (Literal['length', 'parameter']) – position calculation mode (default: length)
frame (Literal['frenet', 'corrected']) – moving frame calculation method (default: frenet)
planar (bool) – planar mode

Returns:

A list of Location objects representing local coordinate systems at the specified distances.

Return type:

List[Location]

normal() → Vector[source]

Calculate the normal Vector. Only possible for planar curves.

Returns:: normal vector
Parameters:: self (Mixin1DProtocol)
Return type:: Vector

paramAt(d: float | int | Vector) → float[source]

Compute parameter value at the specified normalized distance or a point.

Parameters:

self (Mixin1DProtocol)
d (float | int | Vector) – normalized distance [0, 1] or a point

Returns:

parameter value

Return type:

float

params(pts: Iterable[Vector], tol=1e-06) → List[float][source]

Computes u values closest to given vectors.

Parameters:

self (Mixin1DProtocol)
pts (Iterable[Vector]) – the points to compute the parameters at.

Returns:

list of u values.

Return type:

List[float]

paramsLength(locations: Iterable[float]) → List[float][source]

Computes u values at given relative lengths.

Parameters:

self (Mixin1DProtocol)
locations (Iterable[float]) – list of distances.
pts – the points to compute the parameters at.

Returns:

list of u values.

Return type:

List[float]

positionAt(d: float, mode: Literal['length', 'parameter'] = 'length') → Vector[source]

Generate a position along the underlying curve.

Parameters:

self (Mixin1DProtocol)
d (float) – distance or parameter value
mode (Literal['length', 'parameter']) – position calculation mode (default: length)

Returns:

A Vector on the underlying curve located at the specified d value.

Return type:

positions(ds: Iterable[float], mode: Literal['length', 'parameter'] = 'length') → List[Vector][source]

Generate positions along the underlying curve.

Parameters:

self (Mixin1DProtocol)
ds (Iterable[float]) – distance or parameter values
mode (Literal['length', 'parameter']) – position calculation mode (default: length)

Returns:

A list of Vector objects.

Return type:

List[Vector]

Project onto a face along the specified direction.

Parameters:

self (T1D)
face (Face)
d (Vector | Tuple[int | float, int | float] | Tuple[int | float, int | float, int | float])
closest (bool)

Return type:

T1D | List[T1D]

radius() → float[source]

Calculate the radius.

Note that when applied to a Wire, the radius is simply the radius of the first edge.

Returns:: radius
Raises:: ValueError – if kernel can not reduce the shape to a circular edge
Parameters:: self (Mixin1DProtocol)
Return type:: float

sample(n: int | float) → Tuple[List[Vector], List[float]][source]

Sample a curve based on a number of points or deflection.

Parameters:

self (Mixin1DProtocol)
n (int | float) – Number of positions or deflection

Returns:

A list of Vectors and a list of parameters.

Return type:

Tuple[List[Vector], List[float]]

startPoint() → Vector[source]

Returns:: a vector representing the start point of this edge
Parameters:: self (Mixin1DProtocol)
Return type:: Vector

Note, circles may have the start and end points the same

tangentAt(locationParam: float = 0.5, mode: Literal['length', 'parameter'] = 'length') → Vector[source]

Compute tangent vector at the specified location.

Parameters:

self (Mixin1DProtocol)
locationParam (float) – distance or parameter value (default: 0.5)
mode (Literal['length', 'parameter']) – position calculation mode (default: length)

Returns:

tangent vector

Return type:

tangents(locations: Iterable[float], mode: Literal['length', 'parameter'] = 'length') → List[Vector][source]

Compute tangent vectors at the specified locations.

Parameters:

self (Mixin1DProtocol)
locations (Iterable[float]) – list of distances or parameters.
mode (Literal['length', 'parameter']) – position calculation mode (default: length).

Returns:

list of tangent vectors

Return type:

List[Vector]

class cadquery.occ_impl.shapes.Mixin3D[source]

Bases: object

chamfer(length: float, length2: float | None, edgeList: Iterable[Edge]) → Any[source]

Chamfers the specified edges of this solid.

Parameters:

self (Any)
length (float) – length > 0, the length (length) of the chamfer
length2 (float | None) – length2 > 0, optional parameter for asymmetrical chamfer. Should be None if not required.
edgeList (Iterable[Edge]) – a list of Edge objects, which must belong to this solid

Returns:

Chamfered solid

Return type:

Any

Make a prismatic feature (additive or subtractive)

Parameters:

self (TS)
basis (Face | None) – face to perform the operation on
profiles (List[Wire]) – list of profiles
depth (float | int | None) – depth of the cut or extrusion
upToFace (Face | None) – a face to extrude until
thruAll (bool) – cut thruAll
taper (float | int)
additive (bool)

Returns:

a Solid object

Return type:

fillet(radius: float, edgeList: Iterable[Edge]) → Any[source]

Fillets the specified edges of this solid.

Parameters:

self (Any)
radius (float) – float > 0, the radius of the fillet
edgeList (Iterable[Edge]) – a list of Edge objects, which must belong to this solid

Returns:

Filleted solid

Return type:

Any

Returns whether or not the point is inside a solid or compound object within the specified tolerance.

Parameters:

self (ShapeProtocol)
point (Vector | Tuple[int | float, int | float] | Tuple[int | float, int | float, int | float]) – tuple or Vector representing 3D point to be tested
tolerance (float) – tolerance for inside determination, default=1.0e-6

Returns:

bool indicating whether or not point is within solid

Return type:

bool

shell(faceList: Iterable[Face] | None, thickness: float, tolerance: float = 0.0001, kind: Literal['arc', 'intersection'] = 'arc') → Any[source]

Make a shelled solid of self.

Parameters:

self (Any)
faceList (Iterable[Face] | None) – List of faces to be removed, which must be part of the solid. Can be an empty list.
thickness (float) – Floating point thickness. Positive shells outwards, negative shells inwards.
tolerance (float) – Modelling tolerance of the method, default=0.0001.
kind (Literal['arc', 'intersection'])

Returns:

A shelled solid.

Return type:

Any

class cadquery.selectors.AndSelector(left, right)[source]

Bases: BinarySelector

Intersection selector. Returns objects that is selected by both selectors.

class cadquery.selectors.AreaNthSelector(n: int, directionMax: bool = True, tolerance: float = 0.0001)[source]

Bases: _NthSelector

Selects the object(s) with Nth area

Applicability:

Faces, Shells, Solids - Shape.Area() is used to compute area
closed planar Wires - a temporary face is created to compute area

Will ignore non-planar or non-closed wires.

Among other things can be used to select one of the nested coplanar wires or faces.

For example to create a fillet on a shank:

result = (
    cq.Workplane("XY")
    .circle(5)
    .extrude(2)
    .circle(2)
    .extrude(10)
    .faces(">Z[-2]")
    .wires(AreaNthSelector(0))
    .fillet(2)
)

Or to create a lip on a case seam:

result = (
    cq.Workplane("XY")
    .rect(20, 20)
    .extrude(10)
    .edges("|Z or <Z")
    .fillet(2)
    .faces(">Z")
    .shell(2)
    .faces(">Z")
    .wires(AreaNthSelector(-1))
    .toPending()
    .workplane()
    .offset2D(-1)
    .extrude(1)
    .faces(">Z[-2]")
    .wires(AreaNthSelector(0))
    .toPending()
    .workplane()
    .cutBlind(2)
)

Parameters:

n (int)
directionMax (bool)
tolerance (float)

key(obj: Shape) → float[source]

Return the key for ordering. Can raise a ValueError if obj can not be used to create a key, which will result in obj being dropped by the clustering method.

Parameters:: obj (Shape)
Return type:: float

class cadquery.selectors.BaseDirSelector(vector: Vector, tolerance: float = 0.0001)[source]

Bases: Selector

A selector that handles selection on the basis of a single direction vector.

Parameters:

vector (Vector)
tolerance (float)

filter(objectList: Sequence[Shape]) → List[Shape][source]

There are lots of kinds of filters, but for planes they are always based on the normal of the plane, and for edges on the tangent vector along the edge

Parameters:: objectList (Sequence[Shape])
Return type:: List[Shape]

test(vec: Vector) → bool[source]

Test a specified vector. Subclasses override to provide other implementations

Parameters:: vec (Vector)
Return type:: bool

class cadquery.selectors.BinarySelector(left, right)[source]

Bases: Selector

Base class for selectors that operates with two other selectors. Subclass must implement the :filterResults(): method.

filter(objectList: Sequence[Shape])[source]

Filter the provided list.

The default implementation returns the original list unfiltered.

Parameters:: objectList (list of OCCT primitives) – list to filter
Returns:: filtered list

class cadquery.selectors.BoxSelector(point0, point1, boundingbox=False)[source]

Bases: Selector

Selects objects inside the 3D box defined by 2 points.

If boundingbox is True only the objects that have their bounding box inside the given box is selected. Otherwise only center point of the object is tested.

Applicability: all types of shapes

Example:

CQ(aCube).edges(BoxSelector((0, 1, 0), (1, 2, 1)))

filter(objectList: Sequence[Shape])[source]

Filter the provided list.

The default implementation returns the original list unfiltered.

Parameters:: objectList (list of OCCT primitives) – list to filter
Returns:: filtered list

class cadquery.selectors.CenterNthSelector(vector: Vector, n: int, directionMax: bool = True, tolerance: float = 0.0001)[source]

Bases: _NthSelector

Sorts objects into a list with order determined by the distance of their center projected onto the specified direction.

Applicability:: All Shapes.

Parameters:

vector (Vector)
n (int)
directionMax (bool)
tolerance (float)

key(obj: Shape) → float[source]

Return the key for ordering. Can raise a ValueError if obj can not be used to create a key, which will result in obj being dropped by the clustering method.

Parameters:: obj (Shape)
Return type:: float

class cadquery.selectors.DirectionMinMaxSelector(vector: Vector, directionMax: bool = True, tolerance: float = 0.0001)[source]

Bases: CenterNthSelector

Selects objects closest or farthest in the specified direction.

Applicability:: All object types. for a vertex, its point is used. for all other kinds of objects, the center of mass of the object is used.

You can use the string shortcuts >(X|Y|Z) or <(X|Y|Z) if you want to select based on a cardinal direction.

For example this:

CQ(aCube).faces(DirectionMinMaxSelector((0, 0, 1), True))

Means to select the face having the center of mass farthest in the positive z direction, and is the same as:

CQ(aCube).faces(">Z")

Parameters:

vector (Vector)
directionMax (bool)
tolerance (float)

class cadquery.selectors.DirectionNthSelector(vector: Vector, n: int, directionMax: bool = True, tolerance: float = 0.0001)[source]

Bases: ParallelDirSelector, CenterNthSelector

Filters for objects parallel (or normal) to the specified direction then returns the Nth one.

Applicability:: Linear Edges Planar Faces

Parameters:

vector (Vector)
n (int)
directionMax (bool)
tolerance (float)

filter(objectlist: Sequence[Shape]) → List[Shape][source]

There are lots of kinds of filters, but for planes they are always based on the normal of the plane, and for edges on the tangent vector along the edge

Parameters:: objectlist (Sequence[Shape])
Return type:: List[Shape]

class cadquery.selectors.DirectionSelector(vector: Vector, tolerance: float = 0.0001)[source]

Selects objects aligned with the provided direction.

Applicability:: Linear Edges Planar Faces

Use the string syntax shortcut +/-(X|Y|Z) if you want to select based on a cardinal direction.

Example:

CQ(aCube).faces(DirectionSelector((0, 0, 1)))

selects faces with the normal in the z direction, and is equivalent to:

CQ(aCube).faces("+Z")

Parameters:

vector (Vector)
tolerance (float)

test(vec: Vector) → bool[source]

Test a specified vector. Subclasses override to provide other implementations

Parameters:: vec (Vector)
Return type:: bool

class cadquery.selectors.InverseSelector(selector)[source]

Bases: Selector

Inverts the selection of given selector. In other words, selects all objects that is not selected by given selector.

filter(objectList: Sequence[Shape])[source]

Filter the provided list.

The default implementation returns the original list unfiltered.

Parameters:: objectList (list of OCCT primitives) – list to filter
Returns:: filtered list

class cadquery.selectors.LengthNthSelector(n: int, directionMax: bool = True, tolerance: float = 0.0001)[source]

Bases: _NthSelector

Select the object(s) with the Nth length

Applicability:: All Edge and Wire objects

Parameters:

n (int)
directionMax (bool)
tolerance (float)

key(obj: Shape) → float[source]

Return the key for ordering. Can raise a ValueError if obj can not be used to create a key, which will result in obj being dropped by the clustering method.

Parameters:: obj (Shape)
Return type:: float

class cadquery.selectors.NearestToPointSelector(pnt)[source]

Bases: Selector

Selects object nearest the provided point.

If the object is a vertex or point, the distance is used. For other kinds of shapes, the center of mass is used to to compute which is closest.

Applicability: All Types of Shapes

Example:

CQ(aCube).vertices(NearestToPointSelector((0, 1, 0)))

returns the vertex of the unit cube closest to the point x=0,y=1,z=0

filter(objectList: Sequence[Shape])[source]

Filter the provided list.

The default implementation returns the original list unfiltered.

Parameters:: objectList (list of OCCT primitives) – list to filter
Returns:: filtered list

class cadquery.selectors.ParallelDirSelector(vector: Vector, tolerance: float = 0.0001)[source]

Selects objects parallel with the provided direction.

Applicability:: Linear Edges Planar Faces

Use the string syntax shortcut |(X|Y|Z) if you want to select based on a cardinal direction.

Example:

CQ(aCube).faces(ParallelDirSelector((0, 0, 1)))

selects faces with the normal parallel to the z direction, and is equivalent to:

CQ(aCube).faces("|Z")

Parameters:

vector (Vector)
tolerance (float)

test(vec: Vector) → bool[source]

Test a specified vector. Subclasses override to provide other implementations

Parameters:: vec (Vector)
Return type:: bool

class cadquery.selectors.PerpendicularDirSelector(vector: Vector, tolerance: float = 0.0001)[source]