Interface ISceneSelectionStateAware

Interface that must be implemented by a KeyWindow that wants to provide scene selection capabilities.

interface ISceneSelectionStateAware {
    isDragSelectionActive: boolean;
    onScenePlayDataStateChanged: Event<
        [SceneInstance, EnumValue<ScenePlayState, number>],
    >;
    sceneInstance: SceneInstance;
    sceneSelection: SceneSelectionState;
    get implementsISceneSelectionStateAware(): true;
}

Implemented by

SceneKeyWindow

Index

Properties

isDragSelectionActive sceneInstance sceneSelection

Accessors

implementsISceneSelectionStateAware

Events

onScenePlayDataStateChanged

Properties

`Readonly`isDragSelectionActive

isDragSelectionActive: boolean

Determines if a drag selection is currently taking place.

`Readonly`sceneInstance

sceneInstance: SceneInstance

The currently loaded SceneInstance.

Note

The key window might dynamically load another scene.

`Readonly`sceneSelection

sceneSelection: SceneSelectionState

The SceneSelectionState.

Accessors

implementsISceneSelectionStateAware

get implementsISceneSelectionStateAware(): true

The interface marker for the ISceneSelectionStateAware interface.

Returns true

Events

`Readonly`onScenePlayDataStateChanged

onScenePlayDataStateChanged: Event<
[SceneInstance, EnumValue<ScenePlayState, number>],
>

Invoked when the ScenePlayState of the currently loaded SceneInstance changed.