Skip to main content
It gives you a scene, a camera, a renderer, lights, a grid and a render loop. Use it when you do not have a Three.js scene of your own.

Import

Example

Notes

  • The container must have a width and a height.
  • The constructor starts the render loop. Do not add a second loop.
  • Start the geometry kernel separately, before you create elements.
  • dispose() stops the loop and removes the canvas.

Constructor

Properties

THREE.Scene
THREE.WebGLRenderer
PlanCamera
THREE.PerspectiveCamera
HTMLElement
ICanvasTheme
activeTheme
THREE.GridHelper | undefined

Methods

generateTheme

toggleTheme

setup

toggleGrid

hexToRgb

captureView

Render the scene from camera to a PNG data-URL, off-screen at an arbitrary resolution.

enableAnalyticLod

Configure public SDK worker assets; model registration is independent of camera requests and scene snapshots.

disableAnalyticLod

syncAnalyticLod

Call after authored tree changes; unchanged bodies never resend their serialized models.

refineAnalyticView

Await this before synchronous image capture to require a world-space chord error.

dispose

animate

Types

ICanvasTheme

activeTheme

Last modified on October 6, 2026