ArcGISScene

class ArcGISScene : GeoModel

The scene contains layers and additional properties and can be displayed in a SceneView.

Constructors

Link copied to clipboard
fun ArcGISScene()

Creates a scene.

Link copied to clipboard
fun ArcGISScene(basemap: Basemap)

Create a scene with basemap.

Link copied to clipboard
fun ArcGISScene(basemapStyle: BasemapStyle)

Creates a scene with a basemap style.

Link copied to clipboard
fun ArcGISScene(item: Item)

Create a scene with an item.

Link copied to clipboard
fun ArcGISScene(tilingScheme: SceneViewTilingScheme)

Create a scene with a specific tiling scheme. Use this method to create a Scene object with a specific tiling scheme. The tiling scheme determines which cached tiled services can render in the Scene.

Link copied to clipboard
fun ArcGISScene(uri: String)

Create a scene with a URI. If the specified URI is a portal item URL (see PortalItem.PortalItem(String) for the supported URL formats), the underlying PortalItem will be created and accessible through ArcGISScene.getItem().

Types

Link copied to clipboard
object Companion

Functions

Link copied to clipboard
open override fun cancelLoad()

Cancels loading metadata for the Loadable object.

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

Clones the ArcGISScene.

Link copied to clipboard
fun equals(otherGeoModel: GeoModel): Boolean

Tests if this object is equal to a second GeoModel 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.

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
var baseSurface: Surface
Link copied to clipboard
val bookmarks: MutableList<Bookmark>
Link copied to clipboard
var floorDefinition: GeoModelFloorDefinition?
Link copied to clipboard
val floorManager: FloorManager?
Link copied to clipboard
val geotriggersInfo: GeotriggersInfo
Link copied to clipboard
var initialViewpoint: Viewpoint?
Link copied to clipboard
var item: Item?
Link copied to clipboard
var loadSettings: LoadSettings
Link copied to clipboard
open override val loadStatus: StateFlow<LoadStatus>

The load status.

Link copied to clipboard
val operationalLayers: MutableList<Layer>
Link copied to clipboard
val sceneViewTilingScheme: SceneViewTilingScheme

The SceneViewTilingScheme as used to render tile based data. The default value is SceneViewTilingScheme.WebMercator. The tiling scheme property is used by the SceneView to determine how to render tiled data. If this property was not set in advance of loading the scene it will be determined during the GeoModel.load(). This will examine the SpatialReference of the first tiled elevation source (see ArcGISTiledElevationSource) or tiled layer in the basemap or operational layers (see ArcGISTiledLayer) to choose either SceneViewTilingScheme.Geographic or SceneViewTilingScheme.WebMercator values. The SceneViewTilingScheme must correspond to the SpatialReference for those layers to render correctly.

Link copied to clipboard
val spatialReference: SpatialReference?
Link copied to clipboard
val tables: MutableList<FeatureTable>
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 containing maps and scenes that include transportation networks. If so, this property will be populated with the collection of TransportationNetworkDataset objects.

Link copied to clipboard
val unknownJson: Map<String, Any>
Link copied to clipboard
val unsupportedJson: Map<String, Any>
Link copied to clipboard
val version: String

The version of the ArcGISMap or ArcGISScene when it is loaded. The version of a newly created ArcGISMap or ArcGISScene is empty. The version that the map or scene is saved to might differ from the version it was opened at. The version saved depends on the version of the API.