Represents the events emitted by a Scene.

This class provides a collection of event emitters for actions and updates that occur within a Scene and its owned components, such as models, objects, meshes, geometries, transforms, textures, and coordinate systems.

Properties

onError: EventEmitter<Scene, SDKResult<any>>

Emits an event when an error occurs within the Scene or any of its child components. This non-fatal event is fired with an SDKResult containing error details whenever an operation fails.

onSceneAnimationCreated: EventEmitter<Scene, SceneAnimation>

Emits an event each time a model!scene.animation.SceneAnimation | SceneAnimation is created within the Scene.

onSceneAnimationDestroyed: EventEmitter<Scene, SceneAnimation>

Emits an event each time a model!scene.animation.SceneAnimation | SceneAnimation is destroyed within the Scene.

onSceneCoordSystemBasisChanged: EventEmitter<Scene, CoordinateSystem>

Emits an event when the CoordinateSystem.basis of the Scene is updated.

onSceneCoordSystemOriginChanged: EventEmitter<Scene, CoordinateSystem>

Emits an event when the CoordinateSystem.origin of the Scene is updated.

onSceneCoordSystemScaleToMetersChanged: EventEmitter<Scene, CoordinateSystem>

Emits an event when the CoordinateSystem.scaleToMeters of the Scene is updated.

onSceneCoordSystemUnitsChanged: EventEmitter<Scene, CoordinateSystem>

Emits an event when the CoordinateSystem.units of the Scene is updated.

onSceneCoordSystemUpdated: EventEmitter<Scene, CoordinateSystem>

Emits an event after one or more coordinate system properties of the Scene have been updated, indicating that the CoordinateSystem is ready for use.

onSceneDestroyed: EventEmitter<Scene, Scene>

Emits an event when the Scene is destroyed.

onSceneGeometryCreated: EventEmitter<Scene, SceneGeometry>

Emits an event each time a SceneGeometry is created within the Scene.

Geometry frame sequences supplied through frames / framesCompressed are immutable, geometry-owned payload and are covered by this creation event.

onSceneGeometryDestroyed: EventEmitter<Scene, SceneGeometry>

Emits an event each time a SceneGeometry is destroyed within the Scene.

onSceneGeometryUpdated: EventEmitter<Scene, SceneGeometry>

Emits an event each time mutable fixed-count data on a SceneGeometry is updated within the Scene, such as dynamic changes to current/base positions, indices or normals.

This does not fire merely because a geometry was created with immutable framesCompressed; those frames are reported by onSceneGeometryCreated.

onSceneMaterialColorChanged: EventEmitter<Scene, SceneMaterial>

Emits an event each time the color of a SceneMaterial is updated within the Scene.

onSceneMaterialCreated: EventEmitter<Scene, SceneMaterial>

Emits an event each time a SceneMaterial is created within the Scene.

onSceneMaterialDestroyed: EventEmitter<Scene, SceneMaterial>

Emits an event each time a SceneMaterial is destroyed within the Scene.

onSceneMaterialEmissiveColorChanged: EventEmitter<Scene, SceneMaterial>

Emits an event each time the emissive color of a SceneMaterial is updated within the Scene.

onSceneMaterialOpacityChanged: EventEmitter<Scene, SceneMaterial>

Emits an event each time the opacity of a SceneMaterial is updated within the Scene.

onSceneMaterialPatternChanged: EventEmitter<Scene, SceneMaterial>

Emits an event each time the SceneMaterial.linePattern or SceneMaterial.hatchPattern of a SceneMaterial is updated within the Scene. Downstream consumers re-encode the affected pattern slot in their per-batch pattern tables.

onSceneMeshColorChanged: EventEmitter<Scene, SceneMesh>

Emits an event each time the color of a SceneMesh is updated within the Scene.

onSceneMeshCreated: EventEmitter<Scene, SceneMesh>

Emits an event each time a SceneMesh is created within the Scene.

onSceneMeshDestroyed: EventEmitter<Scene, SceneMesh>

Emits an event each time a SceneMesh is destroyed within the Scene.

onSceneMeshFrameTimeChanged: EventEmitter<Scene, SceneMesh>

Emits an event each time the frame-sampling time of a SceneMesh is updated within the Scene.

The mesh's frameTime is an offset from the first frame time on its SceneGeometry; renderers resolve the offset to surrounding geometry frames, clamp outside the authored time range, and interpolate between them. The event indicates mesh-local state changed; shared geometry frames are not mutated.

onSceneMeshMatrixChanged: EventEmitter<Scene, SceneMesh>

Emits an event each time the transformation matrix of a SceneMesh is updated within the Scene.

onSceneMeshMorphWeightsChanged: EventEmitter<Scene, SceneMesh>

Emits an event each time mesh-local morph target weights are updated.

The available morph targets are immutable geometry-owned deltas on SceneGeometry; this event reports a change to the per-mesh weights that combine those targets.

onSceneMeshMoved: EventEmitter<Scene, SceneMesh>

Emits an event each time a SceneMesh is moved within the Scene.

onSceneMeshOpacityChanged: EventEmitter<Scene, SceneMesh>

Emits an event each time the opacity of a SceneMesh is updated within the Scene.

onSceneMeshVertexStateChanged: EventEmitter<Scene, SceneMesh>

Emits an event each time a mesh-local vertex-state sample is updated.

Vertex states are complete, immutable replacement states owned by geometry. This event reports the per-mesh selection/blend used to sample them at runtime.

onSceneModelBatchCommitted: EventEmitter<SceneModel, SceneModelBatch>

Emits when a SceneModel commits a component creation batch.

onSceneModelBatchRolledBack: EventEmitter<SceneModel, SceneModelBatch>

Emits when a SceneModel rolls back a component creation batch.

onSceneModelBatchStarted: EventEmitter<SceneModel, SceneModelBatch>

Emits when a SceneModel begins a component creation batch.

onSceneModelBuildFinished: EventEmitter<Scene, SceneModel>

Emits an event when a SceneModel leaves its "building" state — the loader has finished (or failed). Always fires to match a preceding onSceneModelBuildStarted, so consumers can rely on balanced pairs.

onSceneModelBuildStarted: EventEmitter<Scene, SceneModel>

Emits an event when a SceneModel enters its "building" state — i.e. a loader has begun populating it. Consumers (e.g. the renderer) can use this to suspend per-frame work until the model is fully assembled. Paired with onSceneModelBuildFinished.

onSceneModelCoordSystemBasisChanged: EventEmitter<SceneModel, CoordinateSystem>

Emits an event when the CoordinateSystem.basis of a SceneModel is updated.

onSceneModelCoordSystemOriginChanged: EventEmitter<SceneModel, CoordinateSystem>

Emits an event when the CoordinateSystem.origin of a SceneModel is updated.

onSceneModelCoordSystemScaleToMetersChanged: EventEmitter<
    SceneModel,
    CoordinateSystem,
>

Emits an event when the CoordinateSystem.scaleToMeters of a SceneModel is updated.

onSceneModelCoordSystemUnitsChanged: EventEmitter<SceneModel, CoordinateSystem>

Emits an event when the CoordinateSystem.units of a SceneModel is updated.

onSceneModelCoordSystemUpdated: EventEmitter<SceneModel, CoordinateSystem>

Emits an event after one or more coordinate system properties of a SceneModel have been updated, indicating that the CoordinateSystem is ready for use.

onSceneModelCreated: EventEmitter<Scene, SceneModel>

Emits an event each time a SceneModel is created within the Scene.

onSceneModelDestroyed: EventEmitter<Scene, SceneModel>

Emits an event each time a SceneModel is destroyed within the Scene.

onSceneModelSealed: EventEmitter<Scene, SceneModel>

Emits when a SceneModel is sealed against further topology/resource growth.

onSceneObjectCreated: EventEmitter<Scene, SceneObject>

Emits an event each time a SceneObject is created within the Scene.

onSceneObjectDestroyed: EventEmitter<Scene, SceneObject>

Emits an event each time a SceneObject is destroyed within the Scene.

onSceneObjectMeshAdded: EventEmitter<SceneObject, SceneMesh>

Emits an event each time a SceneMesh is added to a SceneObject.

onSceneObjectMeshRemoved: EventEmitter<SceneObject, SceneMesh>

Emits an event each time a SceneMesh is removed from a SceneObject.

onSceneRepSetCreated: EventEmitter<SceneModel, SceneRepSet>

Emits an event each time a SceneRepSet is created within a SceneModel.

onSceneRepSetDestroyed: EventEmitter<SceneModel, SceneRepSet>

Emits an event each time a SceneRepSet is destroyed within a SceneModel.

onSceneTextureCreated: EventEmitter<Scene, SceneTexture>

Emits an event each time a SceneTexture is created within the Scene.

onSceneTextureDestroyed: EventEmitter<Scene, SceneTexture>

Emits an event each time a SceneTexture is destroyed within the Scene.

onSceneTextureImageDataChanged: EventEmitter<Scene, SceneTexture>

Emits an event each time a SceneTexture's imageData is mutated post-creation. Subscribers (e.g. the renderer's texture atlas) re-upload the texture's pixels to the GPU.

onSceneTextureUVTransformChanged: EventEmitter<Scene, SceneTexture>

Emits an event each time a SceneTexture's texture-coordinate affine transform is updated.

onSceneTransformCreated: EventEmitter<Scene, SceneTransform>

Emits an event each time a SceneTransform is created within the Scene.

onSceneTransformDestroyed: EventEmitter<Scene, SceneTransform>

Emits an event each time a SceneTransform is destroyed within the Scene.

onSceneTransformMatrixChanged: EventEmitter<Scene, SceneTransform>

Emits an event each time the transformation matrix of a SceneTransform is updated within the Scene.