ArcGISScene class final

A scene is a container for layers. You use a scene together with an ArcGISSceneViewController or ArcGISLocalSceneViewController 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 an ArcGISSceneViewController or a local scene in an ArcGISLocalSceneViewController depending on the SceneViewingMode.

In an MVC architecture, ArcGISScene represents the model and ArcGISSceneViewController represents the 3D view. ArcGISScene specifies how the geographic data is organized, and ArcGISSceneViewController 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.

Inheritance

Constructors

ArcGISScene()
Creates a scene with a global SceneViewingMode.
factory
ArcGISScene.withBasemap(Basemap basemap)
Creates a scene with a global SceneViewingMode and the specified Basemap.
factory
ArcGISScene.withBasemapStyle(BasemapStyle basemapStyle)
Creates a scene with a global SceneViewingMode and the specified BasemapStyle.
factory
ArcGISScene.withItem(Item item)
Creates a scene with a portal item of type PortalItemType.webScene.
factory
ArcGISScene.withTilingScheme(SceneViewTilingScheme tilingScheme)
Creates a scene with a global SceneViewingMode and a specific tiling scheme.
factory
ArcGISScene.withViewingMode(SceneViewingMode viewingMode)
Creates a scene with the specified SceneViewingMode.
factory
ArcGISScene.withViewingModeAndBasemap({required SceneViewingMode viewingMode, required Basemap basemap})
Creates a scene with the specified SceneViewingMode and Basemap.
factory
ArcGISScene.withViewingModeAndBasemapStyle({required SceneViewingMode viewingMode, required BasemapStyle basemapStyle})
Creates a scene with the specified SceneViewingMode and BasemapStyle.
factory
ArcGISScene.withViewingModeAndSpatialReference({required SceneViewingMode viewingMode, required SpatialReference spatialReference})
Creates a scene with the specified SceneViewingMode and SpatialReference.
factory

Properties

basemap ↔ Basemap?
The basemap for this map or scene.
getter/setter pairinherited
baseSurface ↔ Surface
The base surface of the scene.
getter/setter pair
bookmarks → List<Bookmark>
The collection of bookmarks defined for this map or scene.
no setterinherited
clippingArea ↔ Envelope?
The area that defines what is clipped for display.
getter/setter pair
environment ↔ SceneEnvironment
The environment that affects how the scene is displayed.
getter/setter pair
geotriggersInfo → GeotriggersInfo
Information about the set of Geotrigger objects defined for the map or scene.
no setterinherited
hashCode → int
The hash code for this object.
no setterinherited
initialViewpoint ↔ Viewpoint?
The initial viewpoint when the map or scene is first displayed.
getter/setter pairinherited
isClippingEnabled ↔ bool
True if clipping is enabled, false otherwise.
getter/setter pair
item → Item?
The ArcGIS item associated with this map or scene.
no setterinherited
loadError → ArcGISException?
The load error.
no setterinherited
loadSettings ↔ LoadSettings
The properties that control the default loading and rendering behavior of feature layers in this map or scene.
getter/setter pairinherited
loadStatus → LoadStatus
The load status.
no setterinherited
onBasemapChanged → Stream<Basemap?>
Callback invoked when the basemap changes.
no setterinherited
onLoadStatusChanged → Stream<LoadStatus>
A stream that reports changes to the LoadStatus.
no setterinherited
operationalLayers → List<Layer>
A collection of layers that can access geographic data from a file or a service.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
sceneViewTilingScheme → SceneViewTilingScheme
The tiling scheme defines how tile based data is rendered.
no setter
spatialReference → SpatialReference?
The spatial reference for this map or scene.
no setterinherited
tables → List<FeatureTable>
A collection of feature tables in the map or scene. Unlike GeoModel.operationalLayers, tables are not displayed by the GeoViewController.
no setterinherited
transportationNetworks → List<TransportationNetworkDataset>
A collection of transportation network datasets defined for the map or scene.
no setterinherited
unusedJson → String
Data from the source JSON that the API did not make use of.
no setterinherited
version → String
The version of the ArcGISMap or ArcGISScene when it is loaded. The version of a newly created ArcGISMap or ArcGISScene is empty.
no setterinherited
viewingMode → SceneViewingMode
The viewing mode of the scene, either global or local.
no setter

Methods

cancelLoad() → void
Cancels loading metadata for the object.
inherited
clone() → GeoModel
Clones this instance of GeoModel and its members.
inherited
load() → Future<void>
Loads the metadata for the object asynchronously.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
retryLoad() → Future<void>
Loads or retries loading metadata for the object asynchronously.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

fromJson(String json) → ArcGISScene?
Creates a scene from JSON.
withUri(Uri uri) → ArcGISScene?
Creates a scene with the URL to a web scene.