FoggyWeather

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

The FoggyWeather class allows you to change the weather conditions in the scene to foggy weather.

scene-atmosphere

Example:

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

  map: new Map({
    basemap: "satellite",
    ground: "world-elevation"
  }),
  environment: {
    weather: {
      type: "foggy",
      fogStrength: 0.8      // autocasts as new FoggyWeather({ fogStrength: 0.8 })
    }
  }
});

The weather visualization updates as soon as the property changes:

view.environment.weather = {
   type: "foggy",
   fogStrength: 0.4   // autocasts as new FoggyWeather({ fogStrength: 0.4 })
}
See also

Constructors

new FoggyWeather(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
Number

Specifies the amount of fog used in the scene.

more details
FoggyWeather
String

The type of Weather

more details
FoggyWeather

Property Details

declaredClass Stringreadonly inherited

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

fogStrength Number

Specifies the amount of fog used in the scene.

Default Value:0.5
type Stringreadonly

The type of Weather

For FoggyWeather the type is always "foggy".

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
FoggyWeather

Creates a deep clone of this object.

more details
FoggyWeather
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 Maps SDK 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(){FoggyWeather}

Creates a deep clone of this object.

Returns
Type Description
FoggyWeather Creates a new clone of the instance calling this method.
hasHandles(groupKey){Boolean}inherited
Since: ArcGIS Maps SDK 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 Maps SDK 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.