Class PointLight

A positional light source within a View.

Originates from a single point and spreads outward in all directions, with optional attenuation over distance.
Has a position in PointLight.pos, but no direction.
Defined in either World or View coordinate space. When in World-space, PointLight.pos is relative to the World coordinate system, and will appear to move as the Camera moves. When in View-space, PointLight.pos is relative to the View coordinate system, and will behave as if fixed to the viewer's head.
Has PointLight.constantAttenuation, PointLight.linearAttenuation and PointLight.quadraticAttenuation factors, which indicate how intensity attenuates over distance.
AmbientLights, PointLights and PointLights are registered by their Component.id on View.lights.

Hierarchy (View Summary)

Component
- PointLight

Index

Constructors

constructor

new PointLight(view: View, cfg?: PointLightParams): PointLight
Parameters
- view: View
  View that owns this PointLight. When destroyed, the View will destroy this PointLight as well.
- cfg: PointLightParams = {}
  The PointLight configuration
Returns PointLight
Overrides Component.constructor
- Defined in packages/sdk/src/viewer/PointLight.ts:47

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 PointLight, unique within the View.

`Readonly`view

view: View

The View to which this PointLight belongs.

Accessors

color

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

Default value is [0.7, 0.7, 0.8].

Returns FloatArrayParam
The PointLight's RGB color.
- Defined in packages/sdk/src/viewer/PointLight.ts:108
set color(color: FloatArrayParam): void
Sets the RGB color of this PointLight.

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

constantAttenuation

get constantAttenuation(): number
Gets the constant attenuation factor for this PointLight.

Default value is 0.

Returns number
The constant attenuation factor.
- Defined in packages/sdk/src/viewer/PointLight.ts:157
set constantAttenuation(value: number): void
Sets the constant attenuation factor for this PointLight.

Default value is 0.
Parameters
- value: number
  The constant attenuation factor.
Returns void
- Defined in packages/sdk/src/viewer/PointLight.ts:168

intensity

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

Default value is 1.0 for maximum intensity.

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

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

linearAttenuation

get linearAttenuation(): number
Gets the linear attenuation factor for this PointLight.

Default value is 0.

Returns number
The linear attenuation factor.
- Defined in packages/sdk/src/viewer/PointLight.ts:180
set linearAttenuation(value: number): void
Sets the linear attenuation factor for this PointLight.

Default value is 0.
Parameters
- value: number
  The linear attenuation factor.
Returns void
- Defined in packages/sdk/src/viewer/PointLight.ts:191

pos

get pos(): FloatArrayParam
Gets the position of this PointLight.

This will be either World- or View-space, depending on the value of PointLight.space.

Default value is [1.0, 1.0, 1.0].

Returns FloatArrayParam
The position.
- Defined in packages/sdk/src/viewer/PointLight.ts:83
set pos(pos: FloatArrayParam): void
Sets the position of this PointLight.

This will be either World- or View-space, depending on the value of PointLight.space.

Default value is [1.0, 1.0, 1.0].
Parameters
- pos: FloatArrayParam
  The position.
Returns void
- Defined in packages/sdk/src/viewer/PointLight.ts:96

quadraticAttenuation

get quadraticAttenuation(): number
Gets the quadratic attenuation factor for this PointLight.

Default value is 0.

Returns number
The quadratic attenuation factor.
- Defined in packages/sdk/src/viewer/PointLight.ts:203
set quadraticAttenuation(value: number): void
Sets the quadratic attenuation factor for this PointLight.

Default value is 0.
Parameters
- value: number
  The quadratic attenuation factor.
Returns void
- Defined in packages/sdk/src/viewer/PointLight.ts:214

space

get space(): string
The coordinate system the PointLight is defined in - "view" or "space".

Returns string
- Defined in packages/sdk/src/viewer/PointLight.ts:70

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 PointLight.

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

`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(pointLightParams: PointLightParams): void
Configures this PointLight.

Ignores PointLightParams.space, because PointLight.space is not dynamically updatable.
Parameters
- pointLightParams: PointLightParams
Returns void
- Defined in packages/sdk/src/viewer/PointLight.ts:227

`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(): PointLightParams
Gets the current configuration of this PointLight.

Returns PointLightParams
- Defined in packages/sdk/src/viewer/PointLight.ts:243

`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.

Class PointLight

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Events

Constructors

constructor

Parameters

Returns PointLight

Properties

destroyed

Protecteddirty

id

Readonlyview

Accessors

color

Returns FloatArrayParam

Parameters

Returns void

constantAttenuation

Returns number

Parameters

Returns void

intensity

Returns number

Parameters

Returns void

linearAttenuation

Returns number

Parameters

Returns void

pos

Returns FloatArrayParam

Parameters

Returns void

quadraticAttenuation

Returns number

Parameters

Returns void

space

Returns string

Methods

Protectedclean

Returns void

ProtectedcleanIfDirty

Returns void

destroy

Returns void

Protectederror

Parameters

Returns void

fromParams

Parameters

Returns void

Protectedlog

Parameters

Returns void

ProtectedsetDirty

Returns void

toParams

Returns PointLightParams

Protectedwarn

Parameters

Returns void

Events

onDestroyed

Settings

On This Page

`Protected`dirty

`Readonly`view

`Protected`clean

`Protected`cleanIfDirty

`Protected`error

`Protected`log

`Protected`setDirty

`Protected`warn