ArcGISSceneLayer QML Type

A layer that displays 3D features from a scene service. More...

Import Statement: import Esri.ArcGISRuntime 100.14
Since: Esri.ArcGISRuntime 100.0
Inherits:

Layer

Properties

Signals

Methods

Detailed Description

The ArcGISSceneLayer is a layer type optimized for displaying large amounts of data in a SceneView. The ArcGISSceneLayer type displays data published as scene services, scene layer packages (.slpk), and scene layers in mobile scene packages (.mspk).

Scene layers can be used to show 3D objects, such as textured or untextured buildings, or 3D mesh data, such as imagery captured by drones.

ArcGISSceneLayer supports:

  • 3D Object (for example, buildings)
  • Integrated mesh (for example, buildings, trees, and elevation) (see IntegratedMeshLayer)
  • Point features (for example, trees)

The scene layer complies with the Indexed 3D Scene layer (I3S) format. The I3S format is an open 3D content delivery format used to disseminate 3D GIS data to mobile, web, and desktop clients.

Functional characteristics

A scene service is used to provide one of the following types of 3D data:

  • 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 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 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 for more information.

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.

This QML type supports the following default properties. A default property may be declared inside another declared object without being assigned explicitly to a property.

TypeDefault Property
ArcGISItemitem
Credentialcredential
RequestConfigurationrequestConfiguration (since Esri.ArcGISRuntime 100.1)

Example:

Display an ArcGISSceneLayer with the URL to the REST endpoint of a scene service:

ArcGISSceneLayer {
    url: "https://tiles.arcgis.com/tiles/P3ePLMYs2RVChkJx/arcgis/rest/services/Buildings_Brest/SceneServer/layers/0"
}

For samples, see:

See also ApiKeyResource, LayerContent, Cancelable, Loadable, FloorAware, RemoteResource, and Layer.

Property Documentation

altitudeOffset : double

Returns or sets the altitude offset of this layer.

An altitude offset provides a simple mechanism to consistently modify the elevation of all features in the layer with a single value.

This property was introduced in Esri.ArcGISRuntime 100.6.


apiKey : string

Returns the API key.

This property was introduced in Esri.ArcGISRuntime 100.10.

See also ApiKeyResource.


[default] credential : Credential

The credential used to access the source of this layer.

The credential cannot be changed after the layer is loaded.


dataType : Enums.SceneLayerDataType

Gets the content type of an ArcGIS scene layer.

Return a Enums.SceneLayerDataType which identified the geometry and content type of and an ArcGIS scene layer.

The type of a scene layer can only be established after the layer has loaded. It can be used to identify the content type contained within the scene layer.

This property was introduced in Esri.ArcGISRuntime 100.5.


featureTable : FeatureTable

The feature table associated with this ArcGISSceneLayer.

This property was introduced in Esri.ArcGISRuntime 100.3.


floorDefinition : LayerFloorDefinition

Contains the properties that allow a layer to be floor-aware.

The floorDefinition property defines additional properties that allow a layer to be floor-aware. When floorDefinition is nullptr (default value), the specific layer does not support floor filtering.

This property was introduced in Esri.ArcGISRuntime 100.13.


[default] item : ArcGISItem

The item being used by the scene layer.

The ArcGISItem represents a scene layer on ArcGIS Online or ArcGIS Enterprise portal.

The item cannot be changed after the layer is loaded.


labelsEnabled : bool

true if labels should be displayed. Note that this property is only supported for Enums.SceneLayerDataTypePoint layers.

This property was introduced in Esri.ArcGISRuntime 100.14.


[default] requestConfiguration : RequestConfiguration

The configuration parameters used for network requests sent by this layer.

This property was introduced in Esri.ArcGISRuntime 100.1.


selectedFeaturesResult : FeatureQueryResult

A collection of selected features, the result of the last successful get selected features task.

This property was introduced in Esri.ArcGISRuntime 100.3.


selectedFeaturesStatus : Enums.TaskStatus

The status for the task to get the selected features.

This property was introduced in Esri.ArcGISRuntime 100.3.

See also Enums.TaskStatus.


surfacePlacement : Enums.SurfacePlacement

The Enums.SurfacePlacement of the LayerSceneProperties.

The Enums.SurfacePlacement enumeration specifies how the surface defines altitude.

This property was introduced in Esri.ArcGISRuntime 100.6.


url : url

The URL to the source of this layer.

The URL represents one of the following:

  • A URL to an online service that has the feature data.
  • A URL to an item hosted on ArcGIS Online or ArcGIS Enterprise portal.
  • A local file URL to a scene layer package (.slpk).

The url cannot be changed after the layer is loaded.


Signal Documentation

altitudeOffsetChanged()

Emitted when the altitudeOffset property changes.

Note: The corresponding handler is onAltitudeOffsetChanged.

This signal was introduced in Esri.ArcGISRuntime 100.6.


apiKeyChanged()

Emitted when the apiKey property changes.

Note: The corresponding handler is onApiKeyChanged.

This signal was introduced in Esri.ArcGISRuntime 100.10.

See also ApiKeyResource.


credentialChanged()

Emitted when the credential property changes.

Note: The corresponding handler is onCredentialChanged.


dataTypeChanged()

Emitted when the dataType property changes.

Note: The corresponding handler is onDataTypeChanged.

This signal was introduced in Esri.ArcGISRuntime 100.5.


featureTableChanged()

Emitted when the featureTable property changes.

Note: The corresponding handler is onFeatureTableChanged.

This signal was introduced in Esri.ArcGISRuntime 100.3.


floorDefinitionChanged()

Emitted when the floorDefinition property changes.

Note: The corresponding handler is onFloorDefinitionChanged.

This signal was introduced in Esri.ArcGISRuntime 100.13.


labelsEnabledChanged()

Emitted when the labelsEnabled property changes.

Note: The corresponding handler is onLabelsEnabledChanged.

This signal was introduced in Esri.ArcGISRuntime 100.14.


requestConfigurationChanged()

Emitted when the requestConfiguration property changes.

Note: The corresponding handler is onRequestConfigurationChanged.

This signal was introduced in Esri.ArcGISRuntime 100.1.


selectedFeaturesStatusChanged()

Emitted when the selectedFeaturesStatus property changes.

Note: The corresponding handler is onSelectedFeaturesStatusChanged.

This signal was introduced in Esri.ArcGISRuntime 100.3.


surfacePlacementChanged()

Emitted when the surfacePlacement property changes.

Note: The corresponding handler is onSurfacePlacementChanged.

This signal was introduced in Esri.ArcGISRuntime 100.6.


urlChanged()

Emitted when the url property changes.

Note: The corresponding handler is onUrlChanged.


Method Documentation

void clearSelection()

Clears selection on all features.

This method was introduced in Esri.ArcGISRuntime 100.3.


void selectFeature(Feature feature)

Selects a feature, adding it to the current selection set.

This method was introduced in Esri.ArcGISRuntime 100.3.


void selectFeatures(list<Feature> features)

Selects multiple features, adding them to the current selection set.

This method was introduced in Esri.ArcGISRuntime 100.3.


void selectedFeatures()

Retrieves a list of selected features.

This method uses an asynchronous task that cannot be started if it is already running from a previous call to selectedFeatures. You should check that the selectedFeaturesStatus property is not Enums.TaskStatusInProgress before calling this method.

After the task starts, you may use the signal selectedFeaturesStatusChanged to monitor task status.

Returns a task ID that can be used to cancel the selectedFeatures task.

This method was introduced in Esri.ArcGISRuntime 100.3.

See also Cancelable.


void unselectFeature(Feature feature)

Unselects a feature, removing it from the current selection set.

This method was introduced in Esri.ArcGISRuntime 100.3.


void unselectFeatures(list<Feature> features)

Unselects multiple features, removing them from the current selection set.

This method was introduced in Esri.ArcGISRuntime 100.3.


Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.