Class Scene

Scene represents the root container of the engine's hierarchical scene graph. It coordinates active camera properties, registered light sources, visible meshes, background clear colors, and manages the high-performance requestAnimationFrame render loop, integrating performance tracking and debugging panels.

Hierarchy (View Summary)

Node
- Scene

Accessors

ambientGroundColor

get ambientGroundColor(): Color
Gets the hemispherical ambient ground color (surfaces pointing downward).

Returns Color
- Defined in graphics/scene.ts:211
set ambientGroundColor(color: ColorLike): void
Sets the hemispherical ambient ground color, parsing hex strings, arrays, or objects automatically.
Parameters
- color: ColorLike
Returns void
- Defined in graphics/scene.ts:216

ambientSkyColor

get ambientSkyColor(): Color
Gets the hemispherical ambient sky color (surfaces pointing upward).

Returns Color
- Defined in graphics/scene.ts:197
set ambientSkyColor(color: ColorLike): void
Sets the hemispherical ambient sky color, parsing hex strings, arrays, or objects automatically.
Parameters
- color: ColorLike
Returns void
- Defined in graphics/scene.ts:202

backgroundColor

get backgroundColor(): Color
Gets the background clear color.

Returns Color
- Defined in graphics/scene.ts:176
set backgroundColor(color: ColorLike): void
Sets the background clear color, parsing hex strings automatically.
Parameters
- color: ColorLike
Returns void
- Defined in graphics/scene.ts:181

bloom

get bloom(): {
    get enabled(): boolean;
    set enabled(value: boolean): void;
    get intensity(): number;
    set intensity(value: number): void;
    get knee(): number;
    set knee(value: number): void;
    get passes(): number;
    set passes(value: number): void;
    get threshold(): number;
    set threshold(value: number): void;
}
Access to the Bloom post-processing configuration system. Allows configuring bloom settings e.g. scene.bloom.enabled = true.

Returns {
    get enabled(): boolean;
    set enabled(value: boolean): void;
    get intensity(): number;
    set intensity(value: number): void;
    get knee(): number;
    set knee(value: number): void;
    get passes(): number;
    set passes(value: number): void;
    get threshold(): number;
    set threshold(value: number): void;
}
- Defined in graphics/scene.ts:320

camera

get camera(): Camera | null
Gets the active camera viewpoint.

Returns Camera | null
- Defined in graphics/scene.ts:152

canvas

get canvas(): HTMLCanvasElement
Gets the active HTMLCanvasElement swapchain presentation surface.

Returns HTMLCanvasElement
- Defined in graphics/scene.ts:139

defaultDir

get defaultDir(): string
Gets the default asset base directory.

Returns string
- Defined in graphics/scene.ts:228
set defaultDir(dir: string): void
Sets the default asset base directory, ensuring trailing slashes are appended.
Parameters
- dir: string
Returns void
- Defined in graphics/scene.ts:233

enableFXAA

get enableFXAA(): boolean
Gets the FXAA post-processing status.

Returns boolean
- Defined in graphics/scene.ts:300
set enableFXAA(value: boolean): void
Sets the FXAA post-processing status, writing parameters to logical GPU uniform buffers.
Parameters
- value: boolean
Returns void
- Defined in graphics/scene.ts:305

lights

get lights(): readonly Light[]
Gets a read-only list of registered light sources.

Returns readonly Light[]
- Defined in graphics/scene.ts:163

meshes

get meshes(): readonly Mesh[]
Gets a read-only list of registered meshes.

Returns readonly Mesh[]
- Defined in graphics/scene.ts:168

Constructors

constructor

new Scene(ctx: Context): Scene
Instantiates a new Scene root node.
Parameters
- ctx: Context
  Active context.
Returns Scene
Overrides Node.constructor
- Defined in graphics/scene.ts:278

Methods

add

add(node: Node): void
Overrides polymorphic hierarchy insertion to register Mesh children within the scene graph mesh arrays.
Parameters
- node: Node
  The node to add.
Returns void
Overrides Node.add
- Defined in graphics/scene.ts:620

addCube

addCube(options?: SceneGeometryOptions & { size?: number }): Mesh
Instantiates a Cube mesh and appends it to the scene tree.
Parameters
- options: SceneGeometryOptions & { size?: number } = {}
  Material parameters and sizing options.
Returns Mesh
The newly allocated Cube Mesh.
- Defined in graphics/scene.ts:543

addInstance

addInstance(
template: Node3D | Mesh,
options?: SceneGeometryOptions,
): Node3D | Mesh
Instantiates a copy of an existing Mesh template or hierarchy tree, sharing underlying Geometry buffers to optimize GPU draw calls via instancing.
Parameters
- template: Node3D | Mesh
  Source Mesh template to clone.
- options: SceneGeometryOptions = {}
  Spatial transform overrides.
Returns Node3D | Mesh
The newly allocated instantiated root Mesh or Node3D.
- Defined in graphics/scene.ts:474

addLight

addLight(options: Light | SceneLightOptions): Light
Appends a new Light node to the scene hierarchy. Programmatically resolves point or directional light sub-classes from configuration options.
Parameters
- options: Light | SceneLightOptions
  Light instance or configuration options.
Returns Light
The resolved Light node.
- Defined in graphics/scene.ts:383

addPlane

addPlane(
options?: SceneGeometryOptions & { height?: number; width?: number },
): Mesh
Instantiates a Plane mesh and appends it to the scene tree.
Parameters
- options: SceneGeometryOptions & { height?: number; width?: number } = {}
  Material parameters and width/depth dimensions.
Returns Mesh
The newly allocated Plane Mesh.
- Defined in graphics/scene.ts:584

addSphere

addSphere(
options?: SceneGeometryOptions & { radius?: number; segments?: number },
): Mesh
Instantiates a Sphere mesh and appends it to the scene tree.
Parameters
- options: SceneGeometryOptions & { radius?: number; segments?: number } = {}
  Material parameters and radius subdivisions options.
Returns Mesh
The newly allocated Sphere Mesh.
- Defined in graphics/scene.ts:562

buildMesh

buildMesh(config: BuildMeshOptions): Mesh
Compiles a Mesh from raw vertex component arrays and appends it to the scene tree.
Parameters
- config: BuildMeshOptions
  Mesh assembly configurations.
Returns Mesh
The newly programmatically assembled Mesh.
- Defined in graphics/scene.ts:607

destroy

destroy(): void
Releases scene resources, stops the render loop, disables debug panels, and cascades destruction to the renderer and context.

Returns void
- Defined in graphics/scene.ts:778

enableDebug

enableDebug(options?: any): Promise<DebugPanel>
Asynchronously imports and displays an interactive, hardware-monitored performance debug panel.
Parameters
- options: any = {}
  Styling and anchor options.
Returns Promise<DebugPanel>
A promise resolving to the debug panel.
- Defined in graphics/scene.ts:708

getCanvas

getCanvas(): HTMLCanvasElement
Gets the active HTMLCanvasElement presentation surface.

Returns HTMLCanvasElement
- Defined in graphics/scene.ts:144

getOverlappingBodies

getOverlappingBodies(node: Node3D): Mesh[]
Queries and returns all visible meshes whose world-space AABB bounding volumes intersect with the specified Node3D's world-space AABB. Utilized for broad-phase collision queries.
Parameters
- node: Node3D
  Target Node3D to test.
Returns Mesh[]
Meshes currently overlapping the query node.
- Defined in graphics/scene.ts:660

getRenderInfo

getRenderInfo(): Readonly<RenderInfo>
Returns live render statistics computed for the active frame.

Returns Readonly<RenderInfo>
Read-only RenderInfo.
- Defined in graphics/scene.ts:260

loadMesh

loadMesh(url: string, options?: SceneGeometryOptions): Promise<Node3D>
Asynchronously fetches a 3D model asset (GLB, GLTF, or OBJ), compiles GPU resources, and appends the resulting nodes to the scene hierarchy.
Parameters
- url: string
  Relative or absolute address of the 3D model file.
- options: SceneGeometryOptions = {}
  Material parameters and spatial transformations.
Returns Promise<Node3D>
A promise resolving to a container Node3D holding the loaded mesh segment nodes.
- Defined in graphics/scene.ts:525

remove

remove(node: Node): void
Overrides polymorphic hierarchy removals.
Parameters
- node: Node
  The node to remove.
Returns void
Overrides Node.remove
- Defined in graphics/scene.ts:643

removeLight

removeLight(light: Light): void
Detaches and removes an active Light node from the scene hierarchy and internal tracking.
Parameters
- light: Light
  The Light instance to remove.
Returns void
- Defined in graphics/scene.ts:416

render

render(loopCallback?: () => void): void
Initiates the standard requestAnimationFrame render loop. Calls the provided update routine every frame while updating render statistics.
Parameters
- OptionalloopCallback: () => void
  Update callback hook.
Returns void
- Defined in graphics/scene.ts:681

setCamera

setCamera(cameraOrOptions: Camera | CameraOptions): Camera
Registers and configures the active Camera viewpoints driving render passes. Automatically appends the Camera to the scene tree if it is not already present.
Parameters
- cameraOrOptions: Camera | CameraOptions
  Camera instance or constructor configurations.
Returns Camera
The resolved Camera node.
- Defined in graphics/scene.ts:363

traverse

traverse(callback: (node: Node) => void): void
Performs a depth-first traversal of the node hierarchy starting from this node, executing the provided callback on each visited node.
Parameters
- callback: (node: Node) => void
  The function to invoke for each node.
Returns void
Inherited from Node.traverse
- Defined in core/node.ts:69

updateLocalMatrix

updateLocalMatrix(): void
Recomputes the node's local transformation matrix. Base Node does not define individual translation, rotation, or scale properties. This should be overridden in subclasses (e.g. Node3D) that maintain distinct components.

Returns void
Inherited from Node.updateLocalMatrix
- Defined in core/node.ts:81

updateWorldMatrix

updateWorldMatrix(force?: boolean): void
Updates the global world matrix of this node and recursively propagates the updates down the hierarchy to all child nodes.
Parameters
- force: boolean = false
  If true, forces transformation matrices to be recomputed even if they are not flagged as dirty.
Returns void
Inherited from Node.updateWorldMatrix
- Defined in core/node.ts:92

`Static`init

init(selector: string | HTMLCanvasElement): Promise<Scene>
High-level initialization routine that resolves a canvas element, requests WebGPU adapters, boots GPUDevice services, and returns a new Scene container.
Parameters
- selector: string | HTMLCanvasElement
  Target CSS selector string or direct HTMLCanvasElement reference.
Returns Promise<Scene>
A promise resolving to an initialized Scene.
- Defined in graphics/scene.ts:292

Properties

`Readonly`children

children: Node[] = []

List of child nodes belonging to this node.

`Readonly`ctx

ctx: Context

Active context reference.

isDirty

isDirty: boolean = true

Whether the local transform has changed and needs to be recomputed and propagated.

localMatrix

localMatrix: Mat4 = ...

Local transformation matrix relative to the parent node.

name

name: string = ""

Unique identifier or friendly name for the node.

parent

parent: Node | null = null

Parent node in the scene graph. Null if this is the root node.

`Readonly`perfTracker

perfTracker: PerformanceTracker

High-performance CPU profiling metrics recorder.

`Readonly`renderer

renderer: Renderer

High-performance WebGPU forward renderer.

showHelpers

showHelpers: boolean = false

Toggle debug visualization helpers for lights and collision bounds. Defaults to false.

visible

visible: boolean = true

Visibility flag. If false, this node and its descendants are typically skipped in rendering.

worldMatrix

worldMatrix: Mat4 = ...

Global world transformation matrix relative to the scene origin.

Class Scene

Hierarchy (View Summary)

Index

Accessors

Constructors

Methods

Properties

Accessors

ambientGroundColor

Returns Color

Parameters

Returns void

ambientSkyColor

Returns Color

Parameters

Returns void

backgroundColor

Returns Color

Parameters

Returns void

bloom

Returns { get enabled(): boolean; set enabled(value: boolean): void; get intensity(): number; set intensity(value: number): void; get knee(): number; set knee(value: number): void; get passes(): number; set passes(value: number): void; get threshold(): number; set threshold(value: number): void;}

camera

Returns Camera | null

canvas

Returns HTMLCanvasElement

defaultDir

Returns string

Parameters

Returns void

enableFXAA

Returns boolean

Parameters

Returns void

lights

Returns readonly Light[]

meshes

Returns readonly Mesh[]

Constructors

constructor

Parameters

Returns Scene

Methods

add

Parameters

Returns void

addCube

Parameters

Returns Mesh

addInstance

Parameters

Returns Node3D | Mesh

addLight

Parameters

Returns Light

addPlane

Parameters

Returns Mesh

addSphere

Parameters

Returns Mesh

buildMesh

Parameters

Returns Mesh

destroy

Returns void

enableDebug

Parameters

Returns Promise<DebugPanel>

getCanvas

Returns HTMLCanvasElement

getOverlappingBodies

Parameters

Returns Mesh[]

getRenderInfo

Returns Readonly<RenderInfo>

loadMesh

Parameters

Returns Promise<Node3D>

remove

Returns {
get enabled(): boolean;
set enabled(value: boolean): void;
get intensity(): number;
set intensity(value: number): void;
get knee(): number;
set knee(value: number): void;
get passes(): number;
set passes(value: number): void;
get threshold(): number;
set threshold(value: number): void;
}

`Static`init

`Readonly`children

`Readonly`ctx

`Readonly`perfTracker

`Readonly`renderer