Class default

constructor

• new default(rootStore?: CDF): default

  Creates a new SceneStore instance

  Parameters

  • OptionalrootStore: CDF

    Optional reference to the root CDF store

  Returns default

afterSetSceneListHook

beforeSetSceneListHook

_scenesByID

sceneList

• get sceneList(): default[]

  Computed property that returns an array of all scenes

  Returns default[]

  Array of all scenes in the store

scenesByID

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

  Getter for scenes indexed by ID

  Returns { [key: string]: default }

  Map of scenes indexed by scene ID
• set scenesByID(value: { [key: string]: default }): void

  Setter for scenes indexed by ID

  Parameters

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

    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>

  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>

  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: default): default

  Adds a single scene to the store

  Parameters

  • scene: default

    The scene to add

  Returns default

  The observable scene object

  Example

  const scene = sceneStore.addScene({
    id: 'scene123',
    name: 'New Scene',
    nodes: [],
    config: {}
  });
  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

createScene

• createScene(sceneData: Partial<default>): Promise<default>

  Creates a new scene in the store

  This method creates a new scene with the provided data, makes it observable, and sets up interceptors for its operations. If no ID is provided, a timestamp-based ID is generated.

  Parameters

  • sceneData: Partial<default>

    Scene data to create

  Returns Promise<default>

  The created scene object

  Throws

  If scene creation fails

  Example

  const newScene = await sceneStore.createScene({
    name: 'Living Room Scene',
    info: 'Cozy evening lighting',
    nodes: ['node1', 'node2'],
    config: { 'node1': { light: { power: true } } }
  });
  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): null | default

  Retrieves a scene by its ID

  Parameters

  • sceneId: string

    The ID of the scene to retrieve

  Returns null | default

  The scene object or null if not found

  Example

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

setSceneList

• setSceneList(scenes: default[]): 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: default[]

    Array of scenes to set

  Returns void

  Example

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

syncScenesFromNodes

• syncScenesFromNodes(nodeIds: string[]): Promise<void>

  Synchronizes scenes from specified nodes

  This action method:

  1. Clears existing scenes from the store
  2. Fetches scene configurations from specified nodes
  3. Transforms node configurations into Scene instances
  4. Updates the store with synchronized scenes

  Parameters

  • nodeIds: string[]

    Array of node IDs to sync scenes from

  Returns Promise<void>

  Throws

  If synchronization fails

updateSceneByID

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

  Updates a scene by ID without making it observable

  Parameters

  • id: string

    The scene ID
  • scene: default

    The scene object to set

  Returns void

  Example

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