Class ArcGISSceneLayer

  • All Implemented Interfaces:
    ApiKeyResource, RemoteResource, LayerContent, Loadable

    public final class ArcGISSceneLayer
    extends Layer
    implements RemoteResource, ApiKeyResource
    A layer to visualize an ArcGIS scene service. Scene layers display content from a scene service or a scene package.

    The ArcGISSceneLayer is a layer type designed for on-demand streaming and displaying large amounts of data in a SceneView. Scene layers support two types: Point and 3D Objects (e.g. buildings). The ArcGISSceneLayer displays data published to a scene service. Scene services can hold large volumes of features in an open format that is suitable for web streaming. Some 3D layers can be found at http://scene.arcgis.com/arcgis/rest/services/Hosted.

    ArcGIS SceneServices can have seven different data types, of which Runtime supports four:

    Content in 3D can be delivered as scene packages (stored on the client) or as online scene services. These data sources support consuming large volumes of multipatch features, such as building models for an entire city.

    Functional characteristics

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

    • 3D objects — 3D object scene layers contain point features with associated 3D models used to represent objects such as buildings, trees, and street furniture that are explicitly modeled in three dimensions. These features have attributes and can be identified.
    • 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.
    • 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.
    • 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.

    Example of how to add an ArcGISSceneLayer to a SceneView

     ArcGISScene scene = new ArcGISScene(Basemap.createImagery());
    
     //creating a layer using a URL from a scene service
     ArcGISSceneLayer sceneLayer = new ArcGISSceneLayer(
       "http://scene.arcgis.com/arcgis/rest/services/Hosted/Buildings_San_Francisco/SceneServer/layers/0");
     scene.getOperationalLayers().add(sceneLayer);
    
     SceneView view = new SceneView();
     view.setArcGISScene(scene);
     
    Since:
    100.0.0 for JavaSE and 100.1.0 for Android
    See Also:
    ArcGISScene, Layer, SceneView
    • Constructor Detail

      • ArcGISSceneLayer

        public ArcGISSceneLayer​(String dataSourceUri)
        Creates a Layer from an ArcGIS scene service at the given URL or absolute file path to local scene package file.

        Scene services allow for sharing of 3D features from a scene server.

        To use a credential, call setCredential(Credential) after this constructor and before loading or using this layer.

        Parameters:
        dataSourceUri - the url of the scene service, or the path to local scene package (.slpk)
        Throws:
        IllegalArgumentException - if dataSourceUri is null or empty
        Since:
        100.0.0 for JavaSE and 100.1.0 for Android
      • ArcGISSceneLayer

        public ArcGISSceneLayer​(PortalItem portalItem)
        Creates an ArcGISSceneLayer instance based on a PortalItem.

        If the portal item is not in LoadStatus.LOADED state it will be loaded automatically when this ArcGISSceneLayer instance is loaded.

        If the loaded portalItem is not of type PortalItem.Type.SCENE_SERVICE the layer will fail to load.

        Parameters:
        portalItem - PortalItem from which this ArcGISSceneLayer will be created
        Throws:
        IllegalArgumentException - if the portalItem is null
        Since:
        100.0.0 for JavaSE and 100.1.0 for Android
    • Method Detail

      • selectFeature

        public void selectFeature​(Feature feature)
        Selects the given feature and adds it to the current list of selected features.
        Parameters:
        feature - the feature to be added to selection
        Throws:
        IllegalArgumentException - if feature is null
        Since:
        100.3.0
      • selectFeatures

        public void selectFeatures​(Iterable<Feature> features)
        Selects the features in the list and adds them to the current list of selected features.
        Parameters:
        features - the features to be added to selection
        Throws:
        IllegalArgumentException - if features is null
        Since:
        100.3.0
      • getSelectedFeaturesAsync

        public ListenableFuture<FeatureQueryResult> getSelectedFeaturesAsync()
        Gets all the selected features.
        Returns:
        a future that represents the selected features
        Since:
        100.3.0
      • unselectFeature

        public void unselectFeature​(Feature feature)
        Removes a feature from selection.
        Parameters:
        feature - the feature to be unselected
        Throws:
        IllegalArgumentException - if feature is null
        Since:
        100.3.0
      • unselectFeatures

        public void unselectFeatures​(Iterable<Feature> features)
        Removes multiple features from selection.
        Parameters:
        features - the features to be unselected
        Throws:
        IllegalArgumentException - if features is null
        Since:
        100.3.0
      • clearSelection

        public void clearSelection()
        Clears all the selected features.
        Since:
        100.3.0
      • copy

        public ArcGISSceneLayer copy()
        Creates a deep copy of this ArcGISSceneLayer instance.
        Returns:
        a deep copy of this ArcGISSceneLayer instance, which means that copies of all fields of this layer are made including its loading state
        Since:
        100.1.0
      • getFeatureTable

        public FeatureTable getFeatureTable()
        Gets the feature table associated with this layer.
        Returns:
        the feature table, or null if there is no associated feature table
        Since:
        100.3.0
      • setSurfacePlacement

        public void setSurfacePlacement​(LayerSceneProperties.SurfacePlacement surfacePlacement)
        Sets the surface placement for the ArcGISSceneLayer.
        Parameters:
        surfacePlacement - the surface placement to apply to the scene layer
        Throws:
        IllegalArgumentException - if surfacePlacement is null
        Since:
        100.6.0
      • getSurfacePlacement

        public LayerSceneProperties.SurfacePlacement getSurfacePlacement()
        Gets the surface placement for the ArcGISSceneLayer.
        Returns:
        the surface placement of the scene layer
        Since:
        100.6.0
      • setAltitudeOffset

        public void setAltitudeOffset​(double altitudeOffset)
        Sets the layer altitude offset.
        Parameters:
        altitudeOffset - the layer altitude offset
        Since:
        100.6.0
      • getAltitudeOffset

        public double getAltitudeOffset()
        Gets the layer altitude offset.
        Returns:
        the layer altitude offset
        Since:
        100.6.0
      • getCredential

        public Credential getCredential()
        Gets the credential used to authenticate the user with the scene service.
        Specified by:
        getCredential in interface RemoteResource
        Returns:
        the credential used for authentication
        Since:
        100.0.0 for JavaSE and 100.1.0 for Android
      • setCredential

        public void setCredential​(Credential credential)
        Sets the credential used to authenticate the user with the scene service.
        Specified by:
        setCredential in interface RemoteResource
        Parameters:
        credential - the credential used for authentication
        Since:
        100.0.0 for JavaSE and 100.1.0 for Android
      • setRequestConfiguration

        public void setRequestConfiguration​(RequestConfiguration requestConfiguration)
        Sets the configuration parameters used for sending a network request using this Layer object. The global RequestConfiguration is used if no RequestConfiguration is set which contains the default values from the getter/setter methods.
        Specified by:
        setRequestConfiguration in interface RemoteResource
        Parameters:
        requestConfiguration - contains the parameters to use
        Since:
        100.0.0 for JavaSE and 100.1.0 for Android
        See Also:
        RequestConfiguration
      • getUri

        public String getUri()
        Description copied from interface: RemoteResource
        Gets the URI of this RemoteResource. Typically this is the URI used to instantiate the object.
        Specified by:
        getUri in interface RemoteResource
        Returns:
        the URI of this RemoteResource