Module com.esri.arcgisruntime
Package com.esri.arcgisruntime.mapping

Class Surface

java.lang.Object
com.esri.arcgisruntime.mapping.Surface
All Implemented Interfaces:
Loadable
public final class Surface extends Object implements Loadable
The surface contains elevation sources and defines a surface upon which layers and overlays can be draped.

The surface is used to represent the ground in a scene. It is comprised of a collection of elevation sources (ElevationSource) which are combined in the scene to generate the surface.

Since:
100.0.0

  • Property Details

  • Constructor Details

    • Surface

      public Surface()
      Creates a surface object.

      Provides a surface on which layers may be draped or from which relative layers maybe offset. The most common use of the surface is to represent the ground in a scene. It is comprised of a collection of elevation sources ElevationSource which are combined in the scene to generate the surface. If the data from the elevation sources is spatially coincident it will use the elevation source order to determine which source to use.

      Since:
      100.0.0

    • Surface

      public Surface(Iterable<ElevationSource> elevationSources)
      Creates an instance of a Surface initialised with the list of elevation sources.
      Parameters:
      elevationSources - the elevation sources
      Since:
      100.0.0
      See Also:

  • Method Details

    • getElevationSources

      public Surface.ElevationSourceList getElevationSources()
      Gets a list of all the elevation sources in this surface. Changing the content of this list will change what elevation sources are in the surface.

      Elevation sources are an ordered collection of ElevationSource data that are combined to generate elevation values for the surface. The order of the elevation sources in the collection indicate which elevation has priority when the sources are spatially coincident. The collection is specific to a surface so you cannot reuse an elevation source collection coming from another Surface.

      Returns:
      the elevation sources
      Since:
      100.0.0
      See Also:

    • getElevationExaggeration

      public float getElevationExaggeration()
      Gets the exaggeration for the surface.

      The altitude values of the surface data are multiplied by the exaggeration value. The default value is 1.0, indicating no exaggeration.

      Returns:
      the exaggeration factor
      Since:
      100.0.0

    • setElevationExaggeration

      public void setElevationExaggeration(float exaggeration)
      Sets the exaggeration for the surface.

      The altitude values of the surface data are multiplied by the exaggeration value. The default value is 1.0, indicating no exaggeration.

      Parameters:
      exaggeration - the exaggeration factor
      Throws:
      IllegalArgumentException - if exaggeration is less than zero
      Since:
      100.0.0

    • isEnabled

      public boolean isEnabled()
      Gets if the surface is enabled in the ArcGISScene.

      This value indicates if the surface is enabled and is rendered. If true, the surface's elevation sources are only used in the calculation of the surface if their ElevationSource.isEnabled() is also true.

      Returns:
      true, if the surface is enabled
      Since:
      100.0.0

    • setEnabled

      public void setEnabled(boolean enabled)
      Sets if the surface is enabled in the ArcGISScene or not.

      This value indicates if the surface is enabled and is rendered. If true, the surface's elevation sources are only used in the calculation of the surface if their ElevationSource.isEnabled() is also true.

      Parameters:
      enabled - true to enable
      Since:
      100.0.0

    • getName

      public String getName()
      Gets the name of this surface.
      Returns:
      the name of this surface
      Since:
      100.4.0

    • setName

      public void setName(String name)
      Sets the name of this surface.
      Parameters:
      name - the name of this surface
      Since:
      100.4.0

    • getBackgroundGrid

      public BackgroundGrid getBackgroundGrid()
      Gets the grid and color settings to render the background grid of this surface.

      The background grid is visible when no data is draped on the surface.

      Returns:
      the BackgroundGrid that is displayed when the corresponding view has nothing in it
      Since:
      100.1.0

    • setBackgroundGrid

      public void setBackgroundGrid(BackgroundGrid backgroundGrid)
      Sets the grid and color settings to render the background grid of this surface.

      The background grid is visible when no data is draped on the surface.

      Parameters:
      backgroundGrid - the BackgroundGrid that is displayed when the corresponding SceneView has nothing in it
      Throws:
      IllegalArgumentException - if the backgroundGrid is null
      Since:
      100.1.0

    • getElevationAsync

      public ListenableFuture<Double> getElevationAsync(Point point)
      Asynchronously retrieves the most accurate available elevation value (in meters) from the elevation surface for a given point.

      Note - the Surface has to be associated with a SceneView that is being rendered at the point of calling this method.

      Use this method to get elevation values for locations that are currently not rendered on screen, for example when zooming to a point of which only x,y values are known, such as a geocoding result. You first call getElevationAsync to get a z value and then combine that with the x,y to put the camera in a meaningful place.

      This method retrieves the most accurate available elevation value at a given x,y location which requires it to go to the server or local raster file and load the highest level of detail of data for the target location and return the elevation value.

      If multiple elevation sources are present in the surface the top most visible elevation source with a valid elevation in the given location is used to determine the result.

      Parameters:
      point - the x,y location at which to retrieve an elevation value, any given z value is ignored
      Returns:
      a ListenableFuture for tracking when the operation is done and getting the result. Add a listener to the future to be notified when the operation is complete. The result of the future is a Double representing the elevation in meters above or below sea level at the given point.
      Throws:
      IllegalArgumentException - if point is null
      Since:
      100.1.0
      See Also:

    • setNavigationConstraint

      public void setNavigationConstraint(NavigationConstraint navigationConstraint)
      Sets the navigation constraint defining how the camera interacts with the elevation of the surface.

      This property determines whether the camera altitude is affected by the elevation at the location of the camera. You can restrict the camera to stay above the ground or allow it to move below the surface. The default value is NavigationConstraint.STAY_ABOVE.

      Parameters:
      navigationConstraint - the navigation constraint
      Throws:
      IllegalArgumentException - if navigationConstraint is null
      Since:
      100.5.0

    • getNavigationConstraint

      public NavigationConstraint getNavigationConstraint()
      Gets the navigation constraint defining how the camera interacts with the elevation of the surface.

      This property determines whether the camera altitude is affected by the elevation at the location of the camera. You can restrict the camera to stay above the ground or allow it to move below the surface. The default value is NavigationConstraint.STAY_ABOVE.

      Returns:
      the navigation constraint
      Since:
      100.5.0

    • setOpacity

      public void setOpacity(float opacity)
      Sets the opacity of this surface.

      The opacity value of all layers in the basemap, associated with this surface, and the getBackgroundGrid() are multiplied by this opacity value. The value can be between 0 and 1.0, where 0 is transparent and 1.0 is solid or opaque.

      Parameters:
      opacity - a value between 0 to 1.0, 1.0 being solid or opaque and 0 being transparent
      Throws:
      ArcGISRuntimeException - if opacity is an invalid value
      Since:
      100.5.0

    • getOpacity

      public float getOpacity()
      Gets the opacity of this surface.

      The opacity value of all layers in the basemap, associated with this surface, and the getBackgroundGrid() are multiplied by this opacity value. The value can be between 0 and 1.0, where 0 is transparent and 1.0 is solid or opaque.

      Returns:
      a value between 0 to 1.0, 1.0 being solid or opaque and 0 being transparent
      Since:
      100.5.0

    • getLoadStatus

      public LoadStatus getLoadStatus()
      Gets the value of the loadStatus property.
      Specified by:
      getLoadStatus in interface Loadable
      Property description:
      Returns:
      the value of the loadStatus property
      See Also:

    • getLoadError

      public ArcGISRuntimeException getLoadError()
      Gets the value of the loadError property.
      Specified by:
      getLoadError in interface Loadable
      Property description:
      Returns:
      the value of the loadError property
      See Also:

    • cancelLoad

      public void cancelLoad()
      Description copied from interface: Loadable
      Cancels loading metadata for the object.

      Cancels loading the metadata if the object is loading, and always invokes the done loading listener.

      A load operation that is in progress (LoadStatus.LOADING state) can be cancelled by calling this method and the resource will transition from LoadStatus.LOADING to LoadStatus.FAILED_TO_LOAD state. If the load operation was successfully cancelled, a CancellationException will be returned from Loadable.getLoadError().

      Cancellation should be used carefully because all enqueued done loading listeners for that resource instance will get invoked with an error stating that the operation was cancelled. Thus, one component in the application can cancel the load operation initiated by other components.

      This method does nothing if the resource is not in LoadStatus.LOADING state.

      Specified by:
      cancelLoad in interface Loadable

    • loadAsync

      public void loadAsync()
      Description copied from interface: Loadable
      Loads the metadata of the loadable resource asynchronously.

      The load status changes from LoadStatus.NOT_LOADED to LoadStatus.LOADING. A listener can be added via Loadable.addDoneLoadingListener(java.lang.Runnable) that is invoked upon completion of the asynchronous load operation.

      If the load operation completes successfully, the load status will be LoadStatus.LOADED, which means the resource has loaded its metadata.

      If the load operation failed, the load status will be LoadStatus.FAILED_TO_LOAD and the error can be retrieved by calling Loadable.getLoadError().

      This method can be called concurrently and repeatedly, but only one attempt is ever made to perform the load operation. If a load operation is already in progress (LoadStatus.LOADING state) when loadAsync is called, it simply piggy-backs on the outstanding operation and the done loading listener added to the loadable resource is enqueued to be invoked when that operation completes. If the operation has already completed (LoadStatus.LOADED or LoadStatus.FAILED_TO_LOAD state) when loadAsync is called, the done loading listener is immediately invoked when added to the loadable resource.

      If a loadable resource has failed to load, calling loadAsync on it subsequently will not change its state. The done loading listener will be invoked immediately when added to the loadable resource. In order to retry loading the resource, Loadable.retryLoadAsync() needs to be used.

      A load operation that is in progress (LoadStatus.LOADING state) can be cancelled by calling Loadable.cancelLoad().

      Specified by:
      loadAsync in interface Loadable

    • retryLoadAsync

      public void retryLoadAsync()
      Description copied from interface: Loadable
      Loads or retries loading metadata for the object asynchronously.

      Will retry loading the metadata if the object's load status is LoadStatus.FAILED_TO_LOAD. Will load the object if it is not loaded. Will not retry to load the object if the object is loaded.

      For more details on the load process see Loadable.loadAsync().

      Specified by:
      retryLoadAsync in interface Loadable

    • addDoneLoadingListener

      public void addDoneLoadingListener(Runnable listener)
      Description copied from interface: Loadable
      Adds a listener to the loadable resource that is invoked when loading has completed.

      The listener may be added at any point, whether the loadable resource has already completed loading or not.

      • For resources that are not loaded when the listener is added (LoadStatus is NOT_LOADED or LOADING): When the resource completes loading, the listener will be invoked on the UI thread if it is added from the UI thread, otherwise it is not guaranteed on which thread the listener is invoked.
      • For resources that are already loaded when the listener is added (LoadStatus is LOADED or FAILED_TO_LOAD): The listener will be called immediately, on the current thread.

      Alternatively, to be notified when there is any change in the load status, add a listener to the Loadable.loadStatusProperty() instead.

      Specified by:
      addDoneLoadingListener in interface Loadable
      Parameters:
      listener - a Runnable that is invoked upon completion of the load operation

    • removeDoneLoadingListener

      public boolean removeDoneLoadingListener(Runnable listener)
      Description copied from interface: Loadable
      Removes a done loading listener from the loadable resource.
      Specified by:
      removeDoneLoadingListener in interface Loadable
      Parameters:
      listener - the listener to be removed
      Returns:
      true if the listener was removed, otherwise false

    • addLoadStatusChangedListener

      public void addLoadStatusChangedListener(LoadStatusChangedListener listener)
      Description copied from interface: Loadable
      Adds a LoadStatusChangedListener to the loadable resource that is invoked whenever the load status changes.

      Adding this listener on the UI thread will cause it to be invoked on the UI thread, otherwise it is not guaranteed on which thread the listener is invoked.

      The listener will not be called if added to a loadable resource that has already completed loading. To be notified when a loadable resource has completed loading, including if the resource is already loaded when the listener is added, use the Loadable.addDoneLoadingListener(Runnable) method.

      Specified by:
      addLoadStatusChangedListener in interface Loadable
      Parameters:
      listener - the LoadStatusChangedListener to be added

    • removeLoadStatusChangedListener

      public boolean removeLoadStatusChangedListener(LoadStatusChangedListener listener)
      Description copied from interface: Loadable
      Removes a LoadStatusChangedListener from the loadable resource.
      Specified by:
      removeLoadStatusChangedListener in interface Loadable
      Parameters:
      listener - the LoadStatusChangedListener to be removed
      Returns:
      true if the listener was removed, otherwise false

    • loadStatusProperty

      public ReadOnlyObjectProperty<LoadStatus> loadStatusProperty()
      Description copied from interface: Loadable
      The load status.
      Specified by:
      loadStatusProperty in interface Loadable
      Returns:
      the loadStatus property
      See Also:

    • loadErrorProperty

      public ReadOnlyObjectProperty<ArcGISRuntimeException> loadErrorProperty()
      Description copied from interface: Loadable
      The load error.
      Specified by:
      loadErrorProperty in interface Loadable
      Returns:
      the loadError property
      See Also: