CQ-CAM Class Summary

Core Classes

Job(workplane, feed, plunge_feed, unit, ...)

param workplane

Profile(job[, o, stepdown, tool_diameter, ...])

Create a profiles based on selected wires and faces in a Workplane.

Pocket(job[, o, avoid, stepover, ...])

2.5D Pocket operation

Surface3D(job[, o, avoid, stepover, ...])

param job

Drill(job[, wp, o, depth, clearance_height, ...])

param job

Milling strategies

ZigZagStrategy()

ContourStrategy()

Contour strategy uses the outer boundary to generate incrementally shrinking contours.

Tabbing methods

EdgeTabs(*, spacing, width, height[, only])

param spacing

WireTabs(*, count, width, height)

param count

Misc

Unit(value)

An enumeration.

Class details

class cq_cam.Job(workplane, feed, plunge_feed, unit, rapid_height, gcode_precision=3)[source]

Bases: object

Parameters

  • workplane (cq.Workplane) –

  • feed (float) –

  • plunge_feed (float) –

  • unit (Unit) –

  • rapid_height (float) –

  • gcode_precision (int) –

class cq_cam.Profile(job, o=None, stepdown=None, tool_diameter=3.175, face_offset_outer=1, face_offset_inner=None, wire_offset=1, tabs=<cq_cam.operations.tabs.NoTabs object>, *, clearance_height=20, top_height=0)[source]

Bases: cq_cam.operations.mixin_operation.PlaneValidationMixin, cq_cam.operations.mixin_operation.ObjectsValidationMixin, cq_cam.operations.base_operation.Operation

Create a profiles based on selected wires and faces in a Workplane.

Parameters

  • job (Job) –

  • o (Union[Workplane, List[Union[Wire, Face]], Wire, Face, None]) –

  • stepdown (Optional[float]) –

  • tool_diameter (float) –

  • face_offset_outer (Union[float, Tuple[float, float], None]) –

  • face_offset_inner (Union[float, Tuple[float, float], None]) –

  • wire_offset (Union[float, Tuple[float, float], None]) –

  • tabs (Optional[Tabs]) –

  • clearance_height (float) –

  • top_height (float) –

face_offset_inner: Optional[Union[float, Tuple[float, float]]] = None

See face_offset_outer

face_offset_outer: Optional[Union[float, Tuple[float, float]]] = 1
Offset is in multiples of tool diameter

  • -1 for closed pockets and inside profiles

  • 0 for open pockets

  • 1 for outside profiles

It is possible to also give a tuple of the form (multiple, relative_offset) in which case first the multiple is calculated and the relative offset is added to the final result. For example (1, 0.5) in metric would mean an outer profile with 0.5 mm stock left.

This offset is applied to any wires and the outer wires of any faces defined in o.

o: Union[cadquery.cq.Workplane, List[Union[cadquery.occ_impl.shapes.Wire, cadquery.occ_impl.shapes.Face]], cadquery.occ_impl.shapes.Wire, cadquery.occ_impl.shapes.Face] = None

Operation target. This may be one of

  • cq.Workplane with faces and/or wires selected

  • List of or a single cq.Face and/or cq.Wire

stepdown: Optional[float] = None

Z stepdown. A value of None means straight to bottom.

wire_offset: Optional[Union[float, Tuple[float, float]]] = 1

See face_offset_outer - this value applies for any wires in o

class cq_cam.Pocket(job, o=None, avoid=None, stepover=0.8, outer_boundary_offset=-1, inner_boundary_offset=1, boundary_final_pass_stepover=None, stepdown=None, *, clearance_height=20, top_height=0, tool_diameter=3.175, strategy=<class 'cq_cam.operations.strategy.ZigZagStrategy'>)[source]

Bases: cq_cam.operations.mixin_operation.PlaneValidationMixin, cq_cam.operations.mixin_operation.ObjectsValidationMixin, cq_cam.operations.base_operation.FaceBaseOperation

2.5D Pocket operation

All faces involved must be planes and parallel.

Parameters

  • job (Job) –

  • o (Union[Workplane, List[Union[Wire, Face]], Wire, Face, None]) –

  • avoid (Union[Workplane, List[Union[Wire, Face]], Wire, Face, None]) –

  • stepover (float) –

  • outer_boundary_offset (Union[float, Tuple[float, float]]) –

  • inner_boundary_offset (Union[float, Tuple[float, float], None]) –

  • boundary_final_pass_stepover (Optional[float]) –

  • stepdown (Optional[float]) –

  • clearance_height (float) –

  • top_height (float) –

  • tool_diameter (float) –

  • strategy (Strategy) –

strategy

alias of cq_cam.operations.strategy.ZigZagStrategy

class cq_cam.Surface3D(job, o=None, avoid=None, stepover=0.8, outer_boundary_offset=-1, inner_boundary_offset=1, boundary_final_pass_stepover=None, stepdown=None, tool=<ocl.CylCutter object>, interpolation_step=0.5, *, clearance_height=20, top_height=0)[source]

Bases: cq_cam.operations.base_operation.FaceBaseOperation

Parameters

  • job (Job) –

  • o (Union[Workplane, List[Union[Wire, Face]], Wire, Face, None]) –

  • avoid (Union[Workplane, List[Union[Wire, Face]], Wire, Face, None]) –

  • stepover (float) –

  • outer_boundary_offset (Union[float, Tuple[float, float]]) –

  • inner_boundary_offset (Union[float, Tuple[float, float], None]) –

  • boundary_final_pass_stepover (Optional[float]) –

  • stepdown (Optional[float]) –

  • tool (MillingCutter) –

  • interpolation_step (float) –

  • clearance_height (float) –

  • top_height (float) –

class cq_cam.Drill(job, wp=None, o=None, depth=None, *, clearance_height=20, top_height=0)[source]

Bases: cq_cam.operations.base_operation.Operation

Parameters

  • job (Job) –

  • wp (Optional[Workplane]) –

  • o (Union[Workplane, List[Union[Wire, Face, Vector]], Wire, Face, Vector, None]) –

  • depth (Optional[float]) –

  • clearance_height (float) –

  • top_height (float) –

wp: cadquery.cq.Workplane = None

The cadquery Workplane containing faces and/or wires that the profile will operate on.

class cq_cam.ZigZagStrategy[source]

Bases: cq_cam.operations.strategy.Strategy

class cq_cam.ContourStrategy[source]

Bases: cq_cam.operations.strategy.Strategy

Contour strategy uses the outer boundary to generate incrementally shrinking contours.

class cq_cam.EdgeTabs(*, spacing, width, height, only=None)[source]

Bases: cq_cam.operations.tabs.Tabs

Parameters

  • spacing (float) –

  • width (float) –

  • height (float) –

class cq_cam.WireTabs(*, count, width, height)[source]

Bases: cq_cam.operations.tabs.Tabs

Parameters

  • count (int) –

  • width (float) –

  • height (float) –

enum cq_cam.Unit(value)[source]

Bases: enum.Enum

An enumeration.

Valid values are as follows:

METRIC = <Unit.METRIC: 20>
IMPERIAL = <Unit.IMPERIAL: 21>