Class DirLight

A directional light source within a View.

Illuminates all objects equally from a given direction.
Has an emission direction vector in DirLight.dir, but no position.
Defined in either World or View coordinate space. When in World-space, DirLight.dir is relative to the World coordinate system, and will appear to move as the Camera moves. When in View-space, DirLight.dir is relative to the View coordinate system, and will behave as if fixed to the viewer's head.
AmbientLights, DirLights and PointLights are registered by their Component.id on View.lights.

Hierarchy (View Summary)

Component
- DirLight

Index

Constructors

constructor

new DirLight(view: View, options?: DirLightParams): DirLight
Parameters
- view: View
  View that owns this DirLight. When destroyed, the View will destroy this DirLight as well.
- options: DirLightParams = {}
  The DirLight configuration
  Parameters for a DirLight.
  - Returned by DirLight.toParams
  - Passed to DirLight.fromParams
  - Located at ViewParams.lights
  - Optionalcolor?: FloatArrayParam
    RGB color of the DirLight.
    
    Range is [0..1, 0..1, 0..1].
    
    Default value is [1.0, 1.0, 1.0].
  - Optionaldir?: FloatArrayParam
    3D direction of the DirLight.
    
    Range is [-1..1, -1..1, -1..1].
    
    Default value is [1.0, 1.0, 1.0].
  - Optionalid?: string
    Optional ID, generated automatically when omitted.
  - Optionalintensity?: number
    Intensity of the DirLight.
    
    Value is in range [0..1].
    
    Default value is 1.0.
  - Optionalspace?: string
    3D coordinate space in which the DirLight is oriented.
    
    Accepted value is "world" or "view".
    
    Default is "world".
Returns DirLight
Overrides Component.constructor
- Defined in packages/sdk/src/viewer/DirLight.ts:48

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

`Readonly`view

view: View

The View to which this DirLight belongs.

Accessors

color

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

Default value is [0.7, 0.7, 0.8].

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

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

dir

get dir(): FloatArrayParam
Gets the direction in which the DirLight is shining.

Default value is [1.0, 1.0, 1.0].

Returns FloatArrayParam
The direction vector.
- Defined in packages/sdk/src/viewer/DirLight.ts:68
set dir(value: FloatArrayParam): void
Sets the direction in which the DirLight is shining.

Default value is [1.0, 1.0, 1.0].
Parameters
- value: FloatArrayParam
  The direction vector.
Returns void
- Defined in packages/sdk/src/viewer/DirLight.ts:86

intensity

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

Default value is 1.0 for maximum intensity.

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

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

space

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

Returns string
- Defined in packages/sdk/src/viewer/DirLight.ts:75

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

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

`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(dirLightParams: DirLightParams): void
Configures this DirLight.

Ignores DirLightParams.space, because DirLight.space is not dynamically updatable.
Parameters
- dirLightParams: DirLightParams
Returns void
- Defined in packages/sdk/src/viewer/DirLight.ts:145

`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(): DirLightParams
Gets this DirLight's current configuration.

Returns DirLightParams
- Defined in packages/sdk/src/viewer/DirLight.ts:161

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

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Events

Constructors

constructor

Parameters

Optionalcolor?: FloatArrayParam

Optionaldir?: FloatArrayParam

Optionalid?: string

Optionalintensity?: number

Optionalspace?: string

Returns DirLight

Properties

destroyed

Protecteddirty

id

Readonlyview

Accessors

color

Returns FloatArrayParam

Parameters

Returns void

dir

Returns FloatArrayParam

Parameters

Returns void

intensity

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 DirLightParams

Protectedwarn

Parameters

Returns void

Events

onDestroyed

Settings

On This Page

`Optional`color?: FloatArrayParam

`Optional`dir?: FloatArrayParam

`Optional`id?: string

`Optional`intensity?: number

`Optional`space?: string

`Protected`dirty

`Readonly`view

`Protected`clean

`Protected`cleanIfDirty

`Protected`error

`Protected`log

`Protected`setDirty

`Protected`warn