Class Mesh

Index

Constructors

constructor

Constructors

constructor

new Mesh(options: Partial<MeshOptions>, uuid?: string): Mesh
Parameters
- options: Partial<MeshOptions>
- Optionaluuid: string
Returns Mesh
Overrides OutlinerElement.constructor
- Defined in types/custom/mesh.d.ts:110

Properties

`Optional`allow_mirror_modeling

allow_mirror_modeling?: boolean

armature

armature: string

color

color: number

export

export: boolean

faces

faces: { [fkey: string]: MeshFace }

locked

locked: boolean

`Optional`menu

menu?: Menu

mesh

mesh: Mesh<BufferGeometry, Material | Material[]> | Object3D

name

name: string

origin

origin: ArrayVector3

`Optional`parent

parent?: OutlinerNode & OutlinerNodeParentTraits | "root"

preview_controller

preview_controller: NodePreviewController

rotation

rotation: ArrayVector3

`Readonly`scene_object

scene_object: Object3D

seams

seams: { [vkey: string]: MeshSeamValue }

selected

selected: boolean

shading

shading: "flat" | "smooth"

type

type: string

uuid

uuid: string

vertices

vertices: { [vkey: string]: ArrayVector3 }

visibility

visibility: boolean

`Static`all

all: Mesh[]

`Static` `Optional`animator

animator?: BoneAnimator

`Static`behavior_overrides

behavior_overrides: any[] = []

`Static`hasAny

hasAny: () => boolean

Check if any elements of the type are in the project

`Static`hasSelected

hasSelected: () => boolean

Check if any elements of the type are currently selected

`Static`isParent

isParent: false

`Static`preview_controller

preview_controller: NodePreviewController

`Static`properties

properties: Record<string, Property<any>>

`Static`selected

selected: Mesh[]

`Static`types

types: Record<string, typeof OutlinerElement>

`Static`uuids

uuids: { [uuid: string]: OutlinerNode }

Methods

addFaces

addFaces(...MeshFace: MeshFace[]): string[]
Parameters
- ...MeshFace: MeshFace[]
Returns string[]
- Defined in types/custom/mesh.d.ts:161

addTo

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

addVertices

addVertices(...ArrayVector3: ArrayVector3[]): string[]
Parameters
- ...ArrayVector3: ArrayVector3[]
Returns string[]
- Defined in types/custom/mesh.d.ts:160

applyTexture

applyTexture(texture: Texture, faces?: true | string[]): void
Parameters
- texture: Texture
- Optionalfaces: true | string[]
Returns void
- Defined in types/custom/mesh.d.ts:179

calculateNormals

calculateNormals(): Record<string, ArrayVector3>
Returns Record<string, ArrayVector3>
- Defined in types/custom/mesh.d.ts:155

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

extend

extend(options: Partial<MeshOptions>): this
Parameters
- options: Partial<MeshOptions>
Returns this
Overrides OutlinerElement.extend
- Defined in types/custom/mesh.d.ts:129
extend(data: MeshOptions): void
Parameters
- data: MeshOptions
Returns void
Overrides OutlinerElement.extend
- Defined in types/custom/mesh.d.ts:162

flip

flip(axis: number): void
Parameters
- axis: number
Returns void
- Defined in types/custom/mesh.d.ts:170

forAllFaces

forAllFaces(callback: (face: MeshFace, key: string) => void): void
Parameters
- callback: (face: MeshFace, key: string) => void
Returns void
- Defined in types/custom/mesh.d.ts:166

getArmature

getArmature(): Armature
Get the armature if one is attached to the mesh

Returns Armature
- Defined in types/custom/mesh.d.ts:150

getCenter

getCenter(global: boolean): Vector3
Parameters
- global: boolean
Returns Vector3
- Defined in types/custom/mesh.d.ts:165

getParentArray

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

`Optional`getSaveCopy

getSaveCopy?(...args: any[]): Record<string, any>
Parameters
- ...args: any[]
Returns Record<string, any>
Inherited from OutlinerElement.getSaveCopy
- Defined in types/custom/outliner.d.ts:78

getSeam

getSeam(edge: MeshEdge): MeshSeamValue
Parameters
- edge: MeshEdge
Returns MeshSeamValue
- Defined in types/custom/mesh.d.ts:158

getSelectedEdges

getSelectedEdges(can_write?: boolean): [string, string][]
Get selected edges as vertex key pairs
Parameters
- Optionalcan_write: boolean
  If true, the array can safely be modified to update the selection
Returns [string, string][]
- Defined in types/custom/mesh.d.ts:140

getSelectedFaces

getSelectedFaces(can_write?: boolean): string[]
Get selected faces as face keys
Parameters
- Optionalcan_write: boolean
  If true, the array can safely be modified to update the selection
Returns string[]
- Defined in types/custom/mesh.d.ts:145

getSelectedVertices

getSelectedVertices(can_write?: boolean): string[]
Get selected vertices as vertex keys
Parameters
- Optionalcan_write: boolean
  If true, the array can safely be modified to update the selection
Returns string[]
- Defined in types/custom/mesh.d.ts:135

getSelectionRotation

getSelectionRotation(): Euler
Returns Euler
- Defined in types/custom/mesh.d.ts:164

getTypeBehavior

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

getUndoCopy

getUndoCopy(aspects?: any): any
Parameters
- Optionalaspects: any
Returns any
- Defined in types/custom/mesh.d.ts:163

getWorldCenter

getWorldCenter(ignore_mesh_selection?: boolean): Vector3
Parameters
- Optionalignore_mesh_selection: boolean
Returns Vector3
- Defined in types/custom/mesh.d.ts:159

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:34

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:72

markAsSelected

markAsSelected(descendants?: boolean): void
Mark the element as selected
Parameters
- Optionaldescendants: boolean
Returns void
Inherited from OutlinerElement.markAsSelected
- Defined in types/custom/outliner.d.ts:42

moveVector

moveVector(offset: ArrayVector3, axis: number, update?: boolean): void
Parameters
- offset: ArrayVector3
- axis: number
- Optionalupdate: boolean
Returns void
- Defined in types/custom/mesh.d.ts:171

remove

remove(undo?: boolean): void
Removes the element.
Parameters
- Optionalundo: boolean
Returns void
Inherited from OutlinerElement.remove
- Defined in types/custom/outliner.d.ts:55

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:59

resize

resize(
    val: number,
    axis: number,
    negative: boolean,
    allow_negative: boolean,
    bidirectional?: boolean,
): void
Parameters
- val: number
- axis: number
- negative: boolean
- allow_negative: boolean
- Optionalbidirectional: boolean
Returns void
- Defined in types/custom/mesh.d.ts:172

roll

roll(axis: number, steps: number, origin?: ArrayVector3): void
Parameters
- axis: number
- steps: number
- Optionalorigin: ArrayVector3
Returns void
- Defined in types/custom/mesh.d.ts:169

sanitizeName

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

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:63

select

select(event?: any, isOutlinerClick?: boolean): this
Parameters
- Optionalevent: any
- OptionalisOutlinerClick: boolean
Returns this
Inherited from OutlinerElement.select
- Defined in types/custom/outliner.d.ts:107

setColor

setColor(color: number): void
Parameters
- color: number
Returns void
- Defined in types/custom/mesh.d.ts:168

setSeam

setSeam(edge: MeshEdge, value: any): void
Parameters
- edge: MeshEdge
- value: any
Returns void
- Defined in types/custom/mesh.d.ts:157

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:77

showInOutliner

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

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

sortAllFaceVertices

sortAllFaceVertices(): void
Vertex lists of quads are generally in arbitrary order, the order is calculated when calling getSortedVertices() to account for dfiferent face geometries. Calling this method pre-sorts all faces to allow optimizing subsequent processing

Returns void
- Defined in types/custom/mesh.d.ts:154

sortInBefore

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

transferOrigin

transferOrigin(origin: ArrayVector3, update?: boolean): void
Parameters
- origin: ArrayVector3
- Optionalupdate: boolean
Returns void
- Defined in types/custom/mesh.d.ts:167

unselect

unselect(...args: any[]): this
Parameters
- ...args: any[]
Returns this
Inherited from OutlinerElement.unselect
- Defined in types/custom/outliner.d.ts:108

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:51

`Static`addBehaviorOverride

addBehaviorOverride(
override_options: { behavior: Record<string, any>; condition: any },
): Deletable
Parameters
- override_options: { behavior: Record<string, any>; condition: any }
Returns Deletable
Inherited from OutlinerElement.addBehaviorOverride
- Defined in types/custom/outliner.d.ts:83

`Static`fromSave

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

`Static`registerType

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

Class Mesh

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Mesh

Properties

Optionalallow_mirror_modeling

armature

color

export

faces

locked

Optionalmenu

mesh

name

origin

Optionalparent

preview_controller

rotation

Readonlyscene_object

seams

selected

shading

type

uuid

vertices

visibility

Staticall

Static Optionalanimator

Staticbehavior_overrides

StatichasAny

StatichasSelected

StaticisParent

Staticpreview_controller

Staticproperties

Staticselected

Statictypes

Staticuuids

Methods

addFaces

Parameters

Returns string[]

addTo

Parameters

Returns this

addVertices

Parameters

Returns string[]

applyTexture

Parameters

Returns void

calculateNormals

Returns Record<string, ArrayVector3>

createUniqueName

Parameters

Returns this

extend

Parameters

Returns this

Parameters

Returns void

flip

Parameters

Returns void

forAllFaces

Parameters

Returns void

getArmature

Returns Armature

getCenter

Parameters

Returns Vector3

getParentArray

Returns OutlinerNode[]

OptionalgetSaveCopy

Parameters

`Optional`allow_mirror_modeling

`Optional`menu

`Optional`parent

`Readonly`scene_object

`Static`all

`Static` `Optional`animator

`Static`behavior_overrides

`Static`hasAny

`Static`hasSelected

`Static`isParent

`Static`preview_controller

`Static`properties

`Static`selected

`Static`types

`Static`uuids

`Optional`getSaveCopy