Class SceneSelectionState`Public Self`

The SceneSelectionState represents the shared selection state of SceneObjects in a scene for a KeyWindowBase that implements the ISceneSelectionStateAware interface.

Index

Constructors

Properties

_keyWindow _selection

Accessors

isDragSelectionInProgress sceneObject sceneObjects selectedObjectUUIDs

Methods

clear notifySelectionChanged onScenePlayDataStateChanged ping removeObject removeObjects get

Events

onChanged onPing

Constructors

constructor

new SceneSelectionState(
keyWindow: KeyWindow & ISceneSelectionStateAware,
): SceneSelectionState
Parameters
- keyWindow: KeyWindow & ISceneSelectionStateAware
Returns SceneSelectionState

Properties

`Protected` `Readonly`_keyWindow

_keyWindow: KeyWindowBase & ISceneSelectionStateAware

`Protected` `Readonly`_selection

_selection: SceneObject[]

Accessors

isDragSelectionInProgress

get isDragSelectionInProgress(): boolean

Check whether a drag selection in the scene is in progress.

Returns boolean

sceneObject

get sceneObject(): SceneObject

The currently selected sceneObject. If multiple scene objects are selected, returns the first one. Note that this can be null if no objects are selected.

Returns SceneObject
set sceneObject(value: SceneObject): void
Parameters
- value: SceneObject
Returns void

sceneObjects

get sceneObjects(): SceneObject[]

The current selected scene objects.

Returns SceneObject[]
set sceneObjects(newSelection: Immutable<SceneObject[]>): void
Parameters
- newSelection: Immutable<SceneObject[]>
Returns void

selectedObjectUUIDs

get selectedObjectUUIDs(): UUID[]

The selected object UUIDs.

Returns UUID[]
set selectedObjectUUIDs(uuids: UUID[]): void
Parameters
- uuids: UUID[]
Returns void

Methods

clear

clear(): void

Clears the selection.

Returns void

notifySelectionChanged

notifySelectionChanged(): void

Notifies all listeners that the scene selection has changed.

Returns void

`Protected`onScenePlayDataStateChanged

onScenePlayDataStateChanged(
sceneInstance: SceneInstance,
state: EnumValue<ScenePlayState>,
): void
Invoked when the ScenePlayData state changed.
Parameters
- sceneInstance: SceneInstance
- state: EnumValue<ScenePlayState>
Returns void

ping

ping(sceneObject: SceneObject): void
Pings the sceneObject, highlighting it in its respective editors.
Parameters
- sceneObject: SceneObject
Returns void

removeObject

removeObject(sceneObject: SceneObject): void
Remove the provided object from the current selection. Triggers selection changed if any object was removed.
Parameters
- sceneObject: SceneObject
  The object to remove from the current selection.
Returns void

removeObjects

removeObjects(sceneObjects: SceneObject[]): void
Remove any of the provided objects from the current selection. Triggers selection changed if any object was removed.
Parameters
- sceneObjects: SceneObject[]
  The objects to remove from the current selection.
Returns void

`Static`get

get(keyWindow: KeyWindowBase): SceneSelectionState
Gets the SceneSelectionState from the specified KeyWindowBase.
Parameters
- keyWindow: KeyWindowBase
  The key window to get the selection state from.
Returns SceneSelectionState
The selection state for the key window, or null.

Note
A key window must implement the ISceneSelectionStateAware interface to be able to get the selection state.

Events

`Readonly`onChanged

onChanged: Event<[SceneObject[]]>

An event called whenever the selection has changed been changed.

`Readonly`onPing

onPing: Event<[SceneObject]>

An event called whenever a scene object is pinged.