Interface: ILight<TLight>
Core-API.ILight
Type parameters
| Name | Type |
|---|---|
TLight | any |
Hierarchy
Omit<IModel<TLight>,"assetType">↳
ILight
Implemented by
Methods
addEventListener
▸ addEventListener(type, listener): void
Adds a listener to an event type.
Parameters
| Name | Type | Description |
|---|---|---|
type | string | The type of event to listen to. |
listener | (event: IEvent<string>) => void | The function that gets called when the event is fired. |
Returns
void
Inherited from
Omit.addEventListener
Defined in
webgi/src/helpers/EventDispatcher.ts:14
hasEventListener
▸ hasEventListener(type, listener): boolean
Checks if listener is added to an event type.
Parameters
| Name | Type | Description |
|---|---|---|
type | string | The type of event to listen to. |
listener | (event: IEvent<string>) => void | The function that gets called when the event is fired. |
Returns
boolean
Inherited from
Omit.hasEventListener
Defined in
webgi/src/helpers/EventDispatcher.ts:21
removeEventListener
▸ removeEventListener(type, listener): void
Removes a listener from an event type.
Parameters
| Name | Type | Description |
|---|---|---|
type | string | The type of the listener that gets removed. |
listener | (event: IEvent<string>) => void | The listener function that gets removed. |
Returns
void
Inherited from
Omit.removeEventListener
Defined in
webgi/src/helpers/EventDispatcher.ts:28
dispatchEvent
▸ dispatchEvent(event): void
Fire an event type.
Parameters
| Name | Type |
|---|---|
event | IEvent<string> |
Returns
void
Inherited from
Omit.dispatchEvent
Defined in
webgi/src/helpers/EventDispatcher.ts:34
dispose
▸ Optional dispose(): void
Returns
void
Inherited from
Omit.dispose
Defined in
setMaterial
▸ Optional setMaterial(material): IMaterial<any>[]
Parameters
| Name | Type |
|---|---|
material | undefined | IMaterial<any> | IMaterial<any>[] |
Returns
IMaterial<any>[]
Inherited from
Omit.setMaterial
Defined in
setGeometry
▸ Optional setGeometry(geometry, force?): any
returns the old geometry.
Parameters
| Name | Type |
|---|---|
geometry | any |
force? | boolean |
Returns
any
Inherited from
Omit.setGeometry
Defined in
setDirty
▸ Optional setDirty(options?): void
Parameters
| Name | Type |
|---|---|
options? | AnyOptions |
Returns
void
Inherited from
Omit.setDirty
Defined in
toJSON
▸ toJSON(meta?): any
Parameters
| Name | Type |
|---|---|
meta? | any |
Returns
any
Inherited from
Defined in
fromJSON
▸ fromJSON(data, meta?): null | ILight<TLight> | Promise<null | ILight<TLight>>
Parameters
| Name | Type |
|---|---|
data | any |
meta? | any |
Returns
null | ILight<TLight> | Promise<null | ILight<TLight>>
Inherited from
Defined in
Properties
name
• name: string
Inherited from
Omit.name
Defined in
uuid
• Readonly uuid: string
Inherited from
Omit.uuid
Defined in
visible
• visible: boolean
Inherited from
Omit.visible
Defined in
modelObject
• modelObject: TLight
Internal three.js Object3D instance (like Mesh, Group, etc)
Inherited from
Omit.modelObject
Defined in
material
• Optional Readonly material: IMaterial<any> | IMaterial<any>[]
Use setMaterial to change the material
Get one or more materials applied to an object
Inherited from
Omit.material
Defined in
geometry
• Optional Readonly geometry: any
Inherited from
Omit.geometry
Defined in
userData
• userData: any
Inherited from
Omit.userData
Defined in
assetType
• assetType: "light"
Defined in
lightObject
• lightObject: TLight
Defined in
uiConfig
• Optional uiConfig: UiObjectConfig<any, string>