Class Collection

constructor

• new Collection(data: CollectionOptions, uuid?: string): Collection

  Parameters

  • data: CollectionOptions
  • Optionaluuid: string

  Returns Collection

children

export_codec

export_path

name

selected

uuid

visibility

Staticall

Staticmenu

Staticproperties

Staticselected

add

• add(): this

  Returns this

addSelection

• addSelection(): this

  Adds the current outliner selection to this collection

  Returns this

clickSelect

• clickSelect(event: MouseEvent): void

  Parameters

  • event: MouseEvent

  Returns void

contains

• contains(node: OutlinerNode): boolean

  Check if the node is contained in this collection, directly or indirectly

  Parameters

  • node: OutlinerNode

  Returns boolean

  if the collection contains the node

extend

• extend(data: CollectionOptions): this

  Parameters

  • data: CollectionOptions

  Returns this

getAllChildren

• getAllChildren(): OutlinerNode[]

  Get all children, including indirect ones

  Returns OutlinerNode[]

getChildren

• getChildren(): OutlinerNode[]

  Get all direct children

  Returns OutlinerNode[]

getSaveCopy

• getSaveCopy(): { uuid: string }

  Returns { uuid: string }

getUndoCopy

• getUndoCopy(): { index: number; uuid: string }

  Returns { index: number; uuid: string }

getVisibility

• getVisibility(): boolean

  Returns the visibility of the first contained node that supports visibility. Otherwise returns true.

  Returns boolean

propertiesDialog

• propertiesDialog(): void

  Opens the properties dialog

  Returns void

select

• select(event?: MouseEvent | KeyboardEvent): this

  Parameters

  • Optionalevent: MouseEvent | KeyboardEvent

  Returns this

showContextMenu

• showContextMenu(event: any): this

  Opens the context menu

  Parameters

  • event: any

  Returns this

toggleVisibility

• toggleVisibility(event: MouseEvent | KeyboardEvent): void

  Toggle visibility of everything in the collection

  Parameters

  • event: MouseEvent | KeyboardEvent

    If the alt key is pressed, the result is inverted and the visibility of everything but the collection will be toggled

  Returns void