Class Cube

Hierarchy (View Summary)

OutlinerElement
- Cube

Index

Constructors

constructor

Accessors

scene_object

Constructors

constructor

new Cube(options: ICubeOptions, uuid?: string): Cube
Parameters
- options: ICubeOptions
- Optionaluuid: string
Returns Cube
Overrides OutlinerElement.constructor
- Defined in types/custom/cube.d.ts:26

Properties

`Optional`allow_mirror_modeling

allow_mirror_modeling?: boolean

autouv

autouv: 0 | 1 | 2

Auto UV setting, saved as an integer, where 0 means disabled, 1 means enabled, and 2 means relative auto UV (cube position affects UV)

box_uv

box_uv: boolean

If the cube is using Box UV

`Optional`children

children?: OutlinerNode[]

color

color: any

export

export: boolean

faces

faces: { [fkey: string]: CubeFace }

from

from: ArrayVector3

inflate

inflate: number

Inflate adds an inflation value to all sides equally

locked

locked: boolean

`Optional`menu

menu?: Menu

mesh

mesh: Mesh<BufferGeometry, Material | Material[]> & {
geometry: BufferGeometry & { faces: string[] };
outline: Mesh;
}

mirror_uv

mirror_uv: boolean

UV mirror across the X axis when using Box UV

name

name: string

name_regex

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

`Optional`old_name

old_name?: string

origin

origin: ArrayVector3

parent

parent: OutlinerNode & OutlinerNodeParentTraits | "root"

preview_controller

preview_controller: NodePreviewController

`Optional`rescale

rescale?: boolean

rotation

rotation: ArrayVector3

rotation_axis

rotation_axis: "x" | "y" | "z"

selected

selected: boolean

shade

shade: boolean

Enable or disable shading based on face normal

stretch

stretch: ArrayVector3

to

to: ArrayVector3

type

type: string

uuid

uuid: string

uv_offset

uv_offset: ArrayVector2

UV position for box UV mode

visibility

visibility: boolean

Visibility of the cube in the viewport

`Static`all

all: Cube[]

`Static` `Optional`animator

animator?: BoneAnimator

`Static`behavior

behavior: Record<string, any>

`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: Cube[]

`Static`types

types: Record<string, ElementTypeConstructor>

`Static`uuids

uuids: { [uuid: string]: OutlinerNode }

Accessors

scene_object

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

Methods

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

applyTexture

applyTexture(texture: Texture, faces: true | CubeFaceDirection[]): void
Parameters
- texture: Texture
- faces: true | CubeFaceDirection[]
Returns void
- Defined in types/custom/cube.d.ts:103

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(options: ICubeOptions): this
Parameters
- options: ICubeOptions
Returns this
Overrides OutlinerElement.extend
- Defined in types/custom/cube.d.ts:75

flip

flip(axis: number, center: number, skipUV?: boolean): void
Parameters
- axis: number
- center: number
- OptionalskipUV: boolean
Returns void
- Defined in types/custom/cube.d.ts:94

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

getDepth

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

getGlobalVertexPositions

getGlobalVertexPositions(): ArrayVector3[]
Returns ArrayVector3[]
- Defined in types/custom/cube.d.ts:100

getParentArray

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

getSaveCopy

getSaveCopy(): Cube
Returns Cube
Overrides OutlinerElement.getSaveCopy
- Defined in types/custom/cube.d.ts:86

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?: any): any
Parameters
- Optionalaspects: any
Returns any
Overrides OutlinerElement.getUndoCopy
- Defined in types/custom/cube.d.ts:85

getWorldCenter

getWorldCenter(): Vector3
Returns Vector3
- Defined in types/custom/cube.d.ts:99

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

mapAutoUV

mapAutoUV(): void
Returns void
- Defined in types/custom/cube.d.ts:104

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(offset: ArrayVector3, axis: number, update?: boolean): void
Parameters
- offset: ArrayVector3
- axis: number
- Optionalupdate: boolean
Returns void
- Defined in types/custom/cube.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(
    value: number,
    axis: number,
    negative: boolean,
    allow_negative?: boolean,
    bidirectional?: boolean,
): void
Parameters
- value: number
- axis: number
- negative: boolean
- Optionalallow_negative: boolean
- Optionalbidirectional: boolean
Returns void
- Defined in types/custom/cube.d.ts:106

roll

roll(axis: number, steps: number, origin: ArrayVector3): void
Rotate the cube around axis in 90 degree steps
Parameters
- axis: number
  Axis index
- steps: number
  Number of steps
- origin: ArrayVector3
  Rotation pivot
Returns void
- Defined in types/custom/cube.d.ts:93

rotationAxis

rotationAxis(): string
Returns string
- Defined in types/custom/cube.d.ts:84

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 | Cube
Parameters
- Optionalevent: Event
- Optionalis_outliner_click: boolean
Returns false | Cube
Inherited from OutlinerElement.select
- Defined in types/custom/outliner.d.ts:133

setColor

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

setUVMode

setUVMode(box_uv: boolean): void
Parameters
- box_uv: boolean
Returns void
- Defined in types/custom/cube.d.ts:101

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

size

size(): ArrayVector3
Calculates and returns the size of the cube

Returns ArrayVector3
- Defined in types/custom/cube.d.ts:79
size(axis: number, floored?: boolean): number
Calculates and returns the size of a cube on a certain axis
Parameters
- axis: number
- Optionalfloored: boolean
Returns number
- Defined in types/custom/cube.d.ts:83

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: ArrayVector3, update?: boolean): void
Transfer the origin to a new position, while updating from and to to keep the same visual position.
Parameters
- origin: ArrayVector3
- Optionalupdate: boolean
Returns void
- Defined in types/custom/cube.d.ts:98

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`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 Cube

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Cube

Properties

Optionalallow_mirror_modeling

autouv

box_uv

Optionalchildren

color

export

faces

from

inflate

locked

Optionalmenu

mesh

mirror_uv

name

name_regex

Optionalold_name

origin

parent

preview_controller

Optionalrescale

rotation

rotation_axis

selected

shade

stretch

to

type

uuid

uv_offset

visibility

Staticall

Static Optionalanimator

Staticbehavior

Staticbehavior_overrides

StatichasAny

StatichasSelected

StaticisParent

Staticpreview_controller

Staticproperties

Staticselected

Statictypes

Staticuuids

Accessors

scene_object

Returns Object3D

Methods

addTo

Parameters

Returns this

applyTexture

Parameters

Returns void

clickSelect

Parameters

Returns void

createUniqueName

Parameters

Returns string | false

duplicate

Returns OutlinerElement

extend

Parameters

Returns this

flip

Parameters

Returns void

forSelected

Parameters

`Optional`allow_mirror_modeling

`Optional`children

`Optional`menu

`Optional`old_name

`Optional`rescale

`Static`all

`Static` `Optional`animator

`Static`behavior

`Static`behavior_overrides

`Static`hasAny

`Static`hasSelected

`Static`isParent

`Static`preview_controller

`Static`properties

`Static`selected

`Static`types

`Static`uuids