Class SceneEvents

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 onSceneCoordSystemBasisChanged onSceneCoordSystemOriginChanged onSceneCoordSystemScaleToMetersChanged onSceneCoordSystemUnitsChanged onSceneCoordSystemUpdated onSceneDestroyed onSceneGeometryCreated onSceneGeometryDestroyed onSceneGeometryUpdated onSceneMaterialColorChanged onSceneMaterialCreated onSceneMaterialDestroyed onSceneMaterialOpacityChanged onSceneMaterialPatternChanged onSceneMeshColorChanged onSceneMeshCreated onSceneMeshDestroyed onSceneMeshMatrixChanged onSceneMeshMoved onSceneMeshOpacityChanged onSceneModelCoordSystemBasisChanged onSceneModelCoordSystemOriginChanged onSceneModelCoordSystemScaleToMetersChanged onSceneModelCoordSystemUnitsChanged onSceneModelCoordSystemUpdated onSceneModelCreated onSceneModelDestroyed onSceneObjectCreated onSceneObjectDestroyed onSceneObjectMeshAdded onSceneObjectMeshRemoved onSceneTechniqueCreated onSceneTechniqueDestroyed onSceneTextureCreated onSceneTextureDestroyed onSceneTextureImageDataChanged onSceneTransformCreated onSceneTransformDestroyed onSceneTransformMatrixChanged

Properties

ReadonlyonError

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.

ReadonlyonSceneCoordSystemBasisChanged

onSceneCoordSystemBasisChanged: EventEmitter<Scene, CoordinateSystem>

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

ReadonlyonSceneCoordSystemOriginChanged

onSceneCoordSystemOriginChanged: EventEmitter<Scene, CoordinateSystem>

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

ReadonlyonSceneCoordSystemScaleToMetersChanged

onSceneCoordSystemScaleToMetersChanged: EventEmitter<Scene, CoordinateSystem>

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

ReadonlyonSceneCoordSystemUnitsChanged

onSceneCoordSystemUnitsChanged: EventEmitter<Scene, CoordinateSystem>

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

ReadonlyonSceneCoordSystemUpdated

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.

ReadonlyonSceneDestroyed

onSceneDestroyed: EventEmitter<Scene, Scene>

Emits an event when the Scene is destroyed.

ReadonlyonSceneGeometryCreated

onSceneGeometryCreated: EventEmitter<Scene, SceneGeometry>

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

ReadonlyonSceneGeometryDestroyed

onSceneGeometryDestroyed: EventEmitter<Scene, SceneGeometry>

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

ReadonlyonSceneGeometryUpdated

onSceneGeometryUpdated: EventEmitter<Scene, SceneGeometry>

Emits an event each time a SceneGeometry is updated within the Scene, such as changes to positions, indices, or primitive types.

ReadonlyonSceneMaterialColorChanged

onSceneMaterialColorChanged: EventEmitter<Scene, SceneMaterial>

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

ReadonlyonSceneMaterialCreated

onSceneMaterialCreated: EventEmitter<Scene, SceneMaterial>

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

ReadonlyonSceneMaterialDestroyed

onSceneMaterialDestroyed: EventEmitter<Scene, SceneMaterial>

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

ReadonlyonSceneMaterialOpacityChanged

onSceneMaterialOpacityChanged: EventEmitter<Scene, SceneMaterial>

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

ReadonlyonSceneMaterialPatternChanged

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.

ReadonlyonSceneMeshColorChanged

onSceneMeshColorChanged: EventEmitter<Scene, SceneMesh>

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

ReadonlyonSceneMeshCreated

onSceneMeshCreated: EventEmitter<Scene, SceneMesh>

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

ReadonlyonSceneMeshDestroyed

onSceneMeshDestroyed: EventEmitter<Scene, SceneMesh>

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

ReadonlyonSceneMeshMatrixChanged

onSceneMeshMatrixChanged: EventEmitter<Scene, SceneMesh>

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

ReadonlyonSceneMeshMoved

onSceneMeshMoved: EventEmitter<Scene, SceneMesh>

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

ReadonlyonSceneMeshOpacityChanged

onSceneMeshOpacityChanged: EventEmitter<Scene, SceneMesh>

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

ReadonlyonSceneModelCoordSystemBasisChanged

onSceneModelCoordSystemBasisChanged: EventEmitter<SceneModel, CoordinateSystem>

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

ReadonlyonSceneModelCoordSystemOriginChanged

onSceneModelCoordSystemOriginChanged: EventEmitter<SceneModel, CoordinateSystem>

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

ReadonlyonSceneModelCoordSystemScaleToMetersChanged

onSceneModelCoordSystemScaleToMetersChanged: EventEmitter<
    SceneModel,
    CoordinateSystem,
>

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

ReadonlyonSceneModelCoordSystemUnitsChanged

onSceneModelCoordSystemUnitsChanged: EventEmitter<SceneModel, CoordinateSystem>

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

ReadonlyonSceneModelCoordSystemUpdated

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.

ReadonlyonSceneModelCreated

onSceneModelCreated: EventEmitter<Scene, SceneModel>

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

ReadonlyonSceneModelDestroyed

onSceneModelDestroyed: EventEmitter<Scene, SceneModel>

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

ReadonlyonSceneObjectCreated

onSceneObjectCreated: EventEmitter<Scene, SceneObject>

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

ReadonlyonSceneObjectDestroyed

onSceneObjectDestroyed: EventEmitter<Scene, SceneObject>

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

ReadonlyonSceneObjectMeshAdded

onSceneObjectMeshAdded: EventEmitter<SceneObject, SceneMesh>

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

ReadonlyonSceneObjectMeshRemoved

onSceneObjectMeshRemoved: EventEmitter<SceneObject, SceneMesh>

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

ReadonlyonSceneTechniqueCreated

onSceneTechniqueCreated: EventEmitter<Scene, SceneTechnique>

Emits an event each time a SceneTechnique is created within the Scene. Subscribers (renderer variant registries, inspector panels) can pick the new technique up without polling.

ReadonlyonSceneTechniqueDestroyed

onSceneTechniqueDestroyed: EventEmitter<Scene, SceneTechnique>

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

ReadonlyonSceneTextureCreated

onSceneTextureCreated: EventEmitter<Scene, SceneTexture>

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

ReadonlyonSceneTextureDestroyed

onSceneTextureDestroyed: EventEmitter<Scene, SceneTexture>

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

ReadonlyonSceneTextureImageDataChanged

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.

ReadonlyonSceneTransformCreated

onSceneTransformCreated: EventEmitter<Scene, SceneTransform>

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

ReadonlyonSceneTransformDestroyed

onSceneTransformDestroyed: EventEmitter<Scene, SceneTransform>

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

ReadonlyonSceneTransformMatrixChanged

onSceneTransformMatrixChanged: EventEmitter<Scene, SceneTransform>

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

Settings

Member Visibility

On This Page

Properties
onErroronSceneCoordSystemBasisChangedonSceneCoordSystemOriginChangedonSceneCoordSystemScaleToMetersChangedonSceneCoordSystemUnitsChangedonSceneCoordSystemUpdatedonSceneDestroyedonSceneGeometryCreatedonSceneGeometryDestroyedonSceneGeometryUpdatedonSceneMaterialColorChangedonSceneMaterialCreatedonSceneMaterialDestroyedonSceneMaterialOpacityChangedonSceneMaterialPatternChangedonSceneMeshColorChangedonSceneMeshCreatedonSceneMeshDestroyedonSceneMeshMatrixChangedonSceneMeshMovedonSceneMeshOpacityChangedonSceneModelCoordSystemBasisChangedonSceneModelCoordSystemOriginChangedonSceneModelCoordSystemScaleToMetersChangedonSceneModelCoordSystemUnitsChangedonSceneModelCoordSystemUpdatedonSceneModelCreatedonSceneModelDestroyedonSceneObjectCreatedonSceneObjectDestroyedonSceneObjectMeshAddedonSceneObjectMeshRemovedonSceneTechniqueCreatedonSceneTechniqueDestroyedonSceneTextureCreatedonSceneTextureDestroyedonSceneTextureImageDataChangedonSceneTransformCreatedonSceneTransformDestroyedonSceneTransformMatrixChanged