Class: Object3DModel

Core-API.Object3DModel

Implements

• IModel<Object3D>

Properties

assetType

• assetType: "model"

Implementation of

IModel.assetType

Accessors

visible

• get visible(): boolean

Returns

boolean

Implementation of

IModel.visible

• set visible(visible): void

Parameters

Name	Type
visible	boolean

Returns

void

Implementation of

IModel.visible

---

uuid

• get uuid(): string

Returns

string

Implementation of

IModel.uuid

---

modelObject

• get modelObject(): Object3D<Object3DEventMap> & IModel<Object3D<Object3DEventMap>, IObject3DEventMap>

Internal three.js Object3D instance (like Mesh, Group, etc)

Returns

Object3D<Object3DEventMap> & IModel<Object3D<Object3DEventMap>, IObject3DEventMap>

Implementation of

IModel.modelObject

---

name

• get name(): string

Returns

string

Implementation of

IModel.name

• set name(name): void

Parameters

Name	Type
name	string

Returns

void

Implementation of

IModel.name

---

license

• get license(): string

Returns

string

• set license(license): void

Parameters

Name	Type
license	string

Returns

void

---

material

• get material(): undefined | IMaterial<any, IMaterialEventMap> | IMaterial<any, IMaterialEventMap>[]

Use setMaterial to change the material Get one or more materials applied to an object

Returns

undefined | IMaterial<any, IMaterialEventMap> | IMaterial<any, IMaterialEventMap>[]

Implementation of

IModel.material

---

geometry

• get geometry(): any

Returns

any

Implementation of

IModel.geometry

---

userData

• get userData(): any

Returns

any

Implementation of

IModel.userData

• set userData(userData): void

Parameters

Name	Type
userData	any

Returns

void

Implementation of

IModel.userData

---

uiConfig

• get uiConfig(): UiObjectConfig<any, string>

Returns

UiObjectConfig<any, string>

Implementation of

IModel.uiConfig

Constructors

constructor

• new Object3DModel(modelObject, __namedParameters?)

Parameters

Name	Type
modelObject	Object3D<Object3DEventMap> & IModel<any, IObject3DEventMap>
__namedParameters	Object3DModelOptions

Methods

addEventListener

▸ addEventListener(type, listener): void

Parameters

Name	Type
type	string
listener	(event: any) => void

Returns

void

Implementation of

IModel.addEventListener

---

dispatchEvent

▸ dispatchEvent(event): void

Parameters

Name	Type
event	any

Returns

void

Implementation of

IModel.dispatchEvent

---

hasEventListener

▸ hasEventListener(type, listener): boolean

Parameters

Name	Type
type	string
listener	(event: any) => void

Returns

boolean

Implementation of

IModel.hasEventListener

---

removeEventListener

▸ removeEventListener(type, listener): void

Parameters

Name	Type
type	string
listener	(event: any) => void

Returns

void

Implementation of

IModel.removeEventListener

---

traverse

▸ traverse(callback): void

Parameters

Name	Type
callback	(object: Object3D<Object3DEventMap>) => void

Returns

void

---

dispose

▸ dispose(): void

Returns

void

Implementation of

IModel.dispose

---

setDirty

▸ setDirty(e?): void

Parameters

Name	Type
e?	AnyOptions

Returns

void

Implementation of

IModel.setDirty

---

setMaterial

▸ setMaterial(material?): IMaterial<any, IMaterialEventMap>[]

Parameters

Name	Type
material?	IMaterial<any, IMaterialEventMap> | IMaterial<any, IMaterialEventMap>[]

Returns

IMaterial<any, IMaterialEventMap>[]

Implementation of

IModel.setMaterial

---

setGeometry

▸ setGeometry(geometry?, force?): undefined | BufferGeometry<NormalBufferAttributes, BufferGeometryEventMap>

returns the old geometry.

Parameters

Name	Type	Default value
geometry?	BufferGeometry<NormalBufferAttributes, BufferGeometryEventMap>	undefined
force	boolean	false

Returns

undefined | BufferGeometry<NormalBufferAttributes, BufferGeometryEventMap>

Implementation of

IModel.setGeometry

---

updateBounds

▸ updateBounds(): void

Not implemented

Returns

void

---

clone

▸ clone(): Object3DModel

Returns

Object3DModel