ArcGISSceneLayer Class

Member Function Documentation

[explicit] ArcGISSceneLayer::ArcGISSceneLayer(const QUrl &url, QObject *parent = nullptr)

Creates an ArcGIS scene layer from the specified URL.

• url - The URL of an ArcGIS scene service, an ArcGIS scene service portal item, or a scene layer package (.slpk) file.
• parent - The optional parent QObject.

If the specified URL is a portal item URL (see PortalItem::PortalItem for the supported URL formats), the underlying PortalItem will be created and accessible through Layer::item.

See also PortalItem, PortalItem::PortalItem(const QUrl&, QObject*), and Layer::item.

ArcGISSceneLayer::ArcGISSceneLayer(const QUrl &url, Esri::ArcGISRuntime::Credential *credential, QObject *parent = nullptr)

Creates an ArcGIS scene layer from the specified URL with a credential.

• url - The URL of an ArcGIS scene service, an ArcGIS scene service portal item, or a scene layer package (.slpk) file.
• credential - The credential used to access the remote resource.
• parent - The optional parent QObject.

If the specified URL is a portal item URL (see PortalItem::PortalItem for the supported URL formats), the underlying PortalItem will be created and accessible through Layer::item.

The credential is applied if the provided URL is to a secured service or portal item.

[explicit] ArcGISSceneLayer::ArcGISSceneLayer(Esri::ArcGISRuntime::Item *item, QObject *parent = nullptr)

Constructor that creates a scene layer object with a portal item.

• item - The scene layer item (only PortalItem are supported).
• parent - The optional parent QObject.

The item's type should be PortalItemType::SceneService.

See also PortalItem, PortalItem::PortalItem(const QUrl&, QObject*), and Layer::item.

[override virtual] ArcGISSceneLayer::~ArcGISSceneLayer()

Destructor.

[since Esri::ArcGISRuntime 100.6] double ArcGISSceneLayer::altitudeOffset() const

Returns the layer altitude offset.

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

This function was introduced in Esri::ArcGISRuntime 100.6.

See also setAltitudeOffset().

[override virtual, since Esri::ArcGISRuntime 100.10] QString ArcGISSceneLayer::apiKey() const

Reimplements: ApiKeyResource::apiKey() const.

Returns 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.

Note: An API key created with a referrer is not supported. If you need service requests to include the referrer, use the SDK's functionality to intercept the request and add an HTTP referer header.

In addition to setting an ArcGISRuntimeEnvironment::apiKey at a global level for your application, you can set it on any class that implements ApiKeyResource. This overrides the ArcGISRuntimeEnvironment::apiKey and enables more granular usage telemetry and management of ArcGIS location resources used by your app.

Classes that expose an API key property by implementing ApiKeyResource include:

• Basemap
• ArcGISSceneLayer
• ArcGISTiledLayer
• ArcGISVectorTiledLayer
• ServiceFeatureTable
• ExportVectorTilesTask
• LocatorTask
• GeodatabaseSyncTask
• ClosestFacilityTask
• RouteTask
• ServiceAreaTask
• ExportTileCacheTask

For more information, see API key authentication and Types of authentication.

This function was introduced in Esri::ArcGISRuntime 100.10.

See also setApiKey().

[since Esri::ArcGISRuntime 100.3] void ArcGISSceneLayer::clearSelection()

Clears all selected features.

This function was introduced in Esri::ArcGISRuntime 100.3.

[override virtual] Esri::ArcGISRuntime::Credential *ArcGISSceneLayer::credential() const

Reimplements: RemoteResource::credential() const.

Returns the security credential used to access the scene service layer.

Only applicable if the service is secured.

[since Esri::ArcGISRuntime 100.5] Esri::ArcGISRuntime::SceneLayerDataType ArcGISSceneLayer::dataType() const

Returns 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.

This function was introduced in Esri::ArcGISRuntime 100.5.

[since Esri::ArcGISRuntime 100.3] Esri::ArcGISRuntime::FeatureTable *ArcGISSceneLayer::featureTable() const

Returns the feature table associated with this ArcGISSceneLayer.

This function was introduced in Esri::ArcGISRuntime 100.3.

[override virtual, since Esri::ArcGISRuntime 100.13] Esri::ArcGISRuntime::LayerFloorDefinition *ArcGISSceneLayer::floorDefinition() const

Reimplements: FloorAware::floorDefinition() const.

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

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

This function was introduced in Esri::ArcGISRuntime 100.13.

See also setFloorDefinition().

[since Esri::ArcGISRuntime 100.14] bool ArcGISSceneLayer::isLabelsEnabled() const

Returns true if labels should be displayed, false otherwise.

Note that this property is only supported for SceneLayerDataType::Point layers.

This function was introduced in Esri::ArcGISRuntime 100.14.

[since Esri::ArcGISRuntime 200.2] Esri::ArcGISRuntime::SceneLayerPolygonFilter *ArcGISSceneLayer::polygonFilter() const

Returns the filter to be applied to a feature based ArcGISSceneLayer and include or exclude features within the polygons.

This function was introduced in Esri::ArcGISRuntime 200.2.

See also setPolygonFilter() and SceneLayerPolygonFilter.

[since Esri::ArcGISRuntime 200.5] Esri::ArcGISRuntime::Renderer *ArcGISSceneLayer::renderer() const

Returns 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 the scene layer does not render and a LayerViewState that contains an error indicating the use of an unsupported renderer is raised on the SceneView.

Note that this property is not supported for SceneLayerDataType::IntegratedMesh layers. Setting a renderer on those layers has no effect.

This function was introduced in Esri::ArcGISRuntime 200.5.

See also setRenderer().

[override virtual, since Esri::ArcGISRuntime 100.1] Esri::ArcGISRuntime::RequestConfiguration ArcGISSceneLayer::requestConfiguration() const

Reimplements: RemoteResource::requestConfiguration() const.

Returns the RequestConfiguration in use by this scene layer.

This function was introduced in Esri::ArcGISRuntime 100.1.

See also setRequestConfiguration().

[since Esri::ArcGISRuntime 200.2] void ArcGISSceneLayer::resetFeaturesVisible()

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

This function was introduced in Esri::ArcGISRuntime 200.2.

[since Esri::ArcGISRuntime 100.3] void ArcGISSceneLayer::selectFeature(Esri::ArcGISRuntime::Feature *feature)

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

• feature - The feature.

This function was introduced in Esri::ArcGISRuntime 100.3.

[since Esri::ArcGISRuntime 100.3] void ArcGISSceneLayer::selectFeatures(const QList<Esri::ArcGISRuntime::Feature *> &features)

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

• features - A QList of Feature. Contents of the QList are copied.

This function was introduced in Esri::ArcGISRuntime 100.3.

[since Esri::ArcGISRuntime 200.2] QFuture<Esri::ArcGISRuntime::FeatureQueryResult *> ArcGISSceneLayer::selectedFeaturesAsync(QObject *parent = nullptr)

Returns a list of the currently selected features.

• parent - The optional parent QObject

This method returns a QFuture for the asynchronous operation. Use future.then() to continue processing when the operation completes. Use future.onFailed() to handle exceptions of type ErrorException.

See Working with QFuture for further details.

This function was introduced in Esri::ArcGISRuntime 200.2.

[since Esri::ArcGISRuntime 100.6] void ArcGISSceneLayer::setAltitudeOffset(double altitudeOffset)

Sets the altitudeOffset to altitudeOffset.

This function was introduced in Esri::ArcGISRuntime 100.6.

See also altitudeOffset.

[override virtual, since Esri::ArcGISRuntime 100.10] void ArcGISSceneLayer::setApiKey(const QString &apiKey)

Reimplements: ApiKeyResource::setApiKey(const QString &apiKey).

Sets the API key to apiKey.

See ApiKeyResource.

This function was introduced in Esri::ArcGISRuntime 100.10.

See also apiKey.

[since Esri::ArcGISRuntime 200.2] void ArcGISSceneLayer::setFeatureVisible(Esri::ArcGISRuntime::Feature *feature, bool visible)

Sets the visibility of the given feature.

• feature - The feature.
• visible - true to show a feature, otherwise false.

This function was introduced in Esri::ArcGISRuntime 200.2.

[since Esri::ArcGISRuntime 200.2] void ArcGISSceneLayer::setFeaturesVisible(const QList<Esri::ArcGISRuntime::Feature *> &features, bool visible)

Sets the visibility of the given list of features.

• features - A QList of Feature.
• visible - true to show the features, otherwise false.

This function was introduced in Esri::ArcGISRuntime 200.2.

[override virtual, since Esri::ArcGISRuntime 100.13] void ArcGISSceneLayer::setFloorDefinition(Esri::ArcGISRuntime::LayerFloorDefinition *floorDefinition)

Sets the floorDefinition to floorDefinition.

This function was introduced in Esri::ArcGISRuntime 100.13.

See also floorDefinition.

[since Esri::ArcGISRuntime 100.14] void ArcGISSceneLayer::setLabelsEnabled(bool labelsEnabled)

Sets the labelsEnabled to labelsEnabled.

This function was introduced in Esri::ArcGISRuntime 100.14.

See also isLabelsEnabled.

[since Esri::ArcGISRuntime 200.2] void ArcGISSceneLayer::setPolygonFilter(Esri::ArcGISRuntime::SceneLayerPolygonFilter *polygonFilter)

Sets the SceneLayerPolygonFilter.

• polygonFilter - The SceneLayerPolygonFilter to set.

The SceneLayerPolygonFilter to apply to the ArcGISSceneLayer to include or exclude features within the polygons.

This function was introduced in Esri::ArcGISRuntime 200.2.

See also polygonFilter.

[since Esri::ArcGISRuntime 200.5] void ArcGISSceneLayer::setRenderer(Esri::ArcGISRuntime::Renderer *renderer)

Sets the renderer to renderer.

This function was introduced in Esri::ArcGISRuntime 200.5.

See also renderer.

[override virtual, since Esri::ArcGISRuntime 100.1] void ArcGISSceneLayer::setRequestConfiguration(const Esri::ArcGISRuntime::RequestConfiguration &requestConfiguration)

Reimplements: RemoteResource::setRequestConfiguration(const Esri::ArcGISRuntime::RequestConfiguration &requestConfiguration).

Sets configuration parameters used for network requests sent by this scene layer to requestConfiguration.

This function was introduced in Esri::ArcGISRuntime 100.1.

See also requestConfiguration().

[since Esri::ArcGISRuntime 100.6] void ArcGISSceneLayer::setSurfacePlacement(Esri::ArcGISRuntime::SurfacePlacement surfacePlacement)

Sets the surfacePlacement to surfacePlacement.

This function was introduced in Esri::ArcGISRuntime 100.6.

See also surfacePlacement.

[since Esri::ArcGISRuntime 100.6] Esri::ArcGISRuntime::SurfacePlacement ArcGISSceneLayer::surfacePlacement() const

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

This function was introduced in Esri::ArcGISRuntime 100.6.

See also setSurfacePlacement().

[since Esri::ArcGISRuntime 100.3] void ArcGISSceneLayer::unselectFeature(Esri::ArcGISRuntime::Feature *feature)

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

• feature - The feature.

This function was introduced in Esri::ArcGISRuntime 100.3.

[since Esri::ArcGISRuntime 100.3] void ArcGISSceneLayer::unselectFeatures(const QList<Esri::ArcGISRuntime::Feature *> &features)

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

• features - A QList of Feature.

This function was introduced in Esri::ArcGISRuntime 100.3.

[override virtual] QUrl ArcGISSceneLayer::url() const

Reimplements: RemoteResource::url() const.

Returns the URL of an ArcGIS scene service or the path to a local scene layer package (.slpk) file.

The URL is available after the layer has successfully loaded.

See also ArcGISSceneLayer(const QUrl&, QObject*).