Class AmbientLight

An ambient light source within a View.

Has fixed color and intensity that illuminates all objects equally.
AmbientLights, DirLights and PointLights are registered by their Component.id on View.lights.

Hierarchy (View Summary)

Component
- AmbientLight

Index

Constructors

Properties

destroyed dirty id view

Accessors

color intensity

Methods

clean cleanIfDirty destroy error fromParams log setDirty toParams warn

Events

Constructors

constructor

new AmbientLight(view: View, cfg?: AmbientLightParams): AmbientLight
Parameters
- view: View
  Owner component. When destroyed, the owner will destroy this AmbientLight as well.
- cfg: AmbientLightParams = {}
  AmbientLight configuration
Returns AmbientLight
Overrides Component.constructor
- Defined in packages/sdk/src/viewer/AmbientLight.ts:35

Properties

destroyed

destroyed: boolean

True once this Component has been destroyed.

Don't use this Component if this is true.

`Protected`dirty

dirty: boolean

id

id: string

ID of this AmbientLight, unique within the View.

`Readonly`view

view: View

The View to which this AmbientLight belongs.

Accessors

color

get color(): FloatArrayParam
Gets the RGB color of this AmbientLight.

Default value is [0.7, 0.7, 0.7].

Returns FloatArrayParam
- Defined in packages/sdk/src/viewer/AmbientLight.ts:63
set color(color: FloatArrayParam): void
Sets the RGB color of this AmbientLight.

Default value is [0.7, 0.7, 0.7].
Parameters
- color: FloatArrayParam
  The AmbientLight's RGB color.
Returns void
- Defined in packages/sdk/src/viewer/AmbientLight.ts:53

intensity

get intensity(): number
Gets the intensity of this AmbientLight.

Default value is 1.0 for maximum intensity.

Returns number
The AmbientLight's intensity.
- Defined in packages/sdk/src/viewer/AmbientLight.ts:86
set intensity(intensity: number): void
Sets the intensity of this AmbientLight.

Default value is 1.0 for maximum intensity.
Parameters
- intensity: number
  The AmbientLight's intensity.
Returns void
- Defined in packages/sdk/src/viewer/AmbientLight.ts:74

Methods

`Protected`clean

clean(): void
Forces this component to action any deferred state updates.

Returns void
Inherited from Component.clean
- Defined in packages/sdk/src/core/Component.ts:119

`Protected`cleanIfDirty

cleanIfDirty(): void
Gives this component an opportunity to action any defered state updates.

Returns void
Inherited from Component.cleanIfDirty
- Defined in packages/sdk/src/core/Component.ts:109

destroy

destroy(): void
Destroys this AmbientLight.

Returns void
Overrides Component.destroy
- Defined in packages/sdk/src/viewer/AmbientLight.ts:118

`Protected`error

error(message: string): void
Protected
Logs an error for this component to the JavaScript console.

The console message will have this format: [ERROR] [<component type> =<component id>: <message>
Parameters
- message: string
  The error message to log
Returns void
Inherited from Component.error
- Defined in packages/sdk/src/core/Component.ts:95

fromParams

fromParams(ambientLightParams: AmbientLightParams): void
Configures this AmbientLight.
Parameters
- ambientLightParams: AmbientLightParams
Returns void
- Defined in packages/sdk/src/viewer/AmbientLight.ts:94

`Protected`log

log(message: string): void
Protected
Logs a message for this component.

The message will have this format: [LOG] [<component type> <component id>: <message>
Parameters
- message: string
  The message to log
Returns void
Inherited from Component.log
- Defined in packages/sdk/src/core/Component.ts:71

`Protected`setDirty

setDirty(): void
Flags this component as having a defered state updates it needs to perform.

Returns void
Inherited from Component.setDirty
- Defined in packages/sdk/src/core/Component.ts:102

toParams

toParams(): AmbientLightParams
Gets the current configuration of this AmbientLight.

Returns AmbientLightParams
- Defined in packages/sdk/src/viewer/AmbientLight.ts:106

`Protected`warn

warn(message: string): void
Protected
Logs a warning for this component to the JavaScript console.

The console message will have this format: [WARN] [<component type> =<component id>: <message>
Parameters
- message: string
  The warning message to log
Returns void
Inherited from Component.warn
- Defined in packages/sdk/src/core/Component.ts:83

Events

onDestroyed

onDestroyed: EventEmitter<Component, null>

Emits an event when the Component has been destroyed.