Class SceneManager

WebGL-based G-code preview renderer

Constructors

constructor

new SceneManager(opts: SceneManagerOptions, job: Job): SceneManager
Creates a new SceneManager instance
Parameters
- opts: SceneManagerOptions
  Configuration options
- job: Job
Returns SceneManager
Throws
Error if no canvas element is provided
- Defined in src/scene-manager.ts:152

Properties

camera

camera: PerspectiveCamera | OrthographicCamera

Three.js camera (perspective or orthographic)

canvas

canvas: HTMLCanvasElement

Canvas element being rendered to

controls

controls: OrbitControls

Orbit controls for camera

job

job: Job

lastRenderTime

lastRenderTime: number = 0

Last render time in milliseconds

`Optional`onFrameRendered

onFrameRendered?: () => void

Called after every rendered frame, for consumers that track render stats.

Remarks

Holds a single callback: assigning it replaces any previous one.

renderer

renderer: WebGLRenderer & {
    info: {
        memory: { geometries: number; textures: number };
        render: {
            calls: number;
            lines: number;
            points: number;
            triangles: number;
        };
    };
}

Three.js WebGL renderer

scene

scene: Scene

Three.js scene

`Static` `Readonly`defaultExtrusionColor

defaultExtrusionColor: Color = ObjectsManager.defaultExtrusionColor

Default extrusion color

Accessors

ambientLight

get ambientLight(): number
Returns number
- Defined in src/scene-manager.ts:552
set ambientLight(value: number): void
Parameters
- value: number
Returns void
- Defined in src/scene-manager.ts:555

backgroundColor

get backgroundColor(): Color
Gets the current background color

Returns Color
Current background color
- Defined in src/scene-manager.ts:276
set backgroundColor(value: string | number | Color): void
Sets the background color
Parameters
- value: string | number | Color
  Color value as number, string, or Color instance
Returns void
- Defined in src/scene-manager.ts:284

boundingBoxColor

get boundingBoxColor(): ColorRepresentation
Gets the current bounding box color

Returns ColorRepresentation
Color representation or undefined if not set
- Defined in src/scene-manager.ts:359
set boundingBoxColor(value: ColorRepresentation): void
Sets the bounding box color
Parameters
- value: ColorRepresentation
  Color value or undefined to hide the bounding box
Returns void
- Defined in src/scene-manager.ts:367

boundingBoxMesh

get boundingBoxMesh(): LineBox
Returns LineBox
- Defined in src/scene-manager.ts:420

brightness

get brightness(): number
Returns number
- Defined in src/scene-manager.ts:566
set brightness(value: number): void
Parameters
- value: number
Returns void
- Defined in src/scene-manager.ts:569

buildVolume

get buildVolume(): BuildVolume
Gets the current build volume

Returns BuildVolume
Current build volume or undefined if not set
- Defined in src/scene-manager.ts:242
set buildVolume(value: BuildVolumeDef): void
Sets the build volume dimensions
Parameters
- value: BuildVolumeDef
  Partial build volume properties (x, y, z, smallGrid)
Returns void
- Defined in src/scene-manager.ts:250

directionalLight

get directionalLight(): number
Returns number
- Defined in src/scene-manager.ts:559
set directionalLight(value: number): void
Parameters
- value: number
Returns void
- Defined in src/scene-manager.ts:562

disableGradient

get disableGradient(): boolean
Returns boolean
- Defined in src/scene-manager.ts:445
set disableGradient(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in src/scene-manager.ts:448

endLayer

get endLayer(): number
Gets the current end layer (1-based index)

Returns number
End layer number
- Defined in src/scene-manager.ts:494
set endLayer(value: number): void
Sets the end layer (1-based index)
Parameters
- value: number
  Layer number to end rendering at
Returns void
- Defined in src/scene-manager.ts:502

extrusionColor

get extrusionColor(): Color | Color[]
Gets the current extrusion color(s)

Returns Color | Color[]
Color or array of colors for extruded paths
- Defined in src/scene-manager.ts:258
set extrusionColor(value: string | number | Color | ColorRepresentation[]): void
Sets the extrusion color(s)
Parameters
- value: string | number | Color | ColorRepresentation[]
  Color value(s) as number, string, Color instance, or array of ColorRepresentation
Returns void
- Defined in src/scene-manager.ts:266

extrusionWidth

get extrusionWidth(): number
Returns number
- Defined in src/scene-manager.ts:438
set extrusionWidth(value: number): void
Parameters
- value: number
Returns void
- Defined in src/scene-manager.ts:441

lastSegmentColor

get lastSegmentColor(): ColorRepresentation
Gets the current last segment color

Returns ColorRepresentation
Color representation or undefined if not set
- Defined in src/scene-manager.ts:331
set lastSegmentColor(value: ColorRepresentation): void
Sets the last segment color
Parameters
- value: ColorRepresentation
  Color value or undefined to clear
Returns void
Remarks
Highlighting the last segment splits the final path out of its batch, so a change redraws the scene rather than recoloring in place.
- Defined in src/scene-manager.ts:342

lineHeight

get lineHeight(): number
Returns number
- Defined in src/scene-manager.ts:431
set lineHeight(value: number): void
Parameters
- value: number
Returns void
- Defined in src/scene-manager.ts:434

lineWidth

get lineWidth(): number
Returns number
- Defined in src/scene-manager.ts:424
set lineWidth(value: number): void
Parameters
- value: number
Returns void
- Defined in src/scene-manager.ts:427

orthographic

get orthographic(): boolean
Returns boolean
- Defined in src/scene-manager.ts:573
set orthographic(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in src/scene-manager.ts:577

renderExtrusion

get renderExtrusion(): boolean
Returns boolean
- Defined in src/scene-manager.ts:395
set renderExtrusion(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in src/scene-manager.ts:398

renderTravel

get renderTravel(): boolean
Returns boolean
- Defined in src/scene-manager.ts:404
set renderTravel(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in src/scene-manager.ts:407

renderTubes

get renderTubes(): boolean
Returns boolean
- Defined in src/scene-manager.ts:413
set renderTubes(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in src/scene-manager.ts:416

singleLayerMode

get singleLayerMode(): boolean
Gets whether single layer mode is enabled

Returns boolean
True if single layer mode is active
- Defined in src/scene-manager.ts:520
set singleLayerMode(value: boolean): void
Sets single layer mode
Parameters
- value: boolean
  True to enable single layer mode
Returns void
- Defined in src/scene-manager.ts:528

startLayer

get startLayer(): number
Gets the current start layer (1-based index)

Returns number
Start layer number
- Defined in src/scene-manager.ts:377
set startLayer(value: number): void
Sets the start layer (1-based index)
Parameters
- value: number
  Layer number to start rendering from
Returns void
- Defined in src/scene-manager.ts:385

topLayerColor

get topLayerColor(): ColorRepresentation
Gets the current top layer color

Returns ColorRepresentation
Color representation or undefined if not set
- Defined in src/scene-manager.ts:309
set topLayerColor(value: ColorRepresentation): void
Sets the top layer color
Parameters
- value: ColorRepresentation
  Color value or undefined to clear
Returns void
Remarks
Highlighting the top layer picks specific paths out of the per-tool batches, so a change redraws the scene rather than recoloring in place.
- Defined in src/scene-manager.ts:320

travelColor

get travelColor(): Color
Gets the current travel move color

Returns Color
Current travel move color
- Defined in src/scene-manager.ts:293
set travelColor(value: string | number | Color): void
Sets the travel move color
Parameters
- value: string | number | Color
  Color value as number, string, or Color instance
Returns void
- Defined in src/scene-manager.ts:301

Methods

clear

clear(): void
Returns void
- Defined in src/scene-manager.ts:745

clearCamera

clearCamera(): void
Returns void
- Defined in src/scene-manager.ts:968

dispose

dispose(): void
Returns void
- Defined in src/scene-manager.ts:799

loadCamera

loadCamera(): void
Returns void
- Defined in src/scene-manager.ts:947

render

render(): void
Renders all visible paths in the scene

Returns void
- Defined in src/scene-manager.ts:658

renderAnimated

renderAnimated(pathCount?: number): Promise<void>
Experimental
Renders paths incrementally using an animation loop
Parameters
- pathCount: number = undefined
  Number of paths to render per frame
Returns Promise<void>
Promise that resolves when rendering is complete
- Defined in src/scene-manager.ts:673

resize

resize(): void
Returns void
- Defined in src/scene-manager.ts:779

saveCamera

saveCamera(): void
Returns void
- Defined in src/scene-manager.ts:941

updateClippingPlanes

updateClippingPlanes(): void
Updates the clipping planes for the 3D preview based on the start and end layers.

This method calculates the minimum and maximum Z values from the specified start and end layers. A bound that is unset — or that sits at the very end of the layer stack — leaves that side of the range unbounded: an endLayer equal to the layer count is no restriction, so moves outside the printed layers (travel moves above the top layer, most commonly) stay visible.

It then updates the clipping planes for shader materials and line clipping using these Z values.

Returns void
- Defined in src/scene-manager.ts:478

Class SceneManager

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns SceneManager

Throws

Properties

camera

canvas

controls

job

lastRenderTime

OptionalonFrameRendered

Remarks

renderer

scene

Static ReadonlydefaultExtrusionColor

Accessors

ambientLight

Returns number

Parameters

Returns void

backgroundColor

Returns Color

Parameters

Returns void

boundingBoxColor

Returns ColorRepresentation

Parameters

Returns void

boundingBoxMesh

Returns LineBox

brightness

Returns number

Parameters

Returns void

buildVolume

Returns BuildVolume

Parameters

Returns void

directionalLight

Returns number

Parameters

Returns void

disableGradient

Returns boolean

Parameters

Returns void

endLayer

Returns number

Parameters

Returns void

extrusionColor

Returns Color | Color[]

Parameters

Returns void

extrusionWidth

Returns number

Parameters

Returns void

lastSegmentColor

Returns ColorRepresentation

Parameters

Returns void

Remarks

lineHeight

Returns number

Parameters

Returns void

lineWidth

Returns number

Parameters

Returns void

orthographic

Returns boolean

`Optional`onFrameRendered

`Static` `Readonly`defaultExtrusionColor