Class SmallWorld`Abstract`

Base class for applications built with the SmallWorld engine.

Hierarchy (View Summary)

SmallWorld
- AbstractShowcase

Index

Constructors

Properties

camera canvas config debug interactionManager renderer scene

Methods

onInspectorReady setupScene start stop update

Constructors

`Protected`constructor

new SmallWorld(userConfig?: EngineOptions): SmallWorld
Creates a new SmallWorld application.
Parameters
- userConfig: EngineOptions = {}
  Optional configuration to override defaults.
Returns SmallWorld
- Defined in core/SmallWorld.ts:57

Properties

camera

camera: Camera

The main camera.

canvas

canvas: HTMLCanvasElement

The canvas element.

config

config: EngineOptions

The engine configuration.

debug

debug: boolean = false

Whether debug visualization is enabled.

interactionManager

interactionManager: InteractionManager

The interaction manager for gamification / picking.

renderer

renderer: Renderer

The active renderer.

scene

scene: Scene

The current scene.

Methods

`Protected`onInspectorReady

onInspectorReady(_inspector: GadgetInspector): void
Called once after the GadgetInspector is created. Override in subclasses to register scene-specific inspector controls.
Parameters
- _inspector: GadgetInspector
  The newly created inspector instance.
Returns void
- Defined in core/SmallWorld.ts:106

`Protected` `Abstract`setupScene

setupScene(): Promise<void>
Called to setup the scene after the engine is initialized.

Returns Promise<void>
- Defined in core/SmallWorld.ts:98

start

start(): Promise<void>
Initializes and starts the application loop.

Returns Promise<void>
- Defined in core/SmallWorld.ts:119

stop

stop(): void
Stops the application loop.

Returns void
- Defined in core/SmallWorld.ts:245

`Protected` `Abstract`update

update(deltaTime: number): void
Called every frame to update application logic.
Parameters
- deltaTime: number
  Time elapsed since the last frame in seconds.
Returns void
- Defined in core/SmallWorld.ts:114