Class Billboard

Constructors

constructor

new Billboard(data: any, uuid: any): Billboard
Parameters
- data: any
- uuid: any
Returns Billboard
Overrides OutlinerElement.constructor
- Defined in types/generated/outliner/billboard.d.ts:33

Properties

`Optional`allow_mirror_modeling

allow_mirror_modeling?: boolean

autouv

autouv: number

buttons

buttons: OutlinerToggle[]

color

color: number

export

export: boolean

faces

faces: { front: BillboardFace }

icon

icon: string

locked

locked: boolean

menu: Menu

name

name: string

offset

offset: number[]

`Optional`parent

parent?: OutlinerNode & OutlinerNodeParentTraits | "root"

position

position: number[]

preview_controller

preview_controller: NodePreviewController

`Readonly`scene_object

scene_object: Object3D

selected

selected: boolean

shade

shade: boolean

size

size: (string | number | boolean)[]

title

title: string

type

type: string

uuid

uuid: string

visibility

visibility: boolean

`Static`all

all: OutlinerElement[]

`Static` `Optional`animator

animator?: BoneAnimator

`Static`behavior

behavior: {
    cube_faces: boolean;
    movable: boolean;
    resizable: boolean;
    select_faces: boolean;
    unique_name: boolean;
}

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

`Static`types

types: Record<string, typeof OutlinerElement>

`Static`uuids

uuids: { [uuid: string]: OutlinerNode }

Accessors

mesh

get mesh(): Object3D
Returns Object3D
Overrides OutlinerElement.mesh
- Defined in types/generated/outliner/billboard.d.ts:48

origin

get origin(): number[]
Returns number[]
- Defined in types/generated/outliner/billboard.d.ts:44

Methods

addTo

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

applyTexture

applyTexture(texture: any): void
Parameters
- texture: any
Returns void
- Defined in types/generated/outliner/billboard.d.ts:67

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(object: any): this
Parameters
- object: any
Returns this
Overrides OutlinerElement.extend
- Defined in types/generated/outliner/billboard.d.ts:45

flip

flip(axis: any): this
Parameters
- axis: any
Returns this
- Defined in types/generated/outliner/billboard.d.ts:64

getMesh

getMesh(): Object3D
Returns Object3D
- Defined in types/generated/outliner/billboard.d.ts:47

getParentArray

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

getSaveCopy

getSaveCopy(): {
    autouv: number;
    color: number;
    export: boolean;
    faces: { front: any };
    from: any;
    origin: number[];
    shade: boolean;
    type: string;
    uuid: string;
    visibility: boolean;
}
Returns {
    autouv: number;
    color: number;
    export: boolean;
    faces: { front: any };
    from: any;
    origin: number[];
    shade: boolean;
    type: string;
    uuid: string;
    visibility: boolean;
}
Overrides OutlinerElement.getSaveCopy
- Defined in types/generated/outliner/billboard.d.ts:50

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?: number): Billboard
Parameters
- Optionalaspects: number
Returns Billboard
- Defined in types/generated/outliner/billboard.d.ts:49

getWorldCenter

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

init

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

Returns this
Overrides OutlinerElement.init
- Defined in types/generated/outliner/billboard.d.ts:46

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

mapAutoUV

mapAutoUV(): void
Returns void
- Defined in types/generated/outliner/billboard.d.ts:70

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(arr: any, axis: any, update?: boolean): void
Parameters
- arr: any
- axis: any
- Optionalupdate: boolean
Returns void
- Defined in types/generated/outliner/billboard.d.ts:68

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: any, axis: any, negative: any): this
Parameters
- val: any
- axis: any
- negative: any
Returns this
- Defined in types/generated/outliner/billboard.d.ts:69

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(index: any): this
Parameters
- index: any
Returns this
- Defined in types/generated/outliner/billboard.d.ts:66

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

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

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 Billboard

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Billboard

Properties

Optionalallow_mirror_modeling

autouv

buttons

color

export

faces

icon

locked

menu

name

offset

Optionalparent

position

preview_controller

Readonlyscene_object

selected

shade

size

title

type

uuid

visibility

Staticall

Static Optionalanimator

Staticbehavior

Staticbehavior_overrides

StatichasAny

StatichasSelected

StaticisParent

Staticpreview_controller

Staticproperties

Staticselected

Statictypes

Staticuuids

Accessors

mesh

Returns Object3D

origin

Returns number[]

Methods

addTo

Parameters

Returns this

applyTexture

Parameters

Returns void

createUniqueName

Parameters

Returns this

extend

Parameters

Returns this

flip

Parameters

Returns this

getMesh

Returns Object3D

getParentArray

Returns OutlinerNode[]

getSaveCopy

Returns { autouv: number; color: number; export: boolean; faces: { front: any }; from: any; origin: number[]; shade: boolean; type: string; uuid: string; visibility: boolean;}

getTypeBehavior

Parameters

Returns any

getUndoCopy

Parameters

Returns Billboard

getWorldCenter

Returns Vector3

`Optional`allow_mirror_modeling

`Optional`parent

`Readonly`scene_object

`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

Returns {
autouv: number;
color: number;
export: boolean;
faces: { front: any };
from: any;
origin: number[];
shade: boolean;
type: string;
uuid: string;
visibility: boolean;
}

`Static`addBehaviorOverride

`Static`fromSave

`Static`registerType