Interface PreviewRenderer

ReadonlyhasColorChanges

ReadonlyhasRetractions

ReadonlylayerCount

ReadonlysegmentCount

appendPartial

• appendPartial(slice: ToolpathIR): void

  Progressive partial IR (3D only; the 2D renderer draws on the final IR).

  Parameters

  • slice: ToolpathIR

  Returns void

Optionalcapture

• capture(opts?: CaptureOptions): Promise<Blob>

  Capture the current view as an image Blob (DD-030 D1). Optional: the 3D renderer implements it via render-to-target; a renderer that cannot (the 2D renderer) omits it, and the controller reports renderer-unsupported / rejects. Never fabricated output.

  Parameters

  • Optionalopts: CaptureOptions

  Returns Promise<Blob>

dispose

• dispose(): void

  Returns void

frame

• frame(): void

  Returns void

getCameraState

• getCameraState(): null | CameraState

  Read the current camera as a serializable snapshot (#268). Null when the renderer has no 3D pose (2D).

  Returns null | CameraState

getRenderStats

• getRenderStats(): null | RenderStats

  Render diagnostics snapshot (DD-027) — backend/GPU/geometry-mode/parallelism/timings — or null before the first render / on a renderer that produces none (the 2D view). Exposed through the public surface so diagnostics are reachable without the raw handle (DD-031 G1).

  Returns null | RenderStats

isColorModeAvailable

• isColorModeAvailable(
      mode:
          | "object"
          | "single"
          | "tool"
          | "feature"
          | "colorChange"
          | "filament"
          | "feedrate"
          | "layerHeight"
          | "power"
          | "moveKind",
  ): boolean

  Capability gate for a color mode (DD-001 honesty): false when the IR lacks the channel the mode reads (e.g. feature on a file with no feature roles). Lets a consumer build capability-aware UI without the raw handle (DD-031 G6). single/tool/moveKind are always available.

  Parameters

  • mode:
        | "object"
        | "single"
        | "tool"
        | "feature"
        | "colorChange"
        | "filament"
        | "feedrate"
        | "layerHeight"
        | "power"
        | "moveKind"

  Returns boolean

onEvent

• onEvent(cb: (e: PreviewRendererEvent) => void): () => void

  Parameters

  • cb: (e: PreviewRendererEvent) => void

  Returns () => void

pickSegment

• pickSegment(ndcX: number, ndcY: number, threshold?: number): null | number

  Pick the IR segment under a pointer (normalized device coords in [-1, 1]), or null (#184). The 3D renderer raycasts the toolpath; the 2D renderer returns null (no picking yet).

  Parameters

  • ndcX: number
  • ndcY: number
  • Optionalthreshold: number

  Returns null | number

resize

• resize(width: number, height: number): void

  Parameters

  • width: number
  • height: number

  Returns void

setBuildVolume

• setBuildVolume(def: BuildVolumeDef | MachineGeometry): void

  Parameters

  • def: BuildVolumeDef | MachineGeometry

  Returns void

setBuildVolumeCage

• setBuildVolumeCage(visible: boolean): void

  Show/hide the build-volume wireframe cage independently of the bed/plate (#306/#6).

  Parameters

  • visible: boolean

  Returns void

setCameraMode

• setCameraMode(mode: CameraMode): void

  Parameters

  • mode: CameraMode

  Returns void

setCameraState

• setCameraState(state: CameraState): void

  Restore a camera snapshot verbatim (#268). 2D renderers disclose via renderer-unsupported.

  Parameters

  • state: CameraState

  Returns void

setColorMode

• setColorMode(mode: ColorMode): boolean

  Parameters

  • mode: ColorMode

  Returns boolean

OptionalsetFeatureRoleVisible

• setFeatureRoleVisible(role: FeatureRoleValue, visible: boolean): void

  Show/hide a single feature role (e.g. hide Skirt/Brim). 3D only — the flat 2D view treats it as a no-op. Optional so a renderer need not implement it; gate the UI on featureRoles: 'known'.

  Parameters

  • role: FeatureRoleValue
  • visible: boolean

  Returns void

setFrameContent

• setFrameContent(mode: "object" | "all"): void

  Frame the printed 'object' (excl. skirt/prime) vs 'all' extrusion (#306/#6).

  Parameters

  • mode: "object" | "all"

  Returns void

setInteractionQuality

• setInteractionQuality(mode: "auto" | "off"): void

  Interaction-aware quality: 'auto' reduces detail while the camera moves (#306/2, DD-020).

  Parameters

  • mode: "auto" | "off"

  Returns void

setIR

• setIR(ir: ToolpathIR): void

  Parameters

  • ir: ToolpathIR

  Returns void

setKindVisible

• setKindVisible(kind: MoveKindToggle, visible: boolean): void

  Parameters

  • kind: MoveKindToggle
  • visible: boolean

  Returns void

setLayerRange

• setLayerRange(startLayer: number, endLayer: number): void

  Parameters

  • startLayer: number
  • endLayer: number

  Returns void

setProgress

• setProgress(p: null | MappedProgress): void

  Parameters

  • p: null | MappedProgress

  Returns void

setProgressivePreview

• setProgressivePreview(mode: ProgressivePreview): void

  During-parse preview curtain (#60): 'lines' | 'hold' | 'off'. Applies to the NEXT parse. 3D only; 2D is a no-op.

  Parameters

  • mode: ProgressivePreview

  Returns void

setQuality

• setQuality(quality: QualityMode | "auto"): void

  Parameters

  • quality: QualityMode | "auto"

  Returns void

setQualityMode

• setQualityMode(mode: QualityPolicy): void

  Fidelity policy (DD-023 §4 D6): 'full' | 'adaptive' | 'fast'. 3D only; 2D is a no-op.

  Parameters

  • mode: QualityPolicy

  Returns void

setScrubPosition

• setScrubPosition(segIndex: null | number): void

  Parameters

  • segIndex: null | number

  Returns void

setShowRetractions

• setShowRetractions(visible: boolean): void

  Parameters

  • visible: boolean

  Returns void

setTheme

• setTheme(theme: Theme): void

  Parameters

  • theme: Theme

  Returns void

setView

• setView(view: CameraView): void

  Snap to a preset orientation (#268). 2D renderers disclose via renderer-unsupported.

  Parameters

  • view: CameraView

  Returns void