Class Locator

Optionalallow_mirror_modeling

Optionalchildren

export

locked

Optionalmenu

name_regex

Optionalold_name

parent

selected

type

uuid

Static Optionalanimator

Staticbehavior

Staticbehavior_overrides

StaticisParent

Staticpreview_controller

Staticproperties

Statictypes

Staticuuids

mesh

• get mesh(): Object3D

  Returns Object3D

preview_controller

• get preview_controller(): NodePreviewController

  Returns NodePreviewController

scene_object

• get scene_object(): Object3D

  Returns Object3D

addTo

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

  Parameters

  • Optionaltarget: OutlinerNode | "root"
  • Optionalindex: number

  Returns this

clickSelect

• clickSelect(event: any, outliner_click?: boolean): void

  Parameters

  • event: any
  • Optionaloutliner_click: boolean

  Returns void

createUniqueName

• createUniqueName(others?: OutlinerNode[]): string | false

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

  Parameters

  • Optionalothers: OutlinerNode[]

  Returns string | false

duplicate

• duplicate(): OutlinerElement

  Returns OutlinerElement

forSelected

• forSelected(
      fc: (element: OutlinerElement) => void,
      undo_tag?: string,
      selection_method?: "all_selected" | "all_in_group",
  ): OutlinerElement[]

  Parameters

  • fc: (element: OutlinerElement) => void
  • Optionalundo_tag: string
  • Optionalselection_method: "all_selected" | "all_in_group"

  Returns OutlinerElement[]

getDepth

• getDepth(): number

  Returns number

getParentArray

• getParentArray(): OutlinerNode[]

  Returns OutlinerNode[]

getSaveCopy

• getSaveCopy(): any

  Returns any

getTypeBehavior

• getTypeBehavior(flag: string): any

  Parameters

  • flag: string

  Returns any

getUndoCopy

• getUndoCopy(): OutlinerElement

  Returns OutlinerElement

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

isIconEnabled

• isIconEnabled(toggle: any): any

  Parameters

  • toggle: any

  Returns any

markAsSelected

• markAsSelected(select_children?: boolean): this

  Mark the element as selected

  Parameters

  • Optionalselect_children: boolean

  Returns this

matchesFilter

• matchesFilter(search_term_lowercase: any): any

  Parameters

  • search_term_lowercase: any

  Returns any

remove

• remove(): this

  Removes the node.

  Returns this

removeFromParent

• removeFromParent(): this

  Returns this

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?: Event, is_outliner_click?: boolean): false | Locator

  Parameters

  • Optionalevent: Event
  • Optionalis_outliner_click: boolean

  Returns false | Locator

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

showContextMenu

• showContextMenu(event: MouseEvent): this

  Parameters

  • event: MouseEvent

  Returns this

showInOutliner

• showInOutliner(): void

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

  Returns void

sortInBefore

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

  Parameters

  • Optionalelement: OutlinerNode
  • Optionalindex_modifier: number

  Returns this

unselect

• unselect(unselect_parent?: boolean): this

  Parameters

  • Optionalunselect_parent: boolean

  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;
          priority?: number;
      },
  ): Deletable

  Parameters

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

  Returns Deletable

StaticfromSave

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

  Parameters

  • obj: any
  • Optionalkeep_uuid: boolean

  Returns OutlinerElement

StatichasAny

• hasAny(): boolean

  Check if any elements of the type are in the project

  Returns boolean

StatichasSelected

• hasSelected(): boolean

  Check if any elements of the type are currently selected

  Returns boolean

StaticisTypePermitted

• isTypePermitted(type: string): boolean

  Parameters

  • type: string

  Returns boolean

StaticregisterType

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

  Parameters

  • constructor: ElementTypeConstructor
  • id: string

  Returns void