raygeo.cnc.plan
Plan-time description of machining operations.
Plans are produced by planners and consumed by Rayforge to derive its own Step classes. They are never executed directly.
Plan
A descriptive Plan produced by planners.
safe_z
safe_z: float
The safe Z height for retract moves.
step_count
step_count: int
Number of PlanSteps in this plan.
steps
steps: list[PlanStep]
The list of PlanSteps in this plan.
extend()
extend(steps: Sequence[PlanStep]) -> None
Append PlanSteps to this plan.
| Parameter | Type | Description |
|---|---|---|
steps | Sequence[PlanStep] | |
| Returns | None |
PlanStep
One step in a Plan: a face_id and an assembler spec.
face_id
face_id: str
The face this step targets.
kind
kind: str
The assembler kind (e.g. "helix", "adaptive_clearing").
spec_params()
spec_params() -> dict
All spec parameters as a Python dict.
| Parameter | Type | Description |
|---|---|---|
| Returns | dict |