Interface ModelViewer

interface ModelViewer {
    capture(opts?: CaptureOptions): Promise<Blob>;
    dispose(): void;
    frame(): void;
    getCameraState(): null | CameraState;
    onEvent(cb: (e: ModelViewerEvent) => void): () => void;
    resize(width: number, height: number): void;
    setBackground(bg: ModelBackground): void;
    setCameraState(state: CameraState): void;
    setInteractionQuality(mode: "off" | "auto"): void;
    setRenderScope(scope: null | RenderScope): void;
    setSource(input: ModelSourceInput): Promise<ModelReadyInfo>;
    setView(view: CameraView): void;
}

Index

Methods

capture dispose frame getCameraState onEvent resize setBackground setCameraState setInteractionQuality setRenderScope setSource setView

Methods

capture

capture(opts?: CaptureOptions): Promise<Blob>
Capture the current view as an image Blob (DD-030 D1) — for an operator-selected thumbnail or a large-file fallback. Rejects with E_CAPTURE_UNSUPPORTED when the renderer is unavailable.
Parameters
- Optionalopts: CaptureOptions
Returns Promise<Blob>
- Defined in gcode-model-renderer/src/model-viewer.ts:126

dispose

dispose(): void
Returns void
- Defined in gcode-model-renderer/src/model-viewer.ts:128

frame

frame(): void
Re-fit the camera to the current model bounds.

Returns void
- Defined in gcode-model-renderer/src/model-viewer.ts:115

getCameraState

getCameraState(): null | CameraState
Current camera pose, or null before a source is set / when the renderer is unsupported.

Returns null | CameraState
- Defined in gcode-model-renderer/src/model-viewer.ts:109

onEvent

onEvent(cb: (e: ModelViewerEvent) => void): () => void
Parameters
- cb: (e: ModelViewerEvent) => void
Returns () => void
- Defined in gcode-model-renderer/src/model-viewer.ts:127

resize

resize(width: number, height: number): void
Parameters
- width: number
- height: number
Returns void
- Defined in gcode-model-renderer/src/model-viewer.ts:113

setBackground

setBackground(bg: ModelBackground): void
Parameters
- bg: ModelBackground
Returns void
- Defined in gcode-model-renderer/src/model-viewer.ts:111

setCameraState

setCameraState(state: CameraState): void
Parameters
- state: CameraState
Returns void
- Defined in gcode-model-renderer/src/model-viewer.ts:110

setInteractionQuality

setInteractionQuality(mode: "off" | "auto"): void
Parameters
- mode: "off" | "auto"
Returns void
- Defined in gcode-model-renderer/src/model-viewer.ts:112

setRenderScope

setRenderScope(scope: null | RenderScope): void
Render only a subset of the current source (DD-030 D2): { plateId }, { objectIds }, or an { instanceFilter }; null restores the whole source. Rebuilds and reframes to the subset. Gate a { plateId } on the ready info's plates being present — an unmatched scope renders empty.
Parameters
- scope: null | RenderScope
Returns void
- Defined in gcode-model-renderer/src/model-viewer.ts:121

setSource

setSource(input: ModelSourceInput): Promise<ModelReadyInfo>
Parse → build → frame → ready. Async (3MF unzips). Overlapping calls are last-wins.
Parameters
- input: ModelSourceInput
Returns Promise<ModelReadyInfo>
- Defined in gcode-model-renderer/src/model-viewer.ts:105

setView

setView(view: CameraView): void
Snap to a preset orientation (shared with the toolpath camera).
Parameters
- view: CameraView
Returns void
- Defined in gcode-model-renderer/src/model-viewer.ts:107