SunLighting

A lighting type where the position of the light is set to simulate the sun's location.

Since

300.0.0

See also

Constructors

Link copied to clipboard
constructor(simulatedDate: Instant, areDirectShadowsEnabled: Boolean)

Creates a sun lighting for lighting a scene. Shadows cast by the terrain are not supported. Enabling shadows can impact rendering performance, depending on the amount of data in the scene.

Properties

Link copied to clipboard

The preferred time zone authored with the web scene. This offset is not applied to the SunLighting.simulatedDate property. The offset can be used to adjust the date to the preferred time zone in the UI. If the offset is null, then no preferred time zone was defined for the web scene, and the user can adjust the date to the time zone of their choice.

Link copied to clipboard

The current date and time of the simulated sun in UTC.

Inherited properties

Link copied to clipboard

True if shadows cast by the main light source should be shown, false otherwise. Shadows cast by the terrain are not supported. Enabling shadows can impact rendering performance, depending on the amount of data in the scene. The default value is false.