Skip to main content

Class: Object3DModel

Core-API.Object3DModel

Implements

Properties

assetType

assetType: "model"

Implementation of

IModel.assetType

Defined in

webgi/src/core/threejs/Object3DModel.ts:16

Accessors

visible

get visible(): boolean

Returns

boolean

Implementation of

IModel.visible

Defined in

webgi/src/core/threejs/Object3DModel.ts:18

set visible(visible): void

Parameters

NameType
visibleboolean

Returns

void

Implementation of

IModel.visible

Defined in

webgi/src/core/threejs/Object3DModel.ts:21


uuid

get uuid(): string

Returns

string

Implementation of

IModel.uuid

Defined in

webgi/src/core/threejs/Object3DModel.ts:24


modelObject

get modelObject(): Object3D<Event> & IModel<Object3D<Event>>

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

Returns

Object3D<Event> & IModel<Object3D<Event>>

Implementation of

IModel.modelObject

Defined in

webgi/src/core/threejs/Object3DModel.ts:27


name

get name(): string

Returns

string

Implementation of

IModel.name

Defined in

webgi/src/core/threejs/Object3DModel.ts:31

set name(name): void

Parameters

NameType
namestring

Returns

void

Implementation of

IModel.name

Defined in

webgi/src/core/threejs/Object3DModel.ts:34


license

get license(): string

Returns

string

Defined in

webgi/src/core/threejs/Object3DModel.ts:95

set license(license): void

Parameters

NameType
licensestring

Returns

void

Defined in

webgi/src/core/threejs/Object3DModel.ts:99


material

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

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

Returns

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

Implementation of

IModel.material

Defined in

webgi/src/core/threejs/Object3DModel.ts:147


geometry

get geometry(): any

Returns

any

Implementation of

IModel.geometry

Defined in

webgi/src/core/threejs/Object3DModel.ts:150


userData

get userData(): any

Returns

any

Implementation of

IModel.userData

Defined in

webgi/src/core/threejs/Object3DModel.ts:162

set userData(userData): void

Parameters

NameType
userDataany

Returns

void

Implementation of

IModel.userData

Defined in

webgi/src/core/threejs/Object3DModel.ts:166


uiConfig

get uiConfig(): UiObjectConfig<any, string>

Returns

UiObjectConfig<any, string>

Implementation of

IModel.uiConfig

Defined in

webgi/src/core/threejs/Object3DModel.ts:181

Constructors

constructor

new Object3DModel(modelObject, __namedParameters?)

Parameters

NameType
modelObjectObject3D<Event> & IModel<any>
__namedParametersObject3DModelOptions

Defined in

webgi/src/core/threejs/Object3DModel.ts:40

Methods

addEventListener

addEventListener(type, listener): void

Adds a listener to an event type.

Parameters

NameType
typestring
listener(event: IEvent<string>) => void

Returns

void

Implementation of

IModel.addEventListener

Defined in

webgi/src/core/threejs/Object3DModel.ts:103


dispatchEvent

dispatchEvent(event): void

Fire an event type.

Parameters

NameType
eventIEvent<string>

Returns

void

Implementation of

IModel.dispatchEvent

Defined in

webgi/src/core/threejs/Object3DModel.ts:107


hasEventListener

hasEventListener(type, listener): boolean

Checks if listener is added to an event type.

Parameters

NameType
typestring
listener(event: IEvent<string>) => void

Returns

boolean

Implementation of

IModel.hasEventListener

Defined in

webgi/src/core/threejs/Object3DModel.ts:111


removeEventListener

removeEventListener(type, listener): void

Removes a listener from an event type.

Parameters

NameType
typestring
listener(event: IEvent<string>) => void

Returns

void

Implementation of

IModel.removeEventListener

Defined in

webgi/src/core/threejs/Object3DModel.ts:115


traverse

traverse(callback): void

Parameters

NameType
callback(object: Object3D<Event>) => void

Returns

void

Defined in

webgi/src/core/threejs/Object3DModel.ts:119


dispose

dispose(): void

Returns

void

Implementation of

IModel.dispose

Defined in

webgi/src/core/threejs/Object3DModel.ts:123


setDirty

setDirty(e?): void

Parameters

NameType
e?AnyOptions

Returns

void

Implementation of

IModel.setDirty

Defined in

webgi/src/core/threejs/Object3DModel.ts:135


setMaterial

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

Parameters

NameType
material?IMaterial<any> | IMaterial<any>[]

Returns

IMaterial<any>[]

Implementation of

IModel.setMaterial

Defined in

webgi/src/core/threejs/Object3DModel.ts:140


setGeometry

setGeometry(geometry?, force?): undefined | BufferGeometry

returns the old geometry.

Parameters

NameTypeDefault value
geometry?BufferGeometryundefined
forcebooleanfalse

Returns

undefined | BufferGeometry

Implementation of

IModel.setGeometry

Defined in

webgi/src/core/threejs/Object3DModel.ts:154


updateBounds

updateBounds(): void

Not implemented

Returns

void

Defined in

webgi/src/core/threejs/Object3DModel.ts:173


clone

clone(): Object3DModel

Returns

Object3DModel

Defined in

webgi/src/core/threejs/Object3DModel.ts:195