Class ArcGISTiledElevationSource
- All Implemented Interfaces:
RemoteResource
,Loadable
An ArcGIS tiled elevation source helps visualize maps and layers in 3D by providing a surface that layers may be draped or offset from.
You can create an ArcGIS tiled elevation source object from the URL, or PortalItem
, of an online ArcGIS
image service, or a local TileCache
generated from an ArcGIS image service. In all cases, the
Image Service
must support elevation that is stored in the Limited Error Raster Compression (LERC) tile format. If your app is
online and connected to ArcGIS Online, you can utilize the cached elevation image service,
WorldElevation3D/Terrain3D.
To utilize an elevation source in a scene's surface, add it to the scene's Surface.getElevationSources()
collection.
- Since:
- 100.0.0
-
Property Summary
TypePropertyDescriptionThe tile cache of the elevation service.Properties inherited from class com.esri.arcgisruntime.mapping.ElevationSource
loadError, loadStatus
-
Constructor Summary
ConstructorDescriptionArcGISTiledElevationSource
(TileCache tileCache) Creates an ArcGIS tiled elevation source with a tile cache.ArcGISTiledElevationSource
(PortalItem portalItem) Creates an ArcGISTiledElevationSource instance based on aPortalItem
.Creates an ArcGIS tiled elevation source with using a URL to an elevation service object. -
Method Summary
Methods inherited from class com.esri.arcgisruntime.mapping.ElevationSource
addDoneLoadingListener, addLoadStatusChangedListener, cancelLoad, getCredential, getLoadError, getLoadStatus, getName, getRequestConfiguration, isEnabled, loadAsync, loadErrorProperty, loadStatusProperty, removeDoneLoadingListener, removeLoadStatusChangedListener, retryLoadAsync, setCredential, setEnabled, setName, setRequestConfiguration
-
Property Details
-
tileCache
The tile cache of the elevation service.- Since:
- 200.2.0
- See Also:
-
-
Constructor Details
-
ArcGISTiledElevationSource
Creates an ArcGIS tiled elevation source with using a URL to an elevation service object.An ArcGIS tiled elevation source is added to a
Surface
and provides elevation data on which layers may be draped or offset from. The ArcGIS tiled elevation source uses an ArcGIS Image service to provide the elevation data.- Parameters:
uri
- The URI of the service- Throws:
IllegalArgumentException
- if the URI is null or empty- Since:
- 100.0.0
-
ArcGISTiledElevationSource
Creates an ArcGISTiledElevationSource instance based on aPortalItem
.An ArcGIS tiled elevation source is added to a
Surface
and provides elevation data on which layers may be draped or offset from. The ArcGIS tiled elevation source uses an ArcGIS Image service to provide the elevation data.If the portal item is not in
LoadStatus.LOADED
state it will be loaded automatically when this ArcGISTiledElevationSource instance is loaded.If the loaded portalItem is not of type
PortalItem.Type.IMAGE_SERVICE
the elevation source will fail to load.- Parameters:
portalItem
- PortalItem from which ArcGISTiledElevationSource will be created- Throws:
IllegalArgumentException
- if the portalItem is null- Since:
- 100.0.0
-
ArcGISTiledElevationSource
Creates an ArcGIS tiled elevation source with a tile cache.An ArcGIS tiled elevation source is added to a
Surface
and provides elevation data that layers may be draped or offset from. The ArcGIS tiled elevation source uses aTileCache
to provide the elevation data. Only tile caches that contain LERC tiles are supported. Use anExportTileCacheTask
to create an offline tile cache from an elevation image service.- Parameters:
tileCache
- metadata for a local cache of elevation tiles that can be used to create an elevation source- Throws:
NullPointerException
- if tileCache is null- Since:
- 200.2.0
-
-
Method Details
-
getItem
Gets the item of the elevation service.- Returns:
- the associated Item or null if this source is not associated with an Item
- Since:
- 100.0.0
-
tileCacheProperty
The tile cache of the elevation service.- Returns:
- the
tileCache
property - Since:
- 200.2.0
- See Also:
-
getTileCache
Gets the value of thetileCache
property.- Property description:
- The tile cache of the elevation service.
- Returns:
- the value of the
tileCache
property - Since:
- 200.2.0
- See Also:
-
getUri
Description copied from interface:RemoteResource
Gets the URI of thisRemoteResource
. Typically this is the URI used to instantiate the object.- Returns:
- the URI of this RemoteResource
-