Class Mesh

Hierarchy (View Summary)

OutlinerElement
- Mesh

Index

Constructors

constructor

Accessors

faces mesh position preview_controller scene_object seams vertice_list vertices

Constructors

constructor

new Mesh(data: any, uuid: any): Mesh
Parameters
- data: any
- uuid: any
Returns Mesh
Overrides OutlinerElement.constructor
- Defined in types/generated/outliner/types/mesh.d.ts:53

Properties

_static

_static: { properties: { faces: {}; seams: {}; vertices: {} } }

`Optional`allow_mirror_modeling

allow_mirror_modeling?: boolean

buttons

buttons: OutlinerToggle[]

`Optional`children

children?: OutlinerNode[]

color

color: any

export

export: boolean

icon

icon: string

locked

locked: boolean

menu: Menu

name

name: string

name_regex

name_regex: (element?: OutlinerNode) => string | boolean

`Optional`old_name

old_name?: string

parent

parent: OutlinerNode & OutlinerNodeParentTraits | "root"

selected

selected: boolean

title

title: string

type

type: string

uuid

uuid: string

`Static`all

all: OutlinerElement[]

`Static` `Optional`animator

animator?: BoneAnimator

`Static`behavior

behavior: {
    has_pivot: boolean;
    marker_color: boolean;
    movable: boolean;
    resizable: boolean;
    rotatable: boolean;
    unique_name: boolean;
}

`Static`behavior_overrides

behavior_overrides: any[]

`Static`isParent

isParent: false

`Static`preview_controller

preview_controller: NodePreviewController

`Static`properties

properties: Record<string, Property<any>>

`Static`selected

selected: OutlinerElement[]

`Static`types

types: Record<string, ElementTypeConstructor>

`Static`uuids

uuids: { [uuid: string]: OutlinerNode }

Accessors

faces

get faces(): {}
Returns {}
- Defined in types/generated/outliner/types/mesh.d.ts:64
set faces(v: {}): void
Parameters
- v: {}
Returns void
- Defined in types/generated/outliner/types/mesh.d.ts:63

mesh

get mesh(): Object3D
Returns Object3D
Inherited from OutlinerElement.mesh
- Defined in types/custom/outliner.d.ts:67

position

get position(): any
Returns any
- Defined in types/generated/outliner/types/mesh.d.ts:67

preview_controller

get preview_controller(): NodePreviewController
Returns NodePreviewController
Inherited from OutlinerElement.preview_controller
- Defined in types/custom/outliner.d.ts:33

scene_object

get scene_object(): Object3D
Returns Object3D
Inherited from OutlinerElement.scene_object
- Defined in types/custom/outliner.d.ts:68

seams

get seams(): {}
Returns {}
- Defined in types/generated/outliner/types/mesh.d.ts:66
set seams(v: {}): void
Parameters
- v: {}
Returns void
- Defined in types/generated/outliner/types/mesh.d.ts:65

vertice_list

get vertice_list(): any[]
Returns any[]
- Defined in types/generated/outliner/types/mesh.d.ts:68

vertices

get vertices(): {}
Returns {}
- Defined in types/generated/outliner/types/mesh.d.ts:62
set vertices(v: {}): void
Parameters
- v: {}
Returns void
- Defined in types/generated/outliner/types/mesh.d.ts:61

Methods

addFaces

addFaces(...faces: any[]): string[]
Parameters
- ...faces: any[]
Returns string[]
- Defined in types/generated/outliner/types/mesh.d.ts:73

addTo

addTo(target?: OutlinerNode | "root", index?: number): this
Parameters
- Optionaltarget: OutlinerNode | "root"
- Optionalindex: number
Returns this
Inherited from OutlinerElement.addTo
- Defined in types/custom/outliner.d.ts:55

addVertices

addVertices(...vectors: any[]): string[]
Parameters
- ...vectors: any[]
Returns string[]
- Defined in types/generated/outliner/types/mesh.d.ts:72

applyTexture

applyTexture(texture: any, faces: any): void
Parameters
- texture: any
- faces: any
Returns void
- Defined in types/generated/outliner/types/mesh.d.ts:107

calculateNormals

calculateNormals(): {}
Returns {}
- Defined in types/generated/outliner/types/mesh.d.ts:96

clickSelect

clickSelect(event: any, outliner_click?: boolean): void
Parameters
- event: any
- Optionaloutliner_click: boolean
Returns void
Inherited from OutlinerElement.clickSelect
- Defined in types/custom/outliner.d.ts:134

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
Inherited from OutlinerElement.createUniqueName
- Defined in types/custom/outliner.d.ts:87

duplicate

duplicate(): OutlinerElement
Returns OutlinerElement
Inherited from OutlinerElement.duplicate
- Defined in types/custom/outliner.d.ts:132

extend

extend(object: any): this
Parameters
- object: any
Returns this
Overrides OutlinerElement.extend
- Defined in types/generated/outliner/types/mesh.d.ts:74

flip

flip(axis: any, center: any): this
Parameters
- axis: any
- center: any
Returns this
- Defined in types/generated/outliner/types/mesh.d.ts:103

flipSelection

flipSelection(axis: any, center: any): this
Parameters
- axis: any
- center: any
Returns this
- Defined in types/generated/outliner/types/mesh.d.ts:104

forAllFaces

forAllFaces(cb: any): void
Parameters
- cb: any
Returns void
- Defined in types/generated/outliner/types/mesh.d.ts:98

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[]
Inherited from OutlinerElement.forSelected
- Defined in types/custom/outliner.d.ts:131

getArmature

getArmature(): OutlinerNode & OutlinerNodeParentTraits | "root"
Returns OutlinerNode & OutlinerNodeParentTraits | "root"
- Defined in types/generated/outliner/types/mesh.d.ts:75

getCenter

getCenter(global: any): number[]
Parameters
- global: any
Returns number[]
- Defined in types/generated/outliner/types/mesh.d.ts:94

getDepth

getDepth(): number
Returns number
Inherited from OutlinerElement.getDepth
- Defined in types/custom/outliner.d.ts:69

getParentArray

getParentArray(): OutlinerNode[]
Returns OutlinerNode[]
Inherited from OutlinerElement.getParentArray
- Defined in types/custom/outliner.d.ts:57

getSaveCopy

getSaveCopy(): {
    faces: {};
    seams: {};
    type: string;
    uuid: string;
    vertices: {};
}
Returns { faces: {}; seams: {}; type: string; uuid: string; vertices: {} }
Overrides OutlinerElement.getSaveCopy
- Defined in types/generated/outliner/types/mesh.d.ts:83

getSeam

getSeam(edge: any): any
Parameters
- edge: any
Returns any
- Defined in types/generated/outliner/types/mesh.d.ts:70

getSelectedEdges

getSelectedEdges(make: any): string[]
Parameters
- make: any
Returns string[]
- Defined in types/generated/outliner/types/mesh.d.ts:91

getSelectedFaces

getSelectedFaces(make: any): string[]
Parameters
- make: any
Returns string[]
- Defined in types/generated/outliner/types/mesh.d.ts:92

getSelectedVertices

getSelectedVertices(make: any): string[]
Parameters
- make: any
Returns string[]
- Defined in types/generated/outliner/types/mesh.d.ts:90

getSelectionRotation

getSelectionRotation(): any
Returns any
- Defined in types/generated/outliner/types/mesh.d.ts:93

getSize

getSize(axis: any, selection_only: any): number
Parameters
- axis: any
- selection_only: any
Returns number
- Defined in types/generated/outliner/types/mesh.d.ts:95

getTypeBehavior

getTypeBehavior(flag: string): any
Parameters
- flag: string
Returns any
Inherited from OutlinerElement.getTypeBehavior
- Defined in types/custom/outliner.d.ts:53

getUndoCopy

getUndoCopy(
aspects?: {},
): { faces: {}; seams: {}; type: string; uuid: string; vertices: {} }
Parameters
- Optionalaspects: {}
Returns { faces: {}; seams: {}; type: string; uuid: string; vertices: {} }
Overrides OutlinerElement.getUndoCopy
- Defined in types/generated/outliner/types/mesh.d.ts:76

getWorldCenter

getWorldCenter(ignore_mesh_selection: any): Vector3
Parameters
- ignore_mesh_selection: any
Returns Vector3
- Defined in types/generated/outliner/types/mesh.d.ts:71

init

init(): this
Initializes the node. This should always be called when creating nodes that will be used in the outliner.

Returns this
Inherited from OutlinerElement.init
- Defined in types/custom/outliner.d.ts:128

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
Inherited from OutlinerElement.isChildOf
- Defined in types/custom/outliner.d.ts:94

isIconEnabled

isIconEnabled(toggle: any): any
Parameters
- toggle: any
Returns any
Inherited from OutlinerElement.isIconEnabled
- Defined in types/custom/outliner.d.ts:88

markAsSelected

markAsSelected(select_children?: boolean): this
Mark the element as selected
Parameters
- Optionalselect_children: boolean
Returns this
Inherited from OutlinerElement.markAsSelected
- Defined in types/custom/outliner.d.ts:135

matchesFilter

matchesFilter(search_term_lowercase: any): any
Parameters
- search_term_lowercase: any
Returns any
Inherited from OutlinerElement.matchesFilter
- Defined in types/custom/outliner.d.ts:89

moveVector

moveVector(arr: any, axis: any, update?: boolean): void
Parameters
- arr: any
- axis: any
- Optionalupdate: boolean
Returns void
- Defined in types/generated/outliner/types/mesh.d.ts:105

remove

remove(): this
Removes the node.

Returns this
Inherited from OutlinerElement.remove
- Defined in types/custom/outliner.d.ts:129

removeFromParent

removeFromParent(): this
Returns this
Inherited from OutlinerElement.removeFromParent
- Defined in types/custom/outliner.d.ts:56

rename

rename(): this
Marks the name of the group or element in the outliner for renaming.

Returns this
Inherited from OutlinerElement.rename
- Defined in types/custom/outliner.d.ts:78

resize

resize(
    val: any,
    axis: any,
    negative: any,
    allow_negative: any,
    bidirectional: any,
): void
Parameters
- val: any
- axis: any
- negative: any
- allow_negative: any
- bidirectional: any
Returns void
- Defined in types/generated/outliner/types/mesh.d.ts:106

roll

roll(axis: any, steps: any, origin_arg: any): this
Parameters
- axis: any
- steps: any
- origin_arg: any
Returns this
- Defined in types/generated/outliner/types/mesh.d.ts:102

sanitizeName

sanitizeName(): string
Returns string
Inherited from OutlinerElement.sanitizeName
- Defined in types/custom/outliner.d.ts:83

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
Inherited from OutlinerElement.saveName
- Defined in types/custom/outliner.d.ts:82

select

select(event?: Event, is_outliner_click?: boolean): false | Mesh
Parameters
- Optionalevent: Event
- Optionalis_outliner_click: boolean
Returns false | Mesh
Inherited from OutlinerElement.select
- Defined in types/custom/outliner.d.ts:133

setColor

setColor(index: any): void
Parameters
- index: any
Returns void
- Defined in types/generated/outliner/types/mesh.d.ts:100

setSeam

setSeam(edge: any, value: any): void
Parameters
- edge: any
- value: any
Returns void
- Defined in types/generated/outliner/types/mesh.d.ts:69

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
Inherited from OutlinerElement.showContexMenu
- Defined in types/custom/outliner.d.ts:42

showContextMenu

showContextMenu(event: MouseEvent): this
Parameters
- event: MouseEvent
Returns this
Inherited from OutlinerElement.showContextMenu
- Defined in types/custom/outliner.d.ts:130

showInOutliner

showInOutliner(): void
Unfolds the outliner and scrolls up or down if necessary to show the group or element.

Returns void
Inherited from OutlinerElement.showInOutliner
- Defined in types/custom/outliner.d.ts:62

sortAllFaceVertices

sortAllFaceVertices(): void
Returns void
- Defined in types/generated/outliner/types/mesh.d.ts:97

sortInBefore

sortInBefore(element?: OutlinerNode, index_modifier?: number): this
Parameters
- Optionalelement: OutlinerNode
- Optionalindex_modifier: number
Returns this
Inherited from OutlinerElement.sortInBefore
- Defined in types/custom/outliner.d.ts:54

transferOrigin

transferOrigin(origin: any): this
Parameters
- origin: any
Returns this
- Defined in types/generated/outliner/types/mesh.d.ts:99

unselect

unselect(unselect_parent?: boolean): this
Parameters
- Optionalunselect_parent: boolean
Returns this
Inherited from OutlinerElement.unselect
- Defined in types/custom/outliner.d.ts:136

updateElement

updateElement(): this
Updates the Vue node of the element. This is only necessary in some rare situations

Returns this
Inherited from OutlinerElement.updateElement
- Defined in types/custom/outliner.d.ts:66

`Static`addBehaviorOverride

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
Inherited from OutlinerElement.addBehaviorOverride
- Defined in types/custom/outliner.d.ts:95

`Static`fromSave

fromSave(obj: any, keep_uuid?: boolean): OutlinerElement
Parameters
- obj: any
- Optionalkeep_uuid: boolean
Returns OutlinerElement
Inherited from OutlinerElement.fromSave
- Defined in types/custom/outliner.d.ts:139

`Static`hasAny

hasAny(): boolean
Check if any elements of the type are in the project

Returns boolean
Inherited from OutlinerElement.hasAny
- Defined in types/custom/outliner.d.ts:142

`Static`hasSelected

hasSelected(): boolean
Check if any elements of the type are currently selected

Returns boolean
Inherited from OutlinerElement.hasSelected
- Defined in types/custom/outliner.d.ts:144

`Static`isTypePermitted

isTypePermitted(type: string): boolean
Parameters
- type: string
Returns boolean
Inherited from OutlinerElement.isTypePermitted
- Defined in types/custom/outliner.d.ts:140

`Static`registerType

registerType(constructor: ElementTypeConstructor, id: string): void
Parameters
- constructor: ElementTypeConstructor
- id: string
Returns void
Inherited from OutlinerElement.registerType
- Defined in types/custom/outliner.d.ts:146

Class Mesh

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Mesh

Properties

_static

Optionalallow_mirror_modeling

buttons

Optionalchildren

color

export

icon

locked

menu

name

name_regex

Optionalold_name

parent

selected

title

type

uuid

Staticall

Static Optionalanimator

Staticbehavior

Staticbehavior_overrides

StaticisParent

Staticpreview_controller

Staticproperties

Staticselected

Statictypes

Staticuuids

Accessors

faces

Returns {}

Parameters

Returns void

mesh

Returns Object3D

position

Returns any

preview_controller

Returns NodePreviewController

scene_object

Returns Object3D

seams

Returns {}

Parameters

Returns void

vertice_list

Returns any[]

vertices

Returns {}

Parameters

Returns void

Methods

addFaces

Parameters

Returns string[]

addTo

Parameters

Returns this

addVertices

Parameters

Returns string[]

applyTexture

Parameters

Returns void

calculateNormals

Returns {}

clickSelect

Parameters

Returns void

`Optional`allow_mirror_modeling

`Optional`children

`Optional`old_name

`Static`all

`Static` `Optional`animator

`Static`behavior

`Static`behavior_overrides

`Static`isParent

`Static`preview_controller

`Static`properties

`Static`selected

`Static`types

`Static`uuids