Class Scene

Hierarchy

Scene

Implements

ISceneModel

Index

Constructors

constructor

Properties

Constructors

constructor

new Scene(sceneId: string): Scene

- Defined in scenes/scene.ts:29
Parameters
- sceneId: string
Returns Scene

Properties

id

id: string

name

name: string

nodes

nodes: ISceneNodeModel[]

Methods

addFile

addFile(path: string, folderId?: string): SceneNode

- Defined in scenes/scene.ts:137
creates sources from file system folders and files source type depends on the file extension

Parameters
- path: string
- Optional folderId: string
Returns SceneNode

addSource

addSource(sourceId: string, options?: ISceneNodeAddOptions): SceneItem

- Defined in scenes/scene.ts:119
Parameters
- sourceId: string
- Optional options: ISceneNodeAddOptions
Returns SceneItem

canAddSource

canAddSource(sourceId: string): boolean

- Defined in scenes/scene.ts:161
Parameters
- sourceId: string
Returns boolean

clear

clear(): void

- Defined in scenes/scene.ts:145
removes all nodes from the scene

Returns void

createAndAddSource

createAndAddSource(name: string, type: TSourceType, settings?: Dictionary<any>): SceneItem

- Defined in scenes/scene.ts:124
Parameters
- name: string
- type: TSourceType
- Optional settings: Dictionary<any>
Returns SceneItem

createFolder

createFolder(name: string): SceneItemFolder

- Defined in scenes/scene.ts:129
Parameters
- name: string
Returns SceneItemFolder

getFolder

getFolder(sceneFolderId: string): SceneItemFolder

- Defined in scenes/scene.ts:66
Parameters
- sceneFolderId: string
Returns SceneItemFolder

getFolders

getFolders(): SceneItemFolder[]

- Defined in scenes/scene.ts:84
Returns SceneItemFolder[]

getItem

getItem(sceneItemId: string): SceneItem

- Defined in scenes/scene.ts:60
Parameters
- sceneItemId: string
Returns SceneItem

getItems

getItems(): SceneItem[]

- Defined in scenes/scene.ts:80
Returns SceneItem[]

getModel

getModel(): ISceneModel

- Defined in scenes/scene.ts:40
Returns ISceneModel

getNestedItems

getNestedItems(): SceneItem[]

- Defined in scenes/scene.ts:91
returns scene items of scene + scene items of nested scenes

Returns SceneItem[]

getNestedScenes

getNestedScenes(): Scene[]

- Defined in scenes/scene.ts:108
return nested scenes in the safe-to-add order

Returns Scene[]

getNestedSources

getNestedSources(): Source[]

- Defined in scenes/scene.ts:99
returns sources of scene + sources of nested scenes result also includes nested scenes

Returns Source[]

getNode

getNode(sceneNodeId: string): SceneNode

- Defined in scenes/scene.ts:48
Parameters
- sceneNodeId: string
Returns SceneNode

getNodeByName

getNodeByName(name: string): SceneNode

- Defined in scenes/scene.ts:55
Parameters
- name: string
Returns SceneNode

getNodes

getNodes(): SceneNode[]

- Defined in scenes/scene.ts:72
Returns SceneNode[]

getRootNodes

getRootNodes(): SceneNode[]

- Defined in scenes/scene.ts:76
Returns SceneNode[]

getSelection

getSelection(ids?: string[]): Selection

- Defined in scenes/scene.ts:173
Parameters
- Optional ids: string[]
Returns Selection

getSource

getSource(): Source

- Defined in scenes/scene.ts:115
returns the source linked to scene

Returns Source

makeActive

makeActive(): void

- Defined in scenes/scene.ts:169
Returns void

remove

remove(): void

- Defined in scenes/scene.ts:157
Returns void

removeFolder

removeFolder(folderId: string): void

- Defined in scenes/scene.ts:149
Parameters
- folderId: string
Returns void

removeItem

removeItem(sceneItemId: string): void

- Defined in scenes/scene.ts:153
Parameters
- sceneItemId: string
Returns void

setName

setName(newName: string): void

- Defined in scenes/scene.ts:165
Parameters
- newName: string
Returns void