Base Class Methods

Cadquery methods by class

	Compound	Edge	Face	Plane	Shape	Solid	Vector	Vertex	Wire
Area	✓	✓	✓	✗	✓	✓	✗	✓	✓	area
BoundingBox	✓	✓	✓	✗	✓	✓	✗	✓	✓
Center	✓	✓	✓	✗	✓	✓	✓	✓	✓	center(center options)
CenterOfBoundBox	✓	✓	✓	✗	✓	✓	✗	✓	✓
Closed	✓	✓	✓	✗	✓	✓	✗	✓	✓
CombinedCenter	✓	✓	✓	✗	✓	✓	✗	✓	✓
CombinedCenterOfBoundBox	✓	✓	✓	✗	✓	✓	✗	✓	✓
CompSolids	✓	✓	✓	✗	✓	✓	✗	✓	✓
Compounds	✓	✓	✓	✗	✓	✓	✗	✓	✓	compounds
Edges	✓	✓	✓	✗	✓	✓	✗	✓	✓	edges
Faces	✓	✓	✓	✗	✓	✓	✗	✓	✓	faces
IsClosed	✗	✓	✗	✗	✗	✗	✗	✗	✓	is_closed
Length	✗	✓	✗	✗	✗	✗	✓	✗	✓	length
ShapeType	✓	✓	✓	✗	✓	✓	✗	✓	✓
Shells	✓	✓	✓	✗	✓	✓	✗	✓	✓	shells
Solids	✓	✓	✓	✗	✓	✓	✗	✓	✓	solids
Vertices	✓	✓	✓	✗	✓	✓	✗	✓	✓	vertices
Volume	✓	✓	✓	✗	✓	✓	✗	✓	✓	volume
Wires	✓	✓	✓	✗	✓	✓	✗	✓	✓	wires
XY	✗	✗	✗	✓	✗	✗	✗	✗	✗
XZ	✗	✗	✗	✓	✗	✗	✗	✗	✗
YX	✗	✗	✗	✓	✗	✗	✗	✗	✗
YZ	✗	✗	✗	✓	✗	✗	✗	✗	✗
ZX	✗	✗	✗	✓	✗	✗	✗	✗	✗
ZY	✗	✗	✗	✓	✗	✗	✗	✗	✗
__abs__	✗	✗	✗	✗	✗	✗	✓	✗	✗
__add__	✗	✗	✗	✗	✗	✗	✓	✓	✗
__annotations__	✓	✓	✓	✓	✓	✓	✓	✓	✓
__bool__	✓	✗	✗	✗	✗	✗	✗	✗	✗
__class__	✓	✓	✓	✓	✓	✓	✓	✓	✓
__delattr__	✓	✓	✓	✓	✓	✓	✓	✓	✓
__dict__	✓	✓	✓	✓	✓	✓	✓	✓	✓
__dir__	✓	✓	✓	✓	✓	✓	✓	✓	✓
__doc__	✓	✓	✓	✓	✓	✓	✓	✓	✓
__eq__	✓	✓	✓	✓	✓	✓	✓	✓	✓
__format__	✓	✓	✓	✓	✓	✓	✓	✓	✓
__ge__	✓	✓	✓	✓	✓	✓	✓	✓	✓
__getattribute__	✓	✓	✓	✓	✓	✓	✓	✓	✓
__gt__	✓	✓	✓	✓	✓	✓	✓	✓	✓
__hash__	✓	✓	✓	✓	✓	✓	✓	✓	✓
__init__	✓	✓	✓	✓	✓	✓	✓	✓	✓
__init_subclass__	✓	✓	✓	✓	✓	✓	✓	✓	✓
__iter__	✓	✗	✗	✗	✗	✗	✗	✗	✗
__le__	✓	✓	✓	✓	✓	✓	✓	✓	✓
__lt__	✓	✓	✓	✓	✓	✓	✓	✓	✓
__module__	✓	✓	✓	✓	✓	✓	✓	✓	✓
__mul__	✗	✗	✗	✗	✗	✗	✓	✗	✗
__ne__	✓	✓	✓	✓	✓	✓	✓	✓	✓
__neg__	✗	✗	✗	✗	✗	✗	✓	✗	✗
__new__	✓	✓	✓	✓	✓	✓	✓	✓	✓
__reduce__	✓	✓	✓	✓	✓	✓	✓	✓	✓
__reduce_ex__	✓	✓	✓	✓	✓	✓	✓	✓	✓
__repr__	✓	✓	✓	✓	✓	✓	✓	✓	✓
__rmul__	✗	✗	✗	✗	✗	✗	✓	✗	✗
__setattr__	✓	✓	✓	✓	✓	✓	✓	✓	✓
__sizeof__	✓	✓	✓	✓	✓	✓	✓	✓	✓
__str__	✓	✓	✓	✓	✓	✓	✓	✓	✓
__sub__	✗	✗	✗	✗	✗	✗	✓	✓	✗
__subclasshook__	✓	✓	✓	✓	✓	✓	✓	✓	✓
__truediv__	✗	✗	✗	✗	✗	✗	✓	✗	✗
__weakref__	✓	✓	✓	✓	✓	✓	✓	✓	✓
_apply_transform	✓	✓	✓	✗	✓	✓	✗	✓	✓
_bool_op	✓	✓	✓	✗	✓	✓	✗	✓	✓
_bounds	✗	✓	✗	✗	✗	✗	✗	✗	✓
_calcTransforms	✗	✗	✗	✓	✗	✗	✗	✗	✗
_center_of_mass	✓	✓	✓	✗	✓	✓	✗	✓	✓
_entities	✓	✓	✓	✗	✓	✓	✗	✓	✓
_entitiesFrom	✓	✓	✓	✗	✓	✓	✗	✓	✓
_eq_iter	✗	✗	✗	✓	✗	✗	✗	✗	✗
_eq_tolerance_dot	✗	✗	✗	✓	✗	✗	✗	✗	✗
_eq_tolerance_origin	✗	✗	✗	✓	✗	✗	✗	✗	✗
_extrudeAuxSpine	✗	✗	✗	✗	✗	✓	✗	✗	✗
_geomAdaptor	✗	✓	✓	✗	✗	✗	✗	✗	✓
_geomAdaptorH	✗	✓	✗	✗	✗	✗	✗	✗	✓
_makeCompound	✓	✗	✗	✗	✗	✗	✗	✗	✗
_repr_javascript_	✓	✓	✓	✗	✓	✓	✗	✓	✓
_setPlaneDir	✗	✗	✗	✓	✗	✗	✗	✗	✗
_setSweepMode	✗	✗	✗	✗	✗	✓	✗	✗	✗
_toFromLocalCoords	✗	✗	✗	✓	✗	✗	✗	✗	✗
_toWire	✗	✗	✗	✗	✗	✓	✗	✗	✗
_transModeDict	✗	✗	✗	✗	✗	✓	✗	✗	✗
_uvBounds	✗	✗	✓	✗	✗	✗	✗	✗	✗
add	✗	✗	✗	✗	✗	✗	✓	✗	✗	Add	build_generic
arcCenter	✗	✓	✗	✗	✗	✗	✗	✗	✗
assembleEdges	✗	✗	✗	✗	✗	✗	✗	✗	✓	assemble_edges
back	✗	✗	✗	✓	✗	✗	✗	✗	✗
bottom	✗	✗	✗	✓	✗	✗	✗	✗	✗
cast	✓	✓	✓	✗	✓	✓	✗	✓	✓
centerOfMass	✓	✓	✓	✗	✓	✓	✗	✓	✓
chamfer	✓	✗	✗	✗	✗	✓	✗	✗	✗
chamfer2D	✗	✗	✓	✗	✗	✗	✗	✗	✓
clean	✓	✓	✓	✗	✓	✓	✗	✓	✓	?
close	✗	✓	✗	✗	✗	✗	✗	✗	✓	?
combine	✗	✗	✗	✗	✗	✗	✗	✗	✓
computeMass	✓	✓	✓	✗	✓	✓	✗	✓	✓
copy	✓	✓	✓	✗	✓	✓	✗	✓	✓	Copy	build_generic
cross	✗	✗	✗	✗	✗	✗	✓	✗	✗
cut	✓	✓	✓	✗	✓	✓	✗	✓	✓
distanceToLine	✗	✗	✗	✗	✗	✗	✓	✗	✗	distance_to_line
distanceToPlane	✗	✗	✗	✗	✗	✗	✓	✗	✗	distance_to_plane
dot	✗	✗	✗	✗	✗	✗	✓	✗	✗
dprism	✓	✗	✗	✗	✗	✓	✗	✗	✗
embossText	✓	✓	✓	✗	✓	✓	✗	✓	✓
embossToShape	✗	✓	✓	✗	✗	✗	✗	✗	✓
endPoint	✗	✓	✗	✗	✗	✗	✗	✗	✓	end_point
exportBrep	✓	✓	✓	✗	✓	✓	✗	✓	✓	export_as
exportStep	✓	✓	✓	✗	✓	✓	✗	✓	✓	export_as
exportStl	✓	✓	✓	✗	✓	✓	✗	✓	✓	export_as
extrudeLinear	✗	✗	✗	✗	✗	✓	✗	✗	✗
extrudeLinearWithRotation	✗	✗	✗	✗	✗	✓	✗	✗	✗	Extrude
facesIntersectedByLine	✓	✓	✓	✗	✓	✓	✗	✓	✓	New filter
fillet	✓	✗	✗	✗	✗	✓	✗	✗	✗
fillet2D	✗	✗	✓	✗	✗	✗	✗	✗	✓
findIntersection	✓	✓	✓	✗	✓	✓	✗	✓	✓	New filter
fix	✓	✓	✓	✗	✓	✓	✗	✓	✓	?
fromLocalCoords	✗	✗	✗	✓	✗	✗	✗	✗	✗	New Operation	build_part
front	✗	✗	✗	✓	✗	✗	✗	✗	✗
fuse	✓	✓	✓	✗	✓	✓	✗	✓	✓
geomType	✓	✓	✓	✗	✓	✓	✗	✓	✓	geom_type
getAngle	✗	✗	✗	✗	✗	✗	✓	✗	✗	get_angle
getSignedAngle	✗	✗	✗	✗	✗	✗	✓	✗	✗	get_signed_angle
hashCode	✓	✓	✓	✗	✓	✓	✗	✓	✓
importBrep	✓	✓	✓	✗	✓	✓	✗	✓	✓	import_from	build_generic
innerWires	✗	✗	✓	✗	✗	✗	✗	✗	✗	inner_wires
interpPlate	✗	✗	✗	✗	✗	✓	✗	✗	✗
intersect	✓	✓	✓	✗	✓	✓	✗	✓	✓
isEqual	✓	✓	✓	✗	✓	✓	✗	✓	✓	is_equal
isInside	✓	✗	✓	✗	✗	✓	✗	✗	✗	is_inside
isNull	✓	✓	✓	✗	✓	✓	✗	✓	✓	is_null
isSame	✓	✓	✓	✗	✓	✓	✗	✓	✓	is_same
isSolid	✗	✗	✗	✗	✗	✓	✗	✗	✗	is_solid
isValid	✓	✓	✓	✗	✓	✓	✗	✓	✓	is_valid
left	✗	✗	✗	✓	✗	✗	✗	✗	✗
locate	✓	✓	✓	✗	✓	✓	✗	✓	✓	locate
located	✓	✓	✓	✗	✓	✓	✗	✓	✓
location	✓	✓	✓	✓	✓	✓	✗	✓	✓	location
locationAt	✗	✓	✗	✗	✗	✗	✗	✗	✓	location_at
locations	✗	✓	✗	✗	✗	✗	✗	✗	✓
makeBox	✗	✗	✗	✗	✗	✓	✗	✗	✗
makeCircle	✗	✓	✗	✗	✗	✗	✗	✗	✓
makeCompound	✓	✗	✗	✗	✗	✗	✗	✗	✗	make_compound
makeCone	✗	✗	✗	✗	✗	✓	✗	✗	✗
makeCylinder	✗	✗	✗	✗	✗	✓	✗	✗	✗
makeEllipse	✗	✓	✗	✗	✗	✗	✗	✗	✓
makeFingerJointFaces	✓	✓	✓	✗	✓	✓	✗	✓	✓	make_finger_joint_faces
makeFingerJoints	✗	✗	✓	✗	✗	✗	✗	✗	✗	make_finger_joints
makeFromWires	✗	✗	✓	✗	✗	✗	✗	✗	✗	?
makeHelix	✗	✗	✗	✗	✗	✗	✗	✗	✓
makeHoles	✗	✗	✓	✗	✗	✗	✗	✗	✗	MakeHoles	buildSurface
makeLine	✗	✓	✗	✗	✗	✗	✗	✗	✗
makeLoft	✗	✗	✗	✗	✗	✓	✗	✗	✗
makeNSidedSurface	✗	✗	✓	✗	✗	✗	✗	✗	✗
makeNonPlanarFace	✗	✗	✗	✗	✗	✗	✗	✗	✓	MakeNonPlanarFace	buildSurface
makePlane	✗	✗	✓	✗	✗	✗	✗	✗	✗
makePolygon	✗	✗	✗	✗	✗	✗	✗	✗	✓
makeRect	✗	✗	✗	✗	✗	✗	✗	✗	✓
makeRuledSurface	✗	✗	✓	✗	✗	✗	✗	✗	✗	RuledSurface	buildSurface
makeSolid	✗	✗	✗	✗	✗	✓	✗	✗	✗
makeSphere	✗	✗	✗	✗	✗	✓	✗	✗	✗
makeSpline	✗	✓	✗	✗	✗	✗	✗	✗	✗
makeSplineApprox	✗	✓	✓	✗	✗	✗	✗	✗	✗
makeTangentArc	✗	✓	✗	✗	✗	✗	✗	✗	✗
makeText	✓	✗	✗	✗	✗	✗	✗	✗	✗
makeThreePointArc	✗	✓	✗	✗	✗	✗	✗	✗	✗
makeTorus	✗	✗	✗	✗	✗	✓	✗	✗	✗
makeVertex	✗	✗	✗	✗	✗	✗	✗	✓	✗
makeWedge	✗	✗	✗	✗	✗	✓	✗	✗	✗
maxFillet	✓	✓	✓	✗	✓	✓	✗	✓	✓	Fillet option	build_generic
mesh	✓	✓	✓	✗	✓	✓	✗	✓	✓	Mesh	buildPart
mirror	✓	✓	✓	✗	✓	✓	✗	✓	✓
mirrorInPlane	✗	✗	✗	✓	✗	✗	✗	✗	✗
move	✓	✓	✓	✗	✓	✓	✗	✓	✓
moved	✓	✓	✓	✗	✓	✓	✗	✓	✓
multiply	✗	✗	✗	✗	✗	✗	✓	✗	✗
named	✗	✗	✗	✓	✗	✗	✗	✗	✗
normal	✗	✓	✗	✗	✗	✗	✗	✗	✓	normal
normalAt	✗	✗	✓	✗	✗	✗	✗	✗	✗	normal_at
normalized	✗	✗	✗	✗	✗	✗	✓	✗	✗	normalized
offset2D	✗	✗	✗	✗	✗	✗	✗	✗	✓
origin	✗	✗	✗	✓	✗	✗	✗	✗	✗
outerWire	✗	✗	✓	✗	✗	✗	✗	✗	✗	outer_wire
paramAt	✗	✓	✗	✗	✗	✗	✗	✗	✓
positionAt	✗	✓	✗	✗	✗	✗	✗	✗	✓
positions	✗	✓	✗	✗	✗	✗	✗	✗	✓
projectText	✓	✓	✓	✗	✓	✓	✗	✓	✓	ProjectText	buildPart
projectToLine	✗	✗	✗	✗	✗	✗	✓	✗	✗
projectToPlane	✗	✗	✗	✗	✗	✗	✓	✗	✗
projectToShape	✗	✓	✓	✗	✗	✗	✗	✗	✓
radius	✗	✓	✗	✗	✗	✗	✗	✗	✓	radius
remove	✓	✗	✗	✗	✗	✗	✗	✗	✗	remove
revolve	✗	✗	✗	✗	✗	✓	✗	✗	✗
right	✗	✗	✗	✓	✗	✗	✗	✗	✗
rotate	✓	✓	✓	✗	✓	✓	✗	✓	✓	Rotate	build_generic
rotateX	✗	✗	✗	✗	✗	✗	✓	✗	✗
rotateY	✗	✗	✗	✗	✗	✗	✓	✗	✗
rotateZ	✗	✗	✗	✗	✗	✗	✓	✗	✗
rotated	✗	✗	✗	✓	✗	✗	✗	✗	✗
scale	✓	✓	✓	✗	✓	✓	✗	✓	✓	Scale(x,y,z)	build_generic
setOrigin2d	✗	✗	✗	✓	✗	✗	✗	✗	✗
shell	✓	✗	✗	✗	✗	✓	✗	✗	✗
sortedEdges	✗	✗	✗	✗	✗	✗	✗	✗	✓	new sort	build_common	use makeRuledSurface to flip edges
split	✓	✓	✓	✗	✓	✓	✗	✓	✓
startPoint	✗	✓	✗	✗	✗	✗	✗	✗	✓	start_point
stitch	✗	✗	✗	✗	✗	✗	✗	✗	✓	stitch
sub	✗	✗	✗	✗	✗	✗	✓	✗	✗
sweep	✗	✗	✗	✗	✗	✓	✗	✗	✗
sweep_multi	✗	✗	✗	✗	✗	✓	✗	✗	✗
tangentAt	✗	✓	✗	✗	✗	✗	✗	✗	✓	tangent_at
tessellate	✓	✓	✓	✗	✓	✓	✗	✓	✓	Tessellate	build_generic
thicken	✗	✗	✓	✗	✗	✗	✗	✗	✗	Thicken	buildSurface
toDir	✗	✗	✗	✗	✗	✗	✓	✗	✗
toLocalCoords	✗	✗	✗	✓	✗	✗	✗	✗	✗
toPln	✗	✗	✓	✓	✗	✗	✗	✗	✗	to_plane
toPnt	✗	✗	✗	✗	✗	✗	✓	✗	✗
toTuple	✗	✗	✗	✗	✗	✗	✓	✓	✗	to_tuple
toVector	✗	✗	✗	✗	✗	✗	✗	✓	✗	to_vector
toVertex	✗	✗	✗	✗	✗	✗	✓	✗	✗	to_vertex
toVtkPolyData	✓	✓	✓	✗	✓	✓	✗	✓	✓
toWorldCoords	✗	✗	✗	✓	✗	✗	✗	✗	✗
top	✗	✗	✗	✓	✗	✗	✗	✗	✗
transform	✗	✗	✗	✗	✗	✗	✓	✗	✗	Transform	build_generic
transformGeometry	✓	✓	✓	✗	✓	✓	✗	✓	✓
transformShape	✓	✓	✓	✗	✓	✓	✗	✓	✓
transformed	✓	✓	✓	✗	✓	✓	✗	✓	✓
translate	✓	✓	✓	✗	✓	✓	✗	✓	✓	Translate	build_generic
wrapped	✗	✗	✗	✗	✗	✗	✓	✗	✗
x	✗	✗	✗	✗	✗	✗	✓	✗	✗	add to Vertex	build_common
y	✗	✗	✗	✗	✗	✗	✓	✗	✗	add to Vertex	build_common
z	✗	✗	✗	✗	✗	✗	✓	✗	✗	add to Vertex	build_common