Skip to main content

Interface: ILight<TLight>

Core-API.ILight

Type parameters

NameType
TLightany

Hierarchy

Implemented by

Properties

name

name: string

Inherited from

Omit.name


uuid

Readonly uuid: string

Inherited from

Omit.uuid


visible

visible: boolean

Inherited from

Omit.visible


modelObject

modelObject: TLight

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

Inherited from

Omit.modelObject


material

Optional Readonly material: IMaterial<any, IMaterialEventMap> | IMaterial<any, IMaterialEventMap>[]

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

Inherited from

Omit.material


geometry

Optional Readonly geometry: any

Inherited from

Omit.geometry


userData

userData: any

Inherited from

Omit.userData


assetType

assetType: "light"


lightObject

lightObject: TLight


uiConfig

Optional uiConfig: UiObjectConfig<any, string>

Inherited from

IUiConfigContainer.uiConfig

Methods

setMaterial

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

Parameters

NameType
materialundefined | IMaterial<any, IMaterialEventMap> | IMaterial<any, IMaterialEventMap>[]

Returns

IMaterial<any, IMaterialEventMap>[]

Inherited from

Omit.setMaterial


setGeometry

Optional setGeometry(geometry, force?): any

returns the old geometry.

Parameters

NameType
geometryany
force?boolean

Returns

any

Inherited from

Omit.setGeometry


setDirty

Optional setDirty(options?): void

Parameters

NameType
options?AnyOptions

Returns

void

Inherited from

Omit.setDirty