RainyWeather

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

The RainyWeather class allows you to change the weather conditions in the scene to rainy weather.

scene-atmosphere

Example:

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

  map: new Map({
    basemap: "satellite",
    ground: "world-elevation"
  }),
  environment: {
    weather: {
      type: "rainy",
      cloudCover: 0.8,
      precipitation: 0.3   // autocasts as new RainyWeather({ cloudCover: 0.8, precipitation: 0.3 })
    }
  }
});

The weather visualization updates as soon as the property changes:

view.environment.weather = {
   type: "rainy",
   cloudCover: 0.4,
   precipitation: 0.3   // autocasts as new RainyWeather({ cloudCover: 0.4, precipitation: 0.3 })
}
See also:

Constructors

new RainyWeather(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
Numbermore details

Specifies the amount of cloud cover in the sky for a certain weather type.

more detailsRainyWeather
Stringmore details

The name of the class.

more detailsAccessor
Numbermore details

Specifies the amount of falling rain.

more detailsRainyWeather
Stringmore details

The type of Weather

more detailsRainyWeather

Property Details

cloudCover Number

Specifies the amount of cloud cover in the sky for a certain weather type.

Default Value:0.5
declaredClass Stringreadonly inherited

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

precipitation Number
Since: ArcGIS API for JavaScript 4.24

Specifies the amount of falling rain.

Default Value:0.5
type Stringreadonly

The type of Weather

For RainyWeather the type is always "rainy".

Method Overview

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

Creates a deep clone of this object.

more detailsRainyWeather
more details

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

more detailsAccessor

Method Details

clone(){RainyWeather}

Creates a deep clone of this object.

Returns:
Type Description
RainyWeather Creates a new clone of the instance calling this method.
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.