VirtualLighting

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

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
String

The name of the class.

more details
Accessor
Boolean

Indicates whether to show shadows cast by the light source.

more details
VirtualLighting
String

Indicates that the light source is virtual light.

more details
VirtualLighting

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

Show inherited methods Hide inherited methods
Name Return Type Summary Class

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

more details
Accessor
VirtualLighting

Creates a deep clone of this object.

more details
VirtualLighting
Boolean

Returns true if a named group of handles exist.

more details
Accessor

Removes a group of handles owned by the object.

more details
Accessor

Method Details

addHandles(handleOrHandles, groupKey)inherited
Since: ArcGIS API for JavaScript 4.25

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.when(
  () => !view.updating,
  () => {
    wkidSelect.disabled = false;
  },
  { once: true }
);

// Handle gets removed when the object is destroyed.
this.addHandles(handle);
Parameters
handleOrHandles WatchHandle|WatchHandle[]

Handles marked for removal once the object is destroyed.

groupKey *
optional

Key identifying the group to which the handles should be added. All the handles in the group can later be removed with Accessor.removeHandles(). If no key is provided the handles are added to a default group.

clone(){VirtualLighting}

Creates a deep clone of this object.

Returns
Type Description
VirtualLighting Creates a new clone of the instance calling this method.
hasHandles(groupKey){Boolean}inherited
Since: ArcGIS API for JavaScript 4.25

Returns true if a named group of handles exist.

Parameter
groupKey *
optional

A group key.

Returns
Type Description
Boolean Returns true if a named group of handles exist.
Example
// Remove a named group of handles if they exist.
if (obj.hasHandles("watch-view-updates")) {
  obj.removeHandles("watch-view-updates");
}
removeHandles(groupKey)inherited
Since: ArcGIS API for JavaScript 4.25

Removes a group of handles owned by the object.

Parameter
groupKey *
optional

A group key or an array or collection of group keys to remove.

Example
obj.removeHandles(); // removes handles from default group

obj.removeHandles("handle-group");
obj.removeHandles("other-handle-group");

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