AMD: require(["esri/webscene/VirtualLighting"], (VirtualLighting) => { /* code goes here */ });
ESM: import VirtualLighting from "@arcgis/core/webscene/VirtualLighting";
Class: esri/webscene/VirtualLighting
Inheritance: VirtualLighting Accessor
Subclasses: VirtualLighting
Since: ArcGIS API for JavaScript 4.24

The virtual lighting object is part of the webscene/Environment and contains information relating to how a SceneView is lit with a virtual light. This class contains all properties which can be persisted in a esri/Webscene.

See also:


new VirtualLighting(properties)
properties Object

See the properties for a list of all the properties that may be passed into the constructor.

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
Show inherited properties Hide inherited properties
Name Type Summary Class
Stringmore details

The name of the class.

more detailsAccessor
Booleanmore details

Indicates whether to show shadows cast by the light source.

more detailsVirtualLighting
Stringmore details

Indicates that the light source is virtual light.

more detailsVirtualLighting

Property Details

declaredClass Stringreadonly inherited

The name of the class. The declared class name is formatted as esri.folder.className.

directShadowsEnabled Boolean

Indicates whether to show shadows cast by the light source. Shadows are only displayed for real world 3D objects. Terrain doesn't cast shadows. In local scenes at small zoom levels, shadows are not displayed. For more control on which 3D objects cast shadows use the castShadows property available on ObjectSymbol3DLayer, FillSymbol3DLayer, ExtrudeSymbol3DLayer, and PathSymbol3DLayer.

Default Value:false
type Stringreadonly

Indicates that the light source is virtual light. Virtual light is top - right position respect to the camera enabling user to observe the scene independant to the possition of the sun.

For VirtualLighting the type is always "virtual".

Method Overview

Name Return Type Summary Class
VirtualLightingmore details

Creates a deep clone of this object.

more detailsVirtualLighting

Method Details


Creates a deep clone of this object.

Type Description
VirtualLighting Creates a new clone of the instance calling this method.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.