Class default

constructor

• new default(rootStore?: ESPCDF): default

  Creates a new SceneStore instance

  Parameters

  • OptionalrootStore: ESPCDF

    Optional reference to the root CDF store

  Returns default

_scenesByID

sceneList

• get sceneList(): ESPCDFScene[]

  Computed property that returns an array of all scenes

  Returns ESPCDFScene[]

  Array of all scenes in the store

scenesByID

• get scenesByID(): { [key: string]: ESPCDFScene }

  Getter for scenes indexed by ID

  Returns { [key: string]: ESPCDFScene }

  Map of scenes indexed by scene ID

• set scenesByID(value: { [key: string]: ESPCDFScene }): void

  Setter for scenes indexed by ID

  Parameters

  • value: { [key: string]: ESPCDFScene }

    Map of scenes to set

  Returns void

activateMultipleScenes

• activateMultipleScenes(sceneIds: string[]): Promise<void>

  Activates multiple scenes concurrently

  This method activates multiple scenes in parallel using Promise.all.

  Parameters

  • sceneIds: string[]

    Array of scene IDs to activate

  Returns Promise<void>

  Resolves when every scene in the list has been activated

  Throws

  If any scene activation fails

  Example

  await sceneStore.activateMultipleScenes(['scene1', 'scene2', 'scene3']);
  Copy

activateScene

• activateScene(sceneId: string): Promise<void>

  Activates a scene by triggering its action

  This method finds the scene by ID and calls its trigger method, which will activate the scene across all its associated nodes.

  Parameters

  • sceneId: string

    The ID of the scene to activate

  Returns Promise<void>

  Resolves when scene.activate() completes for that scene

  Throws

  If scene is not found or activation fails

  Example

  await sceneStore.activateScene('scene123');
  Copy

addProperty

• addProperty(propertyName: string, initialValue: any): void

  Dynamically adds an observable property to the store

  This method adds a new observable property to the store and automatically creates getter and setter methods for it. The property name is capitalized for the getter/setter methods.

  Parameters

  • propertyName: string

    The name of the property to add

  • initialValue: any

    The initial value for the property

  Returns void

  Example

  sceneStore.addProperty('customField', 'initial value');
  sceneStore.setCustomField('new value');
  Copy

addScene

• addScene(scene: ESPCDFScene): ESPCDFScene

  Adds a single scene to the store

  Parameters

  • scene: ESPCDFScene

    The scene to add

  Returns ESPCDFScene

  The observable scene object

  Example

  const scene = sceneStore.addScene(sceneEntity);
  Copy

clear

• clear(): void

  Clears all scenes and resets hooks to default values

  This method removes all scenes from the store and resets the beforeSetSceneListHook and afterSetSceneListHook to empty functions.

  Returns void

  Example

  sceneStore.clear();
  Copy

deleteScenes

• deleteScenes(ids: string[]): void

  Deletes multiple scenes by their IDs

  Parameters

  • ids: string[]

    Array of scene IDs to delete

  Returns void

  Example

  sceneStore.deleteScenes(['scene1', 'scene2', 'scene3']);
  Copy

getScene

• getScene(sceneId: string): ESPCDFScene | null

  Retrieves a scene by its ID

  Parameters

  • sceneId: string

    The ID of the scene to retrieve

  Returns ESPCDFScene | null

  The scene object or null if not found

  Example

  const scene = sceneStore.getScene('scene123');
  Copy

setSceneList

• setSceneList(scenes: ESPCDFScene[]): void

  Sets the entire scene list, replacing all existing scenes

  This method replaces all scenes in the store with the provided array. Each scene is made observable and has interceptors set up.

  Parameters

  • scenes: ESPCDFScene[]

    Array of scenes to set

  Returns void

  Example

  sceneStore.setSceneList([
    { id: 'scene1', name: 'Scene 1', nodes: [], actions: {} },
    { id: 'scene2', name: 'Scene 2', nodes: [], actions: {} }
  ]);
  Copy

updateSceneByID

• updateSceneByID(id: string, scene: ESPCDFScene): void

  Updates a scene by ID without making it observable

  Parameters

  • id: string

    The scene ID

  • scene: ESPCDFScene

    The scene object to set

  Returns void

  Example

  sceneStore.updateSceneByID('scene123', updatedScene);
  Copy