Class Locator

Optionalallow_mirror_modeling

export

locked

Optionalmenu

mesh

Optionalparent

preview_controller

Readonlyscene_object

selected

type

uuid

Static Optionalanimator

Staticbehavior_overrides

StatichasAny

StatichasSelected

StaticisParent

Staticpreview_controller

Staticproperties

Statictypes

Staticuuids

addTo

• addTo(target?: OutlinerNode | "root"): this

  Parameters

  • Optionaltarget: OutlinerNode | "root"

  Returns this

createUniqueName

• createUniqueName(others?: OutlinerNode[]): this

  Create a unique name for the group or element by adding a number at the end or increasing it.

  Parameters

  • Optionalothers: OutlinerNode[]

  Returns this

getParentArray

• getParentArray(): OutlinerNode[]

  Returns OutlinerNode[]

OptionalgetSaveCopy

• getSaveCopy?(...args: any[]): Record<string, any>

  Parameters

  • ...args: any[]

  Returns Record<string, any>

getTypeBehavior

• getTypeBehavior(flag: string): any

  Parameters

  • flag: string

  Returns any

init

• init(): this

  Initializes the node. This should always be called when creating nodes that will be used in the outliner.

  Returns this

isChildOf

• isChildOf(node: OutlinerNode, max_levels: number): boolean

  Checks of the group or element is a child of group.

  Parameters

  • node: OutlinerNode
  • max_levels: number

    The maximum number of generations that can be between the element and the group

  Returns boolean

markAsSelected

• markAsSelected(descendants?: boolean): void

  Mark the element as selected

  Parameters

  • Optionaldescendants: boolean

  Returns void

remove

• remove(undo?: boolean): void

  Removes the element.

  Parameters

  • Optionalundo: boolean

  Returns void

rename

• rename(): this

  Marks the name of the group or element in the outliner for renaming.

  Returns this

sanitizeName

• sanitizeName(): string

  Returns string

saveName

• saveName(save?: boolean): this

  Saves the changed name of the element by creating an undo point and making the name unique if necessary.

  Parameters

  • Optionalsave: boolean

  Returns this

select

• select(event?: any, isOutlinerClick?: boolean): this

  Parameters

  • Optionalevent: any
  • OptionalisOutlinerClick: boolean

  Returns this

showContexMenu

• showContexMenu(event: Event | HTMLElement): this

  Displays the context menu of the element

  Parameters

  • event: Event | HTMLElement

    Mouse event, determines where the context menu spawns.

  Returns this

showInOutliner

• showInOutliner(): this

  Unfolds the outliner and scrolls up or down if necessary to show the group or element.

  Returns this

sortInBefore

• sortInBefore(target?: OutlinerNode, index_modifier?: number): this

  Parameters

  • Optionaltarget: OutlinerNode
  • Optionalindex_modifier: number

  Returns this

unselect

• unselect(...args: any[]): this

  Parameters

  • ...args: any[]

  Returns this

updateElement

• updateElement(): this

  Updates the Vue node of the element. This is only necessary in some rare situations

  Returns this

StaticaddBehaviorOverride

• addBehaviorOverride(
      override_options: { behavior: Record<string, any>; condition: any },
  ): Deletable

  Parameters

  • override_options: { behavior: Record<string, any>; condition: any }

  Returns Deletable

StaticfromSave

• fromSave(data: any, keep_uuid?: boolean): OutlinerElement

  Parameters

  • data: any
  • Optionalkeep_uuid: boolean

  Returns OutlinerElement

StaticregisterType

• registerType(constructor: any, id: string): void

  Parameters

  • constructor: any
  • id: string

  Returns void