VirtualLighting

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

The VirtualLighting class allows you to change the lighting in the scene to virtual light. The position of the light follows the camera and has a slight top-right offset in respect to the camera.

scene-lightings

Example:

let view = new SceneView({
  container: "viewDiv",

  map: new Map({
    basemap: "satellite",
    ground: "world-elevation"
  }),
  environment: {
    lighting: {
      type: "virtual"    // autocasts as new VirtualLighting()
    }
  }
});

The lighting visualization updates as soon as the type property changes:

view.environment.lighting = {
   type: "virtual",
   directShadowsEnabled: true    // autocasts as new VirtualLighting({ directShadowsEnabled: true })
}
See also:

Constructors

new VirtualLighting(properties)
Parameter:
properties Object
optional

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
Booleanmore details

Indicates whether to show ambient occlusion shading.

more detailsVirtualLighting
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
Booleanmore details

Indicates whether WaterSymbol3DLayer display reflections of surrounding terrain, buildings and other 3D objects.

more detailsVirtualLighting

Property Details

ambientOcclusionEnabled Boolean

Indicates whether to show ambient occlusion shading.

Default Value:false
declaredClass Stringreadonly inherited

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

directShadowsEnabled Boolean inherited

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 inherited

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

waterReflectionEnabled Boolean

Indicates whether WaterSymbol3DLayer display reflections of surrounding terrain, buildings and other 3D objects.

Default Value:false

Method Overview

Show inherited methods Hide inherited methods
Name Return Type Summary Class
VirtualLightingmore details

Creates a deep clone of this object.

more detailsVirtualLighting
more details

Create a clone of this while partially applying the provided webscene lighting settings.

more detailsVirtualLighting
more details

Adds one or more handles which are to be tied to the lifecycle of the object.

more detailsAccessor

Method Details

Creates a deep clone of this object.

Returns:
Type Description
VirtualLighting Creates a new clone of the instance calling this method.
cloneWithWebsceneLighting()

Create a clone of this while partially applying the provided webscene lighting settings.

own(handleOrHandles)inherited
Since: ArcGIS API for JavaScript 4.24

Adds one or more handles which are to be tied to the lifecycle of the object. The handles will be removed when the object is destroyed.

// Manually manage handles
const handle = reactiveUtils.whenOnce(() => !view.updating)
  .then(() => {
    wkidSelect.disabled = false;
});

handle.remove();

// Assign a handle using own()
this.own(reactiveUtils.whenOnce(() => !view.updating)
  .then(() => {
    wkidSelect.disabled = false;
  }));
Parameter:
handleOrHandles WatchHandle|WatchHandle[]

Handles marked for removal once the object is destroyed.

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