ArcGISSceneLayer

A layer to visualize data from an ArcGIS scene service or a local scene package. Scene layers display content from a scene service or a scene package.

ArcGISSceneLayer optimized to displaying large amounts of data in a SceneView. It can display data published as scene services, scene layer packages (.slpk), and scene layers in mobile scene packages (.mspk).

ArcGISSceneLayer supports:

  • 3D Object (e.g. buildings)

  • Integrated mesh (e.g. buildings, trees, and elevation) (see IntegratedMeshLayer)

  • Point features (e.g. trees)

The scene layer complies with the Indexed 3D Scene layer (I3S)[https://github.com/esri/i3s-spec] format. It is an open 3D content delivery format used to disseminate 3D GIS data to mobile, web, and desktop clients.

Functional characteristics

  • 3D object — 3D object scene layers contain objects explicitly modeled in three dimensions and are used to represent objects such as buildings. These features have attributes and can be identified. See the 3D Object Scene Layer[https://pro.arcgis.com/en/pro-app/latest/help/mapping/layer-properties/the-3d-objects-scene-layer-in-arcgis-pro.htm] for more information.

  • Integrated mesh — 3D mesh data is typically captured by an automated process for constructing 3D objects out of large sets of overlapping imagery. The result integrates the original input image information as a textured mesh including 3D objects, such as buildings and trees, and elevation information. Integrated mesh scene layers are often created for citywide 3D mapping. They can represent something as small as a single building or as large as a city or state. They are often assembled automatically from imagery collected by a drone; they cannot be restyled because there is no underlying feature data. See the Integrated Mesh Scene Layer[https://pro.arcgis.com/en/pro-app/latest/help/mapping/layer-properties/the-integrated-mesh-scene-layer-in-arcgis-pro.htm] for more information.

  • Point features — To ensure fast visualization, cached scene layers are used to display large amounts of 3D point data about individual features, such as all the trees in a city. Point scene layers have features that can be identified and that have attributes that may be cached or available from an associated feature layer. The display of point scene layers is automatically thinned to improve performance and visibility at smaller scales and longer distances. Automatic thinning means that not all features are displayed at small scales; as you zoom in, additional features are displayed. See the Point scene layer[https://pro.arcgis.com/en/pro-app/latest/help/mapping/layer-properties/the-point-scene-layer-in-arcgis-pro.htm] for more information.

Point scene layers are generated from point feature layers. Point scene layers can be generated by ArcGIS Pro and hosted as a scene service or scene layer package.

Note: When publishing a scene from ArcGIS Pro (sharing as a web scene) any point feature layers in the 3D Layers section of the contents pane will be published as a scene service. The scene service will be referenced within the web scene.

Performance characteristics

For a scene layer, the rendering of 3D data is based on the current level of detail (LOD), which is determined by the distance from the camera. Each object in a 3D object service is represented differently at various LODs determined by the camera distance. As the camera distance changes in the scene, objects will be displayed appropriately for the current LOD. This results in good client performance and low memory usage, at the expense of frequently loading and unloading objects.

Since

200.1.0

See also

Constructors

Link copied to clipboard
constructor(item: Item)

Creates an ArcGIS scene layer from a PortalItem representing an ArcGIS scene service. The item's type should be PortalItemType.SceneService.

constructor(uri: String)

Creates an ArcGIS scene layer from the specified URI. If the specified URI is a portal item URL, the item's type should be PortalItemType.SceneService. The underlying PortalItem can be accessed through Layer.item.

Properties

Link copied to clipboard

The layer altitude offset. This raises or lowers all features in the scene layer by the given offset.

Link copied to clipboard

The type of data contained in an ArcGIS scene layer, such as integrated mesh or 3D scene objects. This can only be established once the scene layer has loaded.

Link copied to clipboard

The feature table associated with this layer.

Link copied to clipboard

True if labels should be displayed, false otherwise. Note that this property is only supported for SceneLayerDataType.Point layers.

Link copied to clipboard

A filter applied to a feature-based ArcGISSceneLayer to include or exclude features within the polygons.

Link copied to clipboard

Specifies how the 3D objects or point features in the layer are symbolized. Only SimpleRenderer, UniqueValueRenderer, and ClassBreaksRenderer are currently supported for ArcGISSceneLayer. If the renderer provided is not one of these supported renderer types, then a 3D object scene layer draws the original textures while a point scene layer does not draw. A LayerViewState that contains an error indicating the use of an unsupported renderer is also raised on the SceneView.

Link copied to clipboard

The surface placement specifies how the layer's data should be placed in relation to the scene's surface.

Link copied to clipboard
val uri: String?

The URL of an ArcGIS scene service or the path to a local scene layer package (.slpk) file. The URI is available after the layer has successfully loaded.

Inherited properties

Link copied to clipboard
open override var apiKey: ApiKey?

The API key allows your app to access ArcGIS location services and private portal items. An API key is a unique long-lived access token that is used to authenticate and monitor requests to ArcGIS location services and private portal items. You can create and manage an API key using your portal when you sign in with an ArcGIS Location Platform account or an ArcGIS Online account with administrator access or a custom role that has the Generate API keys privilege. To learn how to create and manage API keys, go to the Create an API Key tutorial. You must ensure that your API key has the correct privileges to access secure resources.

Link copied to clipboard

The attribution text for the layer.

Link copied to clipboard
open override val canChangeVisibility: Boolean

A flag indicating whether the layer content's visibility can be changed. A flag indicating whether the layer content visibility can be changed. Will return false if an error occurs.

Link copied to clipboard

The description for the layer.

Link copied to clipboard

Defines the properties that allow a layer to be floor-aware. When a layer is configured as floor-aware, it has a FloorAware.floorDefinition property that defines properties that allow a layer to be floor-aware. When it is null (default value) the specific layer does not support floor filtering.

Link copied to clipboard

The full extent of this layer, which is the extent where all layer data is contained. You can use this to zoom to all of the data contained in this layer. For feature layers, the extent is retrieved from its FeatureTable.extent.

Link copied to clipboard
var id: String

The unique identifying string for the layer, as specified in a map or scene. The id is used by other parts of this API to refer to a specific Layer, such as in a set of FeatureFenceParameters or a FacilityLayerDefinition. If not supplied, all layers will be assigned a unique id when created.

Link copied to clipboard

True if the layer supports identify, false otherwise. The value of this property may not be correct until the layer is in a fully loaded state.

Link copied to clipboard
open override var isVisible: Boolean

The layer content's visibility. The layer content visibility. Will return false if an error occurs.

Link copied to clipboard
val item: Item?

The item the layer has been created from.

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

The load status.

Link copied to clipboard

The maximum scale for the layer. The maximum scale at which this layer is visible. If the map or scene is zoomed in beyond this scale, the layer will not be visible. A value of 0 means there is no maximum scale threshold and the layer will be visible at the smallest scale available for the map or scene. If the value is nil, there is no maximum scale. All of the connected map and scene views will be updated.

Link copied to clipboard

The minimum scale for the layer. The minimum scale at which this layer is visible. If the map or scene is zoomed out beyond this scale, the layer will not be visible. A value of 0 means there is no minimum scale threshold and the layer will be visible at the largest scale available for the map or scene. If the value is nil, there is no minimum scale. All of the connected map and scene views will be updated.

Link copied to clipboard
open override var name: String

The name of this layer.

Link copied to clipboard

The opacity for the layer. The opacity of this layer as a value between 0 (fully transparent) and 1 (fully opaque). The default opacity value is 1.

Link copied to clipboard
open override var showInLegend: Boolean

A flag indicating whether the layer content participates in the legend. A flag indicating whether the layer content is shown in the legend.

Link copied to clipboard

The spatial reference of the layer.

Link copied to clipboard
open override val subLayerContents: StateFlow<List<LayerContent>>

The sub layer contents of a layer content.

Link copied to clipboard
val visibilityChanged: SharedFlow<Boolean>

Callback invoked when the visibility of the layer changes.

Functions

Link copied to clipboard

Clears all selected features.

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

Clones the ArcGISSceneLayer.

Link copied to clipboard

Returns a collection of the currently selected features.

Link copied to clipboard

Reset the visibility of all features back to their original state.

Link copied to clipboard
fun selectFeature(feature: Feature)

Selects the given feature and adds it to the current list of selected features.

Link copied to clipboard

Selects the features in the collection and adds them to the current collection of selected features.

Link copied to clipboard
fun setFeaturesVisible(features: Iterable<Feature>, visible: Boolean)

Sets the visibility of all features in the collection.

Link copied to clipboard
fun setFeatureVisible(feature: Feature, visible: Boolean)

Sets the visibility of the given feature.

Link copied to clipboard
fun unselectFeature(feature: Feature)

Unselects the given feature and removes it from the current collection of selected features.

Link copied to clipboard

Unselects the features in the given collection and removes them from the current collection of selected features.

Inherited functions

Link copied to clipboard
open override fun cancelLoad()

Cancels loading metadata for the Loadable object.

Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open suspend override fun fetchLegendInfos(): Result<List<LegendInfo>>

Fetches the list of legend info.

Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
open override fun isVisibleAtScale(scale: Double): Boolean

Returns the layer content's effective visibility at the specified scale. Returns the effective layer content visibility. This effective visibility takes care of the effective visibility of the parents at the specified scale. Will return false if an error occurs.

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.