ArcGISScene

A scene is a container for layers. You use a scene together with a SceneView 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 the scene in a SceneView.

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, the spatial reference of the first layer you add, which is typically the first layer in the Basemap, defines the spatial reference of the entire scene.

See Scenes 3D[https://developers.arcgis.com/documentation/mapping-apis-and-services/maps/scenes-3d/] for more information about scenes.

Since

200.1.0

Constructors

Link copied to clipboard
constructor()

Creates a scene.

constructor(basemap: Basemap)

Creates a scene with a Basemap.

constructor(basemapStyle: BasemapStyle)

Creates a scene with a BasemapStyle.

constructor(item: Item)

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.

constructor(tilingScheme: SceneViewTilingScheme)

Creates a scene with a specific tiling scheme. The tiling scheme determines which cached tiled services can render in the scene.

constructor(uri: String)

Creates a scene with the URL to a web scene. If the specified URL is a portal item URL, the underlying PortalItem is created and can be accessed through ArcGISScene.item. The URL may be a direct URL to web scene JSON content or the URL of a portal item.

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

Unknown data from the source JSON. Unknown JSON is a dictionary of values not defined in the ArcGIS web scene specification used to create this object but found in the source JSON. If the object is written back to JSON, any unknown JSON data is not persisted.

Link copied to clipboard

Unsupported data from the source JSON. Unsupported JSON is a dictionary of values defined in the ArcGIS web scene specification used to create this object but not currently used in this API. If the object is written back to JSON, any unsupported JSON data is persisted.

Inherited properties

Link copied to clipboard
val basemap: StateFlow<Basemap?>

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.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard
var item: Item?

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.

Link copied to clipboard

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.

Link copied to clipboard
open override val loadStatus: StateFlow<LoadStatus>

The load status.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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[https://developers.arcgis.com/web-map-specification/] or https://developers.arcgis.com/web-scene-specification/, respectively.

Functions

Link copied to clipboard
open override fun clone(): ArcGISScene

Clones the ArcGISScene.

Inherited functions

Link copied to clipboard
open override fun cancelLoad()

Cancels loading metadata for the Loadable object.

Link copied to clipboard
open suspend override fun load(): Result<Unit>

Loads the metadata for the object.

Link copied to clipboard
open suspend override fun retryLoad(): Result<Unit>

Loads or retries loading metadata for the object.

Link copied to clipboard
fun setBasemap(basemap: Basemap?)

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.