Class GCodePreview

constructor

• new GCodePreview(opts: GCodePreviewOptions): GCodePreview

  Creates a new GCodePreview instance

  Parameters

  • opts: GCodePreviewOptions

    Configuration options for the preview

  Returns GCodePreview

job

countLayers

• get countLayers(): number

  Gets the total number of layers in the job

  Returns number

  Number of layers

devMode

• get devMode(): boolean | DevModeOptions

  Returns boolean | DevModeOptions

• set devMode(value: boolean | DevModeOptions): void

  Parameters

  • value: boolean | DevModeOptions

  Returns void

parser

• get parser(): Parser

  The G-code parser instance

  Returns Parser

sceneManager

• get sceneManager(): SceneManager

  The WebGL sceneManager instance for direct access to rendering properties

  Returns SceneManager

clear

• clear(): void

  Clears the preview and resets the parser, sceneManager, gui and job

  Returns void

dispose

• dispose(): void

  Disposes of all resources and cleans up

  Returns void

processGCode

• processGCode(gcode: string | string[]): void

  Processes G-code and renders the preview

  Parameters

  • gcode: string | string[]

    G-code string or array of lines

  Returns void

processGCodeStream

• processGCodeStream(
      gcode: string | string[] | ReadableStream<any>,
      options?: { render?: boolean },
  ): Promise<void>

  Processes G-code using the sceneManager's built-in streaming method

  Parameters

  • gcode: string | string[] | ReadableStream<any>

    G-code string or array of strings to process
  • options: { render?: boolean } = ...

    Options for rendering: { render: boolean }

  Returns Promise<void>

  Remarks

  Parses the G-code, executes commands, and renders the paths if render is true.

readStream

• readStream(stream: ReadableStream): Promise<void>

  Parameters

  • stream: ReadableStream

  Returns Promise<void>

render

• render(): void

  Renders the current scene

  Returns void