Environment
require(["esri/webscene/Environment"], function(Environment) { /* code goes here */ });esri/webscene/EnvironmentRepresents settings that affect the environment in which the WebScene is displayed (such as lighting). It is part of the initial state of the WebScene as well as slides in the presentation.
- See also:
Constructors
- new Environment(properties)
- Parameter:properties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
| Name | Type | Summary | Class | |
|---|---|---|---|---|
| Boolean | Specifies whether the atmosphere should be displayed. more details | more details | Environment | |
| Background | Specifies how the background of the scene (which lies behind sky, stars and atmosphere) should be displayed. more details | more details | Environment | |
| String | The name of the class. more details | more details | Accessor | |
| Lighting | Settings for defining the lighting of the scene. more details | more details | Environment | |
| Boolean | Specifies whether stars should be displayed in the sky. more details | more details | Environment |
Property Details
- atmosphereEnabled Boolean
Specifies whether the atmosphere should be displayed. Typically this consists of haze and sky.
- Default Value:true
- background Backgroundautocast
Specifies how the background of the scene (which lies behind sky, stars and atmosphere) should be displayed. The default value of
nulldisplays a single, fully opaque, black color.- Default Value:null
- Since: ArcGIS API for JavaScript 4.7
The name of the class. The declared class name is formatted as
esri.folder.className.
Settings for defining the lighting of the scene.
- starsEnabled Boolean
Specifies whether stars should be displayed in the sky.
- Default Value:true
Method Overview
| Name | Return Type | Summary | Class | |
|---|---|---|---|---|
| Environment | Creates a deep clone of this object. more details | more details | Environment |
Method Details
- clone(){Environment}
Creates a deep clone of this object.
Returns:Type Description Environment Creates a deep clone of the instance calling this method.