Outliner

elements

Global Variable

Type: Array of OutlinerNode

OutlinerNode

Extended by: OutlinerElement, Group

new OutlinerNode( uuid )

Creates a new OutlinerNode

Arguments:

uuid: string

Property	Type	Description
name	string
uuid	string
export	boolean
locked	boolean
parent	Group or `"root"`
menu	Menu

init()

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

Returns: OutlinerNode

addTo( [target] )

Arguments:

target: OutlinerNode (Optional)

Returns: OutlinerNode

sortInBefore( [target, index_modifier] )

Arguments:

target: OutlinerNode (Optional)
index_modifier: number (Optional)

Returns: OutlinerNode

getParentArray()

Returns: Array of OutlinerNode

showInOutliner()

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

Returns: OutlinerNode

updateElement()

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

Returns: OutlinerNode

remove()

Removes the element.

Returns: OutlinerNode

rename()

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

Returns: OutlinerNode

saveName( [save] )

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

Arguments:

save: boolean (Optional)

Returns: OutlinerNode

createUniqueName( [others] )

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

Arguments:

others: Array of OutlinerNode (Optional)

Returns: OutlinerNode

isChildOf( group, max_levels )

Checks of the group or element is a child of

group

Arguments:

group: Group
max_levels: number - The maximum number of generations that can be between the element and the group

Returns: boolean

showContexnu( event )

Displays the context menu of the element

Arguments:

event: HTMLElement or Event - Mouse event, determines where the context menu spawns.

Returns: OutlinerNode

getSaveCopy( args )

Arguments:

args: Array of any

Returns: Record

sanitizeName()

Returns: string

properties

Static Property

Type: Record

uuids

Static Property

Type: See types

OutlinerElement

Extends: OutlinerNode

Extended by: Locator, NullObject, TextureMesh, Cube, Mesh

new OutlinerElement( data, uuid )

Creates a new OutlinerElement

Arguments:

data: any
uuid: string

Property	Type	Description
name	string
uuid	string
export	boolean
locked	boolean
parent	Group or `"root"`
menu	Menu
selected	boolean
mesh	THREE.Object3D or Mesh

init()

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

Returns: OutlinerElement

addTo( [target] )

Arguments:

target: OutlinerNode (Optional)

Returns: OutlinerElement

sortInBefore( [target, index_modifier] )

Arguments:

target: OutlinerNode (Optional)
index_modifier: number (Optional)

Returns: OutlinerElement

getParentArray()

Returns: Array of OutlinerNode

showInOutliner()

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

Returns: OutlinerElement

updateElement()

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

Returns: OutlinerElement

remove()

Removes the element.

Returns: OutlinerElement

rename()

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

Returns: OutlinerElement

saveName( [save] )

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

Arguments:

save: boolean (Optional)

Returns: OutlinerElement

createUniqueName( [others] )

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

Arguments:

others: Array of OutlinerNode (Optional)

Returns: OutlinerElement

isChildOf( group, max_levels )

Checks of the group or element is a child of

group

Arguments:

group: Group
max_levels: number - The maximum number of generations that can be between the element and the group

Returns: boolean

showContexnu( event )

Displays the context menu of the element

Arguments:

event: HTMLElement or Event - Mouse event, determines where the context menu spawns.

Returns: OutlinerElement

getSaveCopy( args )

Arguments:

args: Array of any

Returns: Record

sanitizeName()

Returns: string

OutlinerElement.fromSave( data[, keep_uuid] )

Arguments:

data: any
keep_uuid: boolean (Optional)

Returns: OutlinerElement

OutlinerElement.registerType( constructor, id )

Arguments:

constructor: any
id: string

select( [event, isOutlinerClick] )

Arguments:

event: any (Optional)
isOutlinerClick: boolean (Optional)

Returns: void or OutlinerElement

unselect( args )

Arguments:

args: Array of any

Returns: void or OutlinerElement

properties

Static Property

Type: Record

uuids

Static Property

Type: See types

animator

Static Property

Type: BoneAnimator

isParent

Static Property

Type: false

types

Static Property

Type: Record

all

Static Property

Type: Array of OutlinerElement

selected

Static Property

Type: false or Array of OutlinerElement

Locator

Extends: OutlinerElement

new Locator( options[, uuid] )

Creates a new Locator

Arguments:

options: LocatorOptions
uuid: string (Optional)

Property	Type	Description
uuid	string
export	boolean
locked	boolean
parent	Group or `"root"`
menu	Menu
selected	boolean
mesh	THREE.Object3D or Mesh
name	string

init()

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

Returns: Locator

addTo( [target] )

Arguments:

target: OutlinerNode (Optional)

Returns: Locator

sortInBefore( [target, index_modifier] )

Arguments:

target: OutlinerNode (Optional)
index_modifier: number (Optional)

Returns: Locator

getParentArray()

Returns: Array of OutlinerNode

showInOutliner()

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

Returns: Locator

updateElement()

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

Returns: Locator

remove()

Removes the element.

Returns: Locator

rename()

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

Returns: Locator

saveName( [save] )

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

Arguments:

save: boolean (Optional)

Returns: Locator

createUniqueName( [others] )

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

Arguments:

others: Array of OutlinerNode (Optional)

Returns: Locator

isChildOf( group, max_levels )

Checks of the group or element is a child of

group

Arguments:

group: Group
max_levels: number - The maximum number of generations that can be between the element and the group

Returns: boolean

showContexnu( event )

Displays the context menu of the element

Arguments:

event: HTMLElement or Event - Mouse event, determines where the context menu spawns.

Returns: Locator

getSaveCopy( args )

Arguments:

args: Array of any

Returns: Record

sanitizeName()

Returns: string

Locator.fromSave( data[, keep_uuid] )

Arguments:

data: any
keep_uuid: boolean (Optional)

Returns: OutlinerElement

Locator.registerType( constructor, id )

Arguments:

constructor: any
id: string

select( [event, isOutlinerClick] )

Arguments:

event: any (Optional)
isOutlinerClick: boolean (Optional)

Returns: void or Locator

unselect( args )

Arguments:

args: Array of any

Returns: void or Locator

extend( options )

Arguments:

options: LocatorOptions

flip( axis, center )

Arguments:

axis: number
center: number

Returns: Locator

getWorldCenter()

Returns: THREE.Vector3

properties

Static Property

Type: Record

uuids

Static Property

Type: See types

animator

Static Property

Type: BoneAnimator

isParent

Static Property

Type: false

types

Static Property

Type: Record

all

Static Property

Type: Array of Locator

selected

Static Property

Type: Array of Locator

hasAny

Static Property

Type: See types

hasSelected

Static Property

Type: See types

NullObject

Extends: OutlinerElement

new NullObject( options[, uuid] )

Creates a new NullObject

Arguments:

options: NullObjectOptions
uuid: string (Optional)

Property	Type	Description
name	string
uuid	string
export	boolean
locked	boolean
parent	Group or `"root"`
menu	Menu
selected	boolean
mesh	THREE.Object3D or Mesh
position	ArrayVector3
ik_target	string
lock_ik_target_rotation	boolean

init()

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

Returns: NullObject

addTo( [target] )

Arguments:

target: OutlinerNode (Optional)

Returns: NullObject

sortInBefore( [target, index_modifier] )

Arguments:

target: OutlinerNode (Optional)
index_modifier: number (Optional)

Returns: NullObject

getParentArray()

Returns: Array of OutlinerNode

showInOutliner()

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

Returns: NullObject

updateElement()

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

Returns: NullObject

remove()

Removes the element.

Returns: NullObject

rename()

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

Returns: NullObject

saveName( [save] )

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

Arguments:

save: boolean (Optional)

Returns: NullObject

createUniqueName( [others] )

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

Arguments:

others: Array of OutlinerNode (Optional)

Returns: NullObject

isChildOf( group, max_levels )

Checks of the group or element is a child of

group

Arguments:

group: Group
max_levels: number - The maximum number of generations that can be between the element and the group

Returns: boolean

showContexnu( event )

Displays the context menu of the element

Arguments:

event: HTMLElement or Event - Mouse event, determines where the context menu spawns.

Returns: NullObject

getSaveCopy( args )

Arguments:

args: Array of any

Returns: Record

sanitizeName()

Returns: string

NullObject.fromSave( data[, keep_uuid] )

Arguments:

data: any
keep_uuid: boolean (Optional)

Returns: OutlinerElement

NullObject.registerType( constructor, id )

Arguments:

constructor: any
id: string

select( [event, isOutlinerClick] )

Arguments:

event: any (Optional)
isOutlinerClick: boolean (Optional)

Returns: void or NullObject

unselect( args )

Arguments:

args: Array of any

Returns: void or NullObject

extend( options )

Arguments:

options: NullObjectOptions

flip( axis, center )

Arguments:

axis: number
center: number

Returns: NullObject

getWorldCenter()

Returns: THREE.Vector3

properties

Static Property

Type: Record

uuids

Static Property

Type: See types

animator

Static Property

Type: BoneAnimator

isParent

Static Property

Type: false

types

Static Property

Type: Record

all

Static Property

Type: Array of NullObject

selected

Static Property

Type: Array of NullObject

hasAny

Static Property

Type: See types

hasSelected

Static Property

Type: See types

TextureMesh

Extends: OutlinerElement

new TextureMesh( options[, uuid] )

Creates a new TextureMesh

Arguments:

options: TextureMeshOptions
uuid: string (Optional)

Property	Type	Description
name	string
uuid	string
export	boolean
locked	boolean
parent	Group or `"root"`
menu	Menu
selected	boolean
mesh	THREE.Object3D or Mesh
texture_name	string
local_pivot	ArrayVector3
scale	ArrayVector3