AvaCapoSDK~ SceneManager

Default options of SceneManager.

{
 fps: 30,
 modelPixelRatio: 1,
 environment: 'room', // 'room' | 'none' | Texture | CubeTexture | Scene
 useEnvAsBackground: false,
 transparentBackground: false,
 camera: {
   distance: 0,
   offsetX: 0,
   offsetY: 0,
   rotX: 0,
   rotY: 0,
   rotZ: 0,
   cameraRotateEnable: false,
   cameraPanEnable: false,
   cameraZoomEnable: false,
 },
 lighting: {
   ambient: {
   color: 0xffffff,
   intensity: 2,
 },
 directional: {
   color: 0x8888aa,
   intensity: 30,
   phi: 1,
   theta: 2,
 },
 spot: {
   intensity: 0,
   color: 0x3388ff,
   phi: 0.1,
   theta: 4,
   angle: 1,
   }
 },
 devtools: {
   stats: {
     enabled: false,
     container: null, // HTMLElement or null (defaults to SceneManager.container)
     style: null,     // inline CSS string
 }
}

Registers a loop observer (plugin) to receive cycle hooks. Returns a disposer function that removes the observer.

Adds a custom function to be called on each internal logic update (update()). Useful for updating animations, physics, or any time-based logic at a fixed FPS rate.

Clears the current 2D background image, if any.

Disposes the texture and removes it from the background material. After calling this, only the 3D scene or environment map will be rendered.

Disposes all WebGL resources and DOM bindings related to the SceneManager instance.

This includes renderer, lights, controls, environment maps, resize observers, and background textures. After calling destroy(), the instance becomes unusable. Useful when cleaning up the scene or navigating away from the current view.

Renders the scene to the WebGL context.

If a 2D background image is present, it is drawn first using an orthographic camera, followed by the 3D scene render. If no background is set, the 3D scene is rendered normally.

This is called automatically in the internal loop (after updates), but can also be invoked manually.

Checks if a background image is currently active.

Handles resizing of the renderer and cameras when the container changes size.

This method updates the perspective and orthographic projection matrices, re-applies the background quad layout, and triggers a redraw. Automatically bound to a ResizeObserver on initialization.

Removes a previously registered loop observer.

Removes a function from the internal logic update loop.

If you previously added a ticker using addTicker, you can remove it manually using this method, or use the disposer function returned from addTicker().

Sets a 2D image as a background overlay, rendered behind the 3D scene.

Supports sources such as image URLs, File/Blob objects, HTML elements (canvas/image), and ImageBitmap. Allows customization of fitting mode, alignment, and tiling (repeat).

If no source is provided, the background is cleared automatically.

Set the camera pose (target and position) with optional tweening.

If position is omitted, the final position is computed from distance and Euler rotations rotX/rotY/rotZ around the target, using a forward vector (0, 0, distance). When duration is greater than 0, a smooth tween runs from the current pose to the requested pose; otherwise the pose is applied immediately.

Notes:

• target and position can be plain objects with x/y/z or any object exposing those fields.
• If neither position nor distance is provided, the current camera position is kept.
• The tween uses the manager's internal loop and is updated in _updateCameraTween().

Sets the environment map for the scene — either a preset ('room'), a texture, a cube texture, or a full scene. Optionally applies it as a visual background in addition to the lighting environment.

Previously set environments are properly disposed.

Sets the internal update frequency (logic FPS) for animations and tickers.

This affects how often update() is called within the render loop. A higher FPS means smoother updates but more CPU load.

Updates the scene's lighting configuration with new ambient, directional, and/or spot light settings.

You can update any subset of the lighting configuration — only provided fields will be modified.

Starts the internal render/update loop.

This loop runs at the logical FPS defined in opts.fps and updates camera animations, tickers (via addTicker()), and rendering. Calling this method multiple times has no effect.

Stops the internal render/update loop.

After stopping, no update() or draw() calls will be made automatically until start() is called again.

Updates internal state of the scene for a single frame.

Called automatically in the internal loop at fixed time intervals. Updates camera tweening and invokes all functions registered via addTicker(). Can be called manually if needed.

Loop observer interface. Implement any subset of these callbacks and register via addLoopObserver().