Class Job

constructor

• new Job(
      opts?: {
          extrusionWidth?: number;
          lineHeight?: number;
          minLayerThreshold?: number;
          state?: State;
      },
  ): Job

  Creates a new Job instance

  Parameters

  • opts: {
        extrusionWidth?: number;
        lineHeight?: number;
        minLayerThreshold?: number;
        state?: State;
    } = {}

    Job options

    • OptionalextrusionWidth?: number

      Width the caller supplied through the public API, if any

    • OptionallineHeight?: number

      Line height the caller supplied through the public API, if any

    • OptionalminLayerThreshold?: number

      Minimum layer height threshold (default: LayersIndexer.DEFAULT_TOLERANCE)

    • Optionalstate?: State

      Initial state (default: State.initial)

  Returns Job

  Remarks

  A dimension the caller supplied is not derived: asking for a width is a decision, while deriving one is an inference, and the decision wins. The slicer's own ;WIDTH: / ;HEIGHT: comments still outrank both.

boundingBox

inprogressPath

paths

state

stats

countLayers

• get countLayers(): number

  Gets the total number of layers in the job

  Returns number

  Number of layers

extrusions

• get extrusions(): Path[]

  Gets all extrusion paths in the job

  Returns Path[]

  Array of extrusion paths

isPlanar

• get isPlanar(): boolean

  Checks if the job contains planar extrusion layers

  Returns boolean

  True if the job contains at least one layer, false otherwise

layers

• get layers(): Layer[]

  Gets all layers in the job

  Returns Layer[]

  Array of Layer objects

metadata

• get metadata(): Metadata

  Gets the slicer metadata (thumbnails, layer metadata, slicer name) for this job

  Returns Metadata

  The metadata, or undefined if none has been set
• set metadata(metadata: Metadata): void

  Sets the slicer metadata and forwards layer metadata to the layer indexer

  Parameters

  • metadata: Metadata

    Parsed slicer metadata

  Returns void

  Remarks

  Must be set before paths are indexed (i.e. before executing commands) so the layer indexer can use slicer-provided layer boundaries instead of the tolerance-based fallback.

toolPaths

• get toolPaths(): Path[][]

  Gets paths organized by tool

  Returns Path[][]

  2D array of paths, where each sub-array contains paths for a specific tool

travels

• get travels(): Path[]

  Gets all travel paths in the job

  Returns Path[]

  Array of travel paths

addPath

• addPath(path: Path): void

  Adds a path to the job and indexes it

  Parameters

  • path: Path

    Path to add

  Returns void

beginCommand

• beginCommand(): void

  Advances the job to the next command the interpreter executes

  Returns void

  Remarks

  Called by the interpreter once per command, in file order. Every parsed line yields exactly one command, so counting them gives the current line index — which is how line-indexed slicer metadata is mapped onto the command stream: extrusion dimension changes (;WIDTH: / ;HEIGHT: comments) recorded at or before this line are folded into the state here. The in-progress path is deliberately left alone: the move handlers break it via continuePath when the state no longer matches, which keeps a streamed parse identical to a one-shot parse — the interpreter resumes the last path at every chunk boundary, undoing any break performed here.

breakPath

• breakPath(newType: PathType): Path

  Finalizes the current in-progress path and starts a new one of the given type

  Parameters

  • newType: PathType

    Type of the new path

  Returns Path

  The newly created path, seeded with the current position

  Remarks

  Called when a path type change is detected (e.g. switching between travel and extrusion moves).

continuePath

• continuePath(pathType: PathType): Path

  Returns the path the next move of the given type should extend

  Parameters

  • pathType: PathType

    Type of the move about to be added

  Returns Path

  The in-progress path when it can continue, otherwise a fresh one

  Remarks

  The in-progress path continues only while its type and its extrusion dimensions still match the state; dimension metadata that changed the state since the path was started (see beginCommand) breaks it here, so every path carries a single width and height. Deciding this lazily at move time (and not when the metadata is applied) keeps streamed and one-shot parses identical: the interpreter resumes the last finished path at every chunk boundary, which would undo an eager break.

deriveMoveDimensions

• deriveMoveDimensions(
      target: { x: number; y: number; z: number },
      extruded: number,
  ): void

  Parameters

  • target: { x: number; y: number; z: number }
  • extruded: number

  Returns void

finishPath

• finishPath(): void

  Finalizes the current in-progress path

  Returns void

  Remarks

  If the in-progress path has vertices, it will be added to the job and the in-progress path reference will be cleared

resolvePosition

• resolvePosition(): { x: number; y: number; z: number }

  Resolves the current state's position for rendering.

  Returns { x: number; y: number; z: number }

  The position as concrete x, y, z numbers

  Remarks

  An axis that has not been homed has an unknown (undefined) position. The job chooses to assume the origin (0) for such axes so the viewer can still render best-effort (see #361); state.isHomed lets a consumer tell these assumed coordinates from real ones.

resumeLastPath

• resumeLastPath(): void

  Resumes the last path from the job as the current in-progress path

  Returns void

  Remarks

  Removes the path from all indexes and sets it as the current in-progress path