Interface ISceneItemFolderApi

API for scene folders

Implemented by

Hierarchy

Index

Properties

Optional childrenIds

childrenIds: string[]

id

id: string

name

name: string

Optional parentId

parentId: string

sceneId

sceneId: string

sceneNodeType

sceneNodeType: TSceneNodeType

Methods

add

  • add(sceneNodeId: string): void
  • Add an item or folder to the current folder Shortcut for ISceneNodeApi.setParent()

    Parameters

    • sceneNodeId: string

    Returns void

addToSelection

  • addToSelection(): void

deselect

  • deselect(): void

detachParent

  • detachParent(): void

getFolders

getItemIndex

  • getItemIndex(): number
  • Returns the item index in the list of all nodes. itemIndex defines the draw order of the node itemIndex for a SceneFolder is the itemIndex of the previous SceneItem

    To change itemIndex use placeBefore and placeAfter methods

    nodeInd | itemInd | nodes tree
     0      |    0    | Folder1
     1      |    0    |   |_Folder2
     2      |    0    |   |_ Item1
     3      |    1    |   \_ Item2
     4      |    2    | Item3
     5      |    2    | Folder3
     6      |    3    |   |_Item4
     7      |    4    |   \_Item5
     

    Returns number

getItems

getModel

getNestedFolders

getNestedFoldersIds

  • getNestedFoldersIds(): string[]

getNestedItems

getNestedItemsIds

  • getNestedItemsIds(): string[]

getNestedNodes

getNestedNodesIds

  • getNestedNodesIds(): string[]

getNextItem

getNextNode

getNextSiblingNode

getNodeIndex

  • getNodeIndex(): number

getNodes

getParent

getPath

  • getPath(): string[]

getPrevItem

getPrevNode

getPrevSiblingNode

getScene

getSelection

hasParent

  • hasParent(): void

isFolder

  • isFolder(): boolean

isItem

  • isItem(): boolean

isSelected

  • isSelected(): boolean

placeAfter

  • placeAfter(nodeId: string): void

placeBefore

  • placeBefore(nodeId: string): void

remove

  • remove(): void
  • Removes the node. For folders, all nested folders and items also will be removed. To remove a folder without removing the nested nodes, use the ISceneItemFolderApi.ungroup() method

    see

    ISceneItemFolderApi.ungroup()

    Returns void

select

  • select(): void

setName

  • setName(newName: string): void

setParent

  • setParent(parentId: string): void

ungroup

  • ungroup(): void