SolarLight Class

Describes the solar directional light associated with a LightSettings.

see SolarLightProps.

Methods

Name Description
constructor(json?: SolarLightProps): SolarLight    
clone(changedProps?: SolarLightProps): SolarLight Create a copy of this SolarLight, identical except in any properties explicitly specified by changedProps, with a possible exception for SolarLight.timePoint.  
equals(rhs: SolarLight): boolean    
toJSON(): undefined | SolarLightProps    

Properties

Name Type Description
alwaysEnabled Readonly boolean If true, the light will be applied even when shadows are turned off for the view.  
direction Readonly Readonly<Vector3d> Direction of the light in world coordinates.  
intensity Readonly number Intensity of the light, typically in [0..1] but can range up to 5.  
timePoint Readonly undefined | number If defined, the time in UNIX milliseconds from which SolarLight.direction was calculated.  

Defined in

Last Updated: 12 June, 2024