Arc GISScene
A scene is a container for layers. You use a scene together with a SceneView or LocalSceneView to display layers of geographic data in 3D. ArcGISScene contains layers of mapping data and information such as elevation data, renderers, and labels which define the scene's capabilities. You can access ArcGISScene content directly or, more commonly, visualize a global scene in a SceneView or a local scene in a LocalSceneView depending on the SceneViewingMode.
In an MVC architecture, ArcGISScene represents the model and SceneView represents the 3D view. ArcGISScene specifies how the geographic data is organized, and SceneView renders the data on the screen and allows users to interact with it.
A scene can contain a base surface, a basemap, and one or more operational layers:
A base surface is the default surface on which layers are draped or from which relative layers are offset. The ground height is provided by ElevationSource objects that are combined to make the Surface.
A basemap is a layer that helps orient the user of the scene. It is composed of a collection of base layers, such as imagery or hillshade, that are draped on the surface, and/or reference layers such as street labels that are displayed on top of operational layers. This content is relatively static.
An operational layer provides content that is of unique interest to the app and the task at hand, such as data about earthquakes, traffic, or weather. This content can change frequently.
You can create a scene from an existing web scene using its URL or PortalItem. Alternatively, you can get a scene directly from a MobileScenePackage.scenes collection. ArcGISScene properties are hydrated when the scene is loaded.
If you create a new scene without specifying a spatial reference, the spatial reference of the first layer you add, which is typically the Basemap, defines the spatial reference of the entire scene.
See Scenes 3D for more information about scenes.
Since
200.1.0
Constructors
Creates a scene with a global SceneViewingMode.
Creates a scene with a global SceneViewingMode and the specified Basemap.
Creates a scene with a global SceneViewingMode and the specified BasemapStyle.
Creates a scene with a portal item of type PortalItemType.WebScene. The PortalItem automatically loads when the ArcGISScene loads. If the loaded Item is not a portal item of type PortalItemType.WebScene, the scene fails to load.
Creates a scene with the specified SceneViewingMode.
Creates a scene with the specified SceneViewingMode and Basemap.
Creates a scene with the specified SceneViewingMode and BasemapStyle.
Creates a scene with the specified SceneViewingMode and SpatialReference.
Creates a scene with a global SceneViewingMode and a specific tiling scheme. The tiling scheme determines which cached tiled services can render in the scene. This property does not affect scenes with a local SceneViewingMode.
Creates a scene with the URL to a web scene. The SceneViewingMode of the scene is determined from the web scene.
Properties
The base surface of the scene. The base surface is the default surface on which layers are draped or from which relative layers are offset.
The area that defines what is clipped for display. This property only applies to local scenes. It is used to define the bounds of a local scene. If defined, only data (including the basemap) inside the specified area is displayed. If the specified clipping area cannot be projected to the view's coordinate system, then no clipping area is applied to the scene and it is displayed at its original extent.
The environment that affects how the scene is displayed. This is populated from the webscene or MobileScenePackage (if configured), otherwise a default constructed SceneEnvironment is applied. Setting this property before loading the scene overrides any initial environment settings specified by a predefined scene.
True if clipping is enabled, false otherwise. This property only applies to local scenes. It determines whether clipping using the ArcGISScene.clippingArea is enabled. If the clipping area is null and this property is true then nothing is clipped. The default value is false.
The tiling scheme defines how tile based data is rendered. The tiling scheme property is used by the SceneView to determine how to render tiled data.
The viewing mode of the scene, either global or local. The viewing mode is specified via the constructor or deserialized from the web scene or MobileScenePackage.
Inherited properties
Optional layers in a map or scene that show background information—roads, landmarks, and so on—to help orient the user of the map or scene. Typically image tile or vector tile layer types. Basemaps can be composed of different layers organized in Basemap.baseLayers (displayed beneath other layers) and Basemap.referenceLayers (displayed on top of other layers). You can use ready-to-use basemaps, style your own with the ArcGIS Vector Tile Style Editor, or create and publish your own with ArcGIS Pro.
The collection of bookmarks defined for this map or scene. Bookmarks allow users to quickly navigate to a particular area of interest in a map or scene.
Defines the properties that allow a map or a scene to be floor-aware. Floor-aware maps and scenes contain data representing floor plan and indoor features. The data displayed by floor-aware maps and scenes can be filtered based on floor levels using the FloorManager. This property is null for maps or scenes that are not floor-aware.
Manages the data displayed for a floor-aware map or scene, allowing filtering based on floor levels. A FloorManager must be loaded before you can access its site, facility, and level properties, and perform floor filtering.
Information about the set of Geotrigger objects defined for the map or scene. You must load the GeotriggersInfo to populate the collection with any geotriggers defined by the author of the map or scene. If no geotriggers are defined this list will remain empty.
The initial viewpoint when the map or scene is first displayed. The initial viewpoint value is available when the map or scene is loaded. If you want to change the initial viewpoint, you can do this before you add the map or scene to a GeoView. At this point, the GeoView's viewpoint is set to this initial viewpoint. Any subsequent changes to the GeoModel.initialViewpoint are ignored.
The ArcGIS item associated with this map or scene. This can be a PortalItem (for web maps and web scenes loaded from a portal or saved to a portal), or a LocalItem (for maps in a map package or scenes in a scene package), or null if no Item is associated with this map or scene.
The properties that control the default loading and rendering behavior of feature layers in this map or scene. For example, you can specify which tiling mode should be used when feature layers are added, or specify whether feature tables should use advanced symbology.
The load status.
A collection of layers that can access geographic data from a file or a service. The operational layers collection is used to display geographic data layers on top of a basemap layer in an ArcGISMap or ArcGISScene. For example, you can display a fleet of vehicles being tracked on a map or display a point cloud layer of a tree canopy in a scene.
The spatial reference for this map or scene. SpatialReference specifies how geometry coordinates relate to real-world space. It ensures that you can accurately view, query, and analyze the layers of a map or scene.
A collection of feature tables in the map or scene. Unlike GeoModel.operationalLayers, tables are not displayed by the GeoView. The collection of feature tables is specific to the map or scene. You can add and remove tables by adding or removing them from the collection.
A collection of transportation network datasets defined for the map or scene. Map and scene authors can use ArcGIS Pro to create mobile map or scene packages that include transportation networks. If the map or scene is created from one of these packages, this collection will be populated with a read-only collection of TransportationNetworkDataset objects.
Data from the source JSON that the API did not make use of. Unused JSON stores the input data that is not currently used in this API. If the object is written back to JSON, all unused JSON data is persisted.
The version of the ArcGISMap or ArcGISScene when it is loaded. The version of a newly created ArcGISMap or ArcGISScene is empty. When you load an existing map or scene, the version value is the version that it was created at, according to the [ESRI web map specification or ESRI web scene specification, respectively.
Functions
Clones the ArcGISScene.
Inherited functions
Cancels loading metadata for the Loadable object.
Optional layers in a map or scene that show background information — roads, landmarks, and so on — to help orient the user of the map or scene. Typically image tile or vector tile layer types. Basemaps can be composed of different layers organized in Basemap.baseLayers (displayed beneath other layers) and {@link Basemap.referenceLayers (displayed on top of other layers). You can use ready-to-use basemaps, style your own with the ArcGIS Vector Tile Style Editor, or create and publish your own with ArcGIS Pro.