Description
A layer to visualize an ArcGIS scene service.
Scene layers display content from a scene service or a scene package.
The AGSArcGISSceneLayer is a layer type optimized for displaying large amounts of data in an AGSSceneView. The AGSArcGISSceneLayer class displays data published as scene services, scene layer packages (.slpk), and scene layers in mobile scene packages (.mspk).
AGSArcGISSceneLayer supports:
- 3D Object (e.g. buildings)
- Integrated mesh (e.g. buildings, trees, and elevation) (see
AGSIntegratedMeshLayer) - Point features (e.g. 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 scene — 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.
- Point cloud — Point cloud layers provide fast display of large volumes of symbolized and filtered point cloud data. Point clouds are optimized for the display and sharing of data from many kinds of sensors that create point clouds, such as lidar.
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.
- See also
AGSLayer, Sample: Scene layer (URL), Sample: Scene layer selection, Sample: Add a point scene layer
- Since
- 100
Instance Methods | |
| (void) | - cancelLoad |
| (void) | - clearSelection |
| (void) | - doCancelLoading |
| (void) | - doStartLoading: |
| (id< AGSCancelable >) | - fetchLegendInfosWithCompletion: |
| (id< AGSCancelable >) | - getSelectedFeaturesWithCompletion: |
| (instancetype) | - initWithItem: |
| (instancetype) | - initWithName: |
| (instancetype) | - initWithURL: |
| (BOOL) | - isEqualToLayer: |
| (BOOL) | - isVisibleAtScale: |
| (void) | - loadDidFinishWithError: |
| (void) | - loadWithCompletion: |
| (void) | - onLoadStatusChanged |
| (void) | - retryLoadWithCompletion: |
| (void) | - selectFeature: |
| (void) | - selectFeatures: |
| (void) | - unselectFeature: |
| (void) | - unselectFeatures: |
Class Methods | |
| (instancetype) | + ArcGISSceneLayerWithItem: |
| (instancetype) | + ArcGISSceneLayerWithName: |
| (instancetype) | + ArcGISSceneLayerWithURL: |
Properties | |
| double | altitudeOffset |
| NSString * | APIKey |
| NSString * | attribution |
| BOOL | canChangeVisibility |
| AGSCredential * | credential |
| AGSSceneLayerDataType | dataType |
| AGSFeatureTable * | featureTable |
| AGSLayerFloorDefinition * | floorDefinition |
| AGSEnvelope * | fullExtent |
| BOOL | identifyEnabled |
| AGSItem * | item |
| BOOL | labelsEnabled |
| NSString * | layerDescription |
| NSString * | layerID |
| NSError * | loadError |
| AGSLoadStatus | loadStatus |
| double | maxScale |
| double | minScale |
| NSString * | name |
| float | opacity |
| AGSRequestConfiguration * | requestConfiguration |
| BOOL | showInLegend |
| AGSSpatialReference * | spatialReference |
| NSArray< id< AGSLayerContent > > * | subLayerContents |
| void(^ | subLayerContentsChangedHandler )(void) |
| AGSSurfacePlacement | surfacePlacement |
| NSURL * | URL |
| BOOL | visible |
Method Documentation
◆ ArcGISSceneLayerWithItem:
| + (instancetype) ArcGISSceneLayerWithItem: | (AGSItem *) | item |
Creates a layer with an item representing an individual layer in an ArcGIS scene service. The item's type should be AGSPortalItemTypeSceneService.
- Parameters
-
item The scene layer item (only AGSPortalItemare supported).
- Returns
- A new scene layer.
- Since
- 100
◆ ArcGISSceneLayerWithName:
| + (instancetype) ArcGISSceneLayerWithName: | (NSString *) | name |
Creates a layer with the name of a scene layer package within the application bundle or shared documents directory.
- Parameters
-
name The name of the scene layer package (without the .slpk file extension) within the application bundle or shared documents directory.
- Returns
- A new scene layer.
- Since
- 100.1
◆ ArcGISSceneLayerWithURL:
| + (instancetype) ArcGISSceneLayerWithURL: | (NSURL *) | url |
Creates a layer with a URL to an individual layer in an ArcGIS scene service, e.g. https://scene.arcgis.com/arcgis/rest/services/Hosted/Building_Basel/SceneServer/layers/0 or a URL to scene layer package (.slpk file) on disk.
- Parameters
-
url URL to an individual layer in an ArcGIS scene service or a scene layer package (.slpk file) on disk
- Returns
- A new scene layer
- Since
- 100
◆ cancelLoad
|
requiredinherited |
Cancels loading if it is in progress, otherwise it does nothing. This should be called carefully because other objects could be waiting for loadWithCompletion: or retryLoadWithCompletion: to complete and this will call them all back with the error of NSUserCancelledError
- Since
- 100
◆ clearSelection
| - (void) clearSelection |
Clears selection on all features.
- Since
- 100.3
◆ doCancelLoading
| - (void) doCancelLoading |
Never call this method directly. The framework calls this method on a background thread when cancelLoad (AGSLoadable-p) is called. It is meant to be overriden by subclasses. Subclasses should override this method to cancel loading their data and call loadDidFinishWithError: (AGSLoadableBase(ForSubclassEyesOnly)) at the end passing in an error representing NSUserCancelledError.
- Since
- 100
Provided by category AGSLoadableBase(ForSubclassEyesOnly).
◆ doStartLoading:
| - (void) doStartLoading: | (BOOL) | retrying |
Never call this method directly. The framework calls this method on a background thread when loadWithCompletion: (AGSLoadable-p) or retryLoadWithCompletion: (AGSLoadable-p) is called. It is meant to be overriden by subclasses. Subclasses should override this method to load their data and call loadDidFinishWithError: (AGSLoadableBase(ForSubclassEyesOnly)) upon completion, passing in the error if any.
- Parameters
-
retrying flag that is true if this method was called from retryLoadWithCompletion: (AGSLoadable-p).
- Since
- 100
Provided by category AGSLoadableBase(ForSubclassEyesOnly).
◆ fetchLegendInfosWithCompletion:
| - (id<AGSCancelable>) fetchLegendInfosWithCompletion: | (void(^)(NSArray< AGSLegendInfo * > *__nullable legendInfos, NSError *__nullable error)) | completion |
Fetches the array of legend infos (AGSLegendInfo) for this layer.
- Since
- 100
◆ getSelectedFeaturesWithCompletion:
| - (id<AGSCancelable>) getSelectedFeaturesWithCompletion: | (void(^)(AGSFeatureQueryResult *__nullable featureQueryResult, NSError *__nullable error)) | completion |
Retrieve the list of features that have selection enabled.
- Parameters
-
completion A block that is invoked with the results, or an error if one is encountered.
- Returns
- An operation which can be canceled.
- Since
- 100.3
◆ initWithItem:
| - (instancetype) initWithItem: | (AGSItem *) | item |
Creates a layer with an item representing an individual layer in an ArcGIS scene service. The item's type should be AGSPortalItemTypeSceneService.
- Parameters
-
item The scene layer item (only AGSPortalItemare supported).
- Since
- 100
◆ initWithName:
| - (instancetype) initWithName: | (NSString *) | name |
Creates a layer with the name of a scene layer package within the application bundle or shared documents directory.
- Parameters
-
name The name of the scene layer package (without the .slpk file extension) within the application bundle or shared documents directory.
- Since
- 100.1
◆ initWithURL:
| - (instancetype) initWithURL: | (NSURL *) | url |
Creates a layer with a URL to an individual layer in an ArcGIS scene service, e.g. https://scene.arcgis.com/arcgis/rest/services/Hosted/Building_Basel/SceneServer/layers/0 or a URL to scene layer package (.slpk file) on disk.
- Parameters
-
url URL to an individual layer in an ArcGIS Scene Service or a scene layer package (.slpk file) on disk.
- Since
- 100
◆ isEqualToLayer:
| - (BOOL) isEqualToLayer: | (AGSLayer *) | other |
◆ isVisibleAtScale:
| - (BOOL) isVisibleAtScale: | (double) | scale |
Check whether this layer is visible at a given scale.
- Since
- 100
◆ loadDidFinishWithError:
| - (void) loadDidFinishWithError: | (nullable NSError *) | error |
Only subclasses should call this method in doStartLoading: (AGSLoadableBase(ForSubclassEyesOnly)) and doCancelLoading (AGSLoadableBase(ForSubclassEyesOnly)) when done loading or failed to load.
- Since
- 100
Provided by category AGSLoadableBase(ForSubclassEyesOnly).
◆ loadWithCompletion:
|
requiredinherited |
Loads data for the object asynchronously. The completion block is invoked upon completion.
You can call this method any number of times, however only one attempt is made to load the data. If it is already loading, it will just continue to load (i.e. not force a reload). If it has already loaded successfully, the completion block will be invoked right away. If it has already failed to load, the completion block will be invoked right away with error previously encountered. This method supports multiple callers and will call them all back on completion. However, each caller's completion block will be invoked once and only once.
- Parameters
-
completion block that is invoked when object loads successfully or fails to load. An error is passed to the block if the object fails to load.
- Note
- The completion block is always invoked on the main thread.
- Since
- 100
- See also
- cancelLoadto cancel loading-
- retryLoadWithCompletion:to force reload
◆ onLoadStatusChanged
| - (void) onLoadStatusChanged |
Never call this method directly. The framework calls this method on a background thread when AGSLoadable::loadStatus changes is called. Subclasses can optionally implement this to know when their loading status has changed.
- Since
- 100
Provided by category AGSLoadableBase(ForSubclassEyesOnly).
◆ retryLoadWithCompletion:
|
requiredinherited |
Tries to reload when an object has failed to load. This method should be called judiciously. It should be called when:
- you didn't have network connectivity earlier when it failed and you want to retry now that you have connectivity
- the server was down earlier when it failed and you want to retry
- the request is taking too long and you want to cancel it and retry, in which case you will first call
cancelLoadand then this method
If the data hasn't started loading, it will start loading. If it is already loading, it will just continue to load. If it has already loaded successfully, calls back right away. If it has already failed to load, tries again. This method supports multiple callers and will call them all back on completion. However, each caller's completion block will be invoked once and only once.
- Parameters
-
completion block that is invoked when object loads successfully or fails to load. An error is passed to the block if the object fails to load.
- Note
- The completion block is always invoked on the main thread.
- Since
- 100
◆ selectFeature:
| - (void) selectFeature: | (AGSFeature *) | feature |
Select the specified feature. The scene will be updated to highlight the features with a selection color (cyan by default).
- Parameters
-
feature to select.
- Since
- 100.3
- Note
- Use
selectFeatures:to enable selection on a group of features together. It provides better performance as the scene will only need to be updated once.
◆ selectFeatures:
| - (void) selectFeatures: | (NSArray< AGSFeature * > *) | features |
Select the specified features. The scene will be updated to highlight the features with a selection color (cyan by default).
- Parameters
-
features an array of AGSFeatureobjects to select.
- Since
- 100.3
◆ unselectFeature:
| - (void) unselectFeature: | (AGSFeature *) | feature |
Clear selection on the specified feature. The scene will be redrawn to reflect the change.
- Parameters
-
feature to unselect.
- Since
- 100.3
- Note
- Use
unselectFeatures:to disable selection on a group of features together. It provides better performance as the scene will only need to be updated once.
◆ unselectFeatures:
| - (void) unselectFeatures: | (NSArray< AGSFeature * > *) | features |
Clear selection on the specified features. The scene will be redrawn to reflect the change.
- Parameters
-
features an array of AGSFeatureto unselect.
- Since
- 100.3
Property Documentation
◆ altitudeOffset
|
readwritenonatomicassign |
The layer altitude offset.
- Since
- 100.6
◆ APIKey
|
readwriterequirednonatomiccopyinherited |
The API key to access API key enabled services and resources in ArcGIS Online.
An API key is a unique key used to authorize access to specific services and resources in ArcGIS Online. It is also used to monitor access to those services. An API key is created and managed in the ArcGIS developer dashboard and is tied to a specific ArcGIS account.
In addition to setting an API key at a global level for your application using the AGSArcGISRuntimeEnvironment::APIKey property, you can set an AGSAPIKeyResource::APIKey property on any ArcGIS Runtime class that implements AGSAPIKeyResource. When you set an individual AGSAPIKeyResource::APIKey property on an AGSAPIKeyResource it will override the default key at the global level (on the AGSArcGISRuntimeEnvironment::APIKey property, in other words), enabling more granular usage telemetry and management for ArcGIS Online resources used by your app. Classes that expose an API key property by implementing AGSAPIKeyResource include:
◆ attribution
|
readnonatomiccopyinherited |
Attribution information of the layer.
- Since
- 100
◆ canChangeVisibility
|
readrequirednonatomicassigninherited |
Denotes whether the layer can change visibility or not.
- Since
- 100
◆ credential
|
readwritenonatomicstronginherited |
Security credentials to access the remote resource. Only applicable if the resource is secured.
- Since
- 100
◆ dataType
|
readnonatomicassign |
The content data type of the scene layer.
- Since
- 100.5
◆ featureTable
|
readnonatomicstrong |
◆ floorDefinition
|
readwriterequirednonatomicstronginherited |
Defines the properties that allow a layer to be floor-aware.
When a layer is configured as floor-aware, it has an AGSFloorAware::floorDefinition property that defines properties that allow a layer to be floor-aware. When it is nil (default value) the specific layer does not support floor filtering.
- Since
- 100.12
◆ fullExtent
|
readnonatomicstronginherited |
Full extent of the layer.
- Since
- 100
◆ identifyEnabled
|
readnonatomicassigninherited |
Specifies whether the layer supports identify.
- Since
- 100
◆ item
|
readnonatomicstronginherited |
The item the layer has been created from.
- Since
- 100
◆ labelsEnabled
|
readwritenonatomicassign |
A Boolean value indicating whether labels should be displayed.
- Note
- This property is only supported for
AGSSceneLayerDataTypePointlayers.
- Since
- 100.14
◆ layerDescription
|
readwritenonatomiccopyinherited |
The layer's description.
- Since
- 100
◆ layerID
|
readwritenonatomiccopyinherited |
The layer's ID specified in the web map item of ArcGIS Online or an on-premises portal.
- Since
- 100
◆ loadError
|
readnonatomicstronginherited |
The error that was encountered during the most recent load operation. Will be nil if the operation succeeded.
- Since
- 100
◆ loadStatus
|
readrequirednonatomicassigninherited |
Status of the load operation.
- Since
- 100
◆ maxScale
|
readwritenonatomicassigninherited |
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.
- Since
- 100
◆ minScale
|
readwritenonatomicassigninherited |
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.
- Since
- 100
◆ name
|
readwritenonatomiccopyinherited |
The name of the layer.
- Since
- 100
◆ opacity
|
readwritenonatomicassigninherited |
The opacity of this layer as a value between 0 (fully transparent) and 1 (fully opaque). Default value is 1.
- Since
- 100
◆ requestConfiguration
|
readwritenonatomicstronginherited |
The AGSRequestConfiguration object which defines the behavior and policies to use when accessing the remote resource. The default will be nil. If it is nil the [AGSRequestConfiguration globalConfiguration] will be used.
- Since
- 100
◆ showInLegend
|
readwritenonatomicassigninherited |
Indicates whether to show legend information.
- Since
- 100
◆ spatialReference
|
readnonatomicstronginherited |
The spatial reference of the layer.
- Since
- 100
◆ subLayerContents
|
readnonatomiccopyinherited |
This layer's sub-layers.
- Since
- 100
◆ subLayerContentsChangedHandler
|
readwritenonatomiccopyinherited |
Block that is invoked when the sub layer contents changes.
- Note
- The block will be invoked on the same thread on which the event occurred, which could be any arbitrary thread. You need to dispatch any UI related work to the main thread.
- Since
- 100
◆ surfacePlacement
|
readwritenonatomicassign |
Specifies how data that belongs to the layer should be placed in relation to the scene's surface.
- Since
- 100.6
◆ URL
|
readrequirednonatomicstronginherited |
The URL of the remote resource.
- Since
- 100
◆ visible
|
readwritenonatomicassigninherited |
Denotes whether the layer is visible or not. The visibility changes can be monitored using Key-Value Observing (KVO).
- Since
- 100
