Class ArmatureBone

Hierarchy

unknown
- ArmatureBone

Constructors

constructor

new ArmatureBone(data?: ArmatureBoneOptions, uuid?: string): ArmatureBone
Parameters
- Optionaldata: ArmatureBoneOptions
- Optionaluuid: string
Returns ArmatureBone
Overrides OutlinerElement.constructor
- Defined in types/generated/outliner/types/armature_bone.d.ts:30

Properties

buttons

buttons: OutlinerToggle[]

children

children: ArmatureBone[]

color

color: number

connected

connected: boolean

icon

icon: string

isOpen

isOpen: boolean

length

length: number

menu: Menu

name_regex

name_regex: () => false | "a-zA-Z0-9_"

`Optional`old_size

old_size?: number | ArrayVector3

origin

origin: ArrayVector3

rotation

rotation: ArrayVector3

title

title: string

type

type: string

vertex_weights

vertex_weights: Record<string, number>

visibility

visibility: boolean

width

width: number

`Static`all

all: ArmatureBone[]

`Static`behavior

behavior: {
    child_types: string[];
    hide_in_screenshot: boolean;
    marker_color: boolean;
    movable: boolean;
    parent: boolean;
    parent_types: string[];
    resizable: boolean;
    rotatable: boolean;
    select_children: string;
    unique_name: boolean;
}

`Static`preview_controller

preview_controller: NodePreviewController

`Static`selected

selected: ArmatureBone[]

Accessors

position

get position(): ArrayVector3
Returns ArrayVector3
- Defined in types/generated/outliner/types/armature_bone.d.ts:31

Methods

extend

extend(object: ArmatureBoneOptions): this
Parameters
- object: ArmatureBoneOptions
Returns this
- Defined in types/generated/outliner/types/armature_bone.d.ts:32

flip

flip(axis: number, center: number): this
Parameters
- axis: number
- center: number
Returns this
- Defined in types/generated/outliner/types/armature_bone.d.ts:43

forEachChild

forEachChild(
    cb: (element: ArmatureBone) => void,
    type?: any,
    forSelf?: boolean,
): void
Parameters
- cb: (element: ArmatureBone) => void
- Optionaltype: any
- OptionalforSelf: boolean
Returns void
- Defined in types/generated/outliner/types/armature_bone.d.ts:58

getArmature

getArmature(): Armature
Returns Armature
- Defined in types/generated/outliner/types/armature_bone.d.ts:33

getChildlessCopy

getChildlessCopy(keep_uuid?: boolean): ArmatureBone
Parameters
- Optionalkeep_uuid: boolean
Returns ArmatureBone
- Defined in types/generated/outliner/types/armature_bone.d.ts:57

getSaveCopy

getSaveCopy(): {
    children: string[];
    isOpen: boolean;
    name: string;
    type: string;
    uuid: string;
}
Returns {
    children: string[];
    isOpen: boolean;
    name: string;
    type: string;
    uuid: string;
}
- Defined in types/generated/outliner/types/armature_bone.d.ts:49

getSize

getSize(axis: any): number
Parameters
- axis: any
Returns number
- Defined in types/generated/outliner/types/armature_bone.d.ts:46

getUndoCopy

getUndoCopy(): any
Returns any
- Defined in types/generated/outliner/types/armature_bone.d.ts:56

getVertexWeight

getVertexWeight(mesh: Mesh, vkey: string): number
Parameters
- mesh: Mesh
- vkey: string
Returns number
- Defined in types/generated/outliner/types/armature_bone.d.ts:34

getWorldCenter

getWorldCenter(): Vector3
Returns Vector3
- Defined in types/generated/outliner/types/armature_bone.d.ts:42

init

init(): this
Returns this
- Defined in types/generated/outliner/types/armature_bone.d.ts:36

markAsSelected

markAsSelected(descendants: boolean): this
Parameters
- descendants: boolean
Returns this
- Defined in types/generated/outliner/types/armature_bone.d.ts:38

matchesSelection

matchesSelection(): boolean
Returns boolean
- Defined in types/generated/outliner/types/armature_bone.d.ts:39

openUp

openUp(): this
Returns this
- Defined in types/generated/outliner/types/armature_bone.d.ts:40

resize

resize(
    move_value: number | ((input: number) => number),
    axis_number?: axisNumber,
    invert?: boolean,
): void
Parameters
- move_value: number | ((input: number) => number)
- Optionalaxis_number: axisNumber
- Optionalinvert: boolean
Returns void
- Defined in types/generated/outliner/types/armature_bone.d.ts:47

select

select(event?: Event, isOutlinerClick?: boolean): false | ArmatureBone
Parameters
- Optionalevent: Event
- OptionalisOutlinerClick: boolean
Returns false | ArmatureBone
- Defined in types/generated/outliner/types/armature_bone.d.ts:37

setColor

setColor(index: any): this
Parameters
- index: any
Returns this
- Defined in types/generated/outliner/types/armature_bone.d.ts:48

setVertexWeight

setVertexWeight(mesh: Mesh, vkey: string, weight?: number): void
Parameters
- mesh: Mesh
- vkey: string
- Optionalweight: number
Returns void
- Defined in types/generated/outliner/types/armature_bone.d.ts:35

size

size(): ArrayVector3
Returns ArrayVector3
- Defined in types/generated/outliner/types/armature_bone.d.ts:44
size(axis: axisLetter): number
Parameters
- axis: axisLetter
Returns number
- Defined in types/generated/outliner/types/armature_bone.d.ts:45

transferOrigin

transferOrigin(origin: ArrayVector3): this
Parameters
- origin: ArrayVector3
Returns this
- Defined in types/generated/outliner/types/armature_bone.d.ts:41

Class ArmatureBone

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns ArmatureBone

Properties

buttons

children

color

connected

icon

isOpen

length

menu

name_regex

Optionalold_size

origin

rotation

title

type

vertex_weights

visibility

width

Staticall

Staticbehavior

Staticpreview_controller

Staticselected

Accessors

position

Returns ArrayVector3

Methods

extend

Parameters

Returns this

flip

Parameters

Returns this

forEachChild

Parameters

Returns void

getArmature

Returns Armature

getChildlessCopy

Parameters

Returns ArmatureBone

getSaveCopy

Returns { children: string[]; isOpen: boolean; name: string; type: string; uuid: string;}

getSize

Parameters

Returns number

getUndoCopy

Returns any

getVertexWeight

Parameters

Returns number

getWorldCenter

Returns Vector3

init

Returns this

markAsSelected

Parameters

Returns this

matchesSelection

Returns boolean

openUp

Returns this

resize

Parameters

Returns void

select

Parameters

Returns false | ArmatureBone

setColor

Parameters

`Optional`old_size

`Static`all

`Static`behavior

`Static`preview_controller

`Static`selected

Returns {
children: string[];
isOpen: boolean;
name: string;
type: string;
uuid: string;
}