Interface ModelPreviewControls

Imperative controls — a thin proxy over the engine, queued until the canvas binds.

interface ModelPreviewControls {
    capture(opts?: CaptureOptions): Promise<Blob>;
    frame(): void;
    getCameraState(): null | CameraState;
    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 frame getCameraState resize setBackground setCameraState setInteractionQuality setRenderScope setSource setView

Methods

capture

capture(opts?: CaptureOptions): Promise<Blob>
Capture the current view as an image Blob; rejects with E_CAPTURE_UNSUPPORTED when unavailable.
Parameters
- Optionalopts: CaptureOptions
Returns Promise<Blob>
- Defined in gcode-model-renderer/src/model-preview.ts:105

frame

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

Returns void
- Defined in gcode-model-renderer/src/model-preview.ts:102

getCameraState

getCameraState(): null | CameraState
Returns null | CameraState
- Defined in gcode-model-renderer/src/model-preview.ts:95

resize

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

setBackground

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

setCameraState

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

setInteractionQuality

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

setRenderScope

setRenderScope(scope: null | RenderScope): void
Render only a subset of the source ({ plateId } / { objectIds } / { instanceFilter }); null = whole source.
Parameters
- scope: null | RenderScope
Returns void
- Defined in gcode-model-renderer/src/model-preview.ts:100

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-preview.ts:93

setView

setView(view: CameraView): void
Parameters
- view: CameraView
Returns void
- Defined in gcode-model-renderer/src/model-preview.ts:94