ArcGIS Runtime SDK for iOS
100.15
|
An elevation source based on tiled elevation data.
Instances of this class represent an elevation source based on a tiled ArcGIS Image Service containing elevation data. It can be used in AGSSurface::elevationSources
to specify the surface of a scene.
AGSScene::baseSurface
to specify the surface of a scene Instance Methods | |
(void) | - cancelLoad |
(void) | - doCancelLoading |
(void) | - doStartLoading: |
(instancetype) | - initWithItem: |
(instancetype) | - initWithName: |
(instancetype) | - initWithTileCache: |
(instancetype) | - initWithURL: |
(void) | - loadDidFinishWithError: |
(void) | - loadWithCompletion: |
(void) | - onLoadStatusChanged |
(void) | - retryLoadWithCompletion: |
Class Methods | |
(instancetype) | + ArcGISTiledElevationSource |
(instancetype) | + ArcGISTiledElevationSourceWithItem: |
(instancetype) | + ArcGISTiledElevationSourceWithName: |
(instancetype) | + ArcGISTiledElevationSourceWithTileCache: |
(instancetype) | + ArcGISTiledElevationSourceWithURL: |
Properties | |
AGSCredential * | credential |
BOOL | enabled |
AGSItem * | item |
NSError * | loadError |
AGSLoadStatus | loadStatus |
NSString * | name |
AGSRequestConfiguration * | requestConfiguration |
AGSTileCache * | tileCache |
NSURL * | URL |
+ (instancetype) ArcGISTiledElevationSource |
Creates a ArcGIS tiled elevation source object.
An ArcGIS tiled elevation source is added to an AGSSurface
and provides elevation data that layers may be draped or offset from. The ArcGIS tiled elevation source uses an ArcGIS image service to provide the elevation data.
+ (instancetype) ArcGISTiledElevationSourceWithItem: | (AGSItem *) | item |
Initialize a tiled elevation source based on an item on ArcGIS Online or ArcGIS Portal representing an ArcGIS Image service containing elevation data.
item | representing an ArcGIS Image service containing elevation data. |
+ (instancetype) ArcGISTiledElevationSourceWithName: | (NSString *) | name |
Initialize a tiled elevation source with the name of a local Tile Package (.tpk or .tpkx file) within the application bundle or shared documents directory containing elevation data.
name | The name of a local Tile Package (same as the name of the .tpk or .tpkx file without the file extension) containing elevation data. |
+ (instancetype) ArcGISTiledElevationSourceWithTileCache: | (AGSTileCache *) | tileCache |
Creates a tiled elevation source based on a tile cache containing elevation data.
An ArcGIS tiled elevation source is added to an AGSSurface
and provides elevation data that layers may be draped or offset from. The ArcGIS tiled elevation source uses a tile cache to provide the elevation data. Only tile caches that contain LERC tiles are supported. Use an AGSExportTileCacheTask
to create an offline tile cache from an elevation image service.
tileCache | containing elevation data. |
+ (instancetype) ArcGISTiledElevationSourceWithURL: | (NSURL *) | URL |
Initialize a tiled elevation source based on an ArcGIS Image service or a local Tile Package (.tpk or .tpkx file) on disk containing elevation data.
URL | The URL to a tiled ArcGIS Image service or a local Tile Package (.tpk or .tpkx file) on disk containing elevation data. |
|
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
- (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
.
Provided by category AGSLoadableBase(ForSubclassEyesOnly).
- (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.
retrying | flag that is true if this method was called from retryLoadWithCompletion: (AGSLoadable-p) . |
Provided by category AGSLoadableBase(ForSubclassEyesOnly).
- (instancetype) initWithItem: | (AGSItem *) | item |
Initialize a tiled elevation source based on an item on ArcGIS Online or ArcGIS Portal representing an ArcGIS Image service containing elevation data.
item | representing an ArcGIS Image service containing elevation data. |
- (instancetype) initWithName: | (NSString *) | name |
Initialize a tiled elevation source with the name of a local Tile Package (.tpk or .tpkx file) within the application bundle or shared documents directory containing elevation data.
name | The name of a local Tile Package (same as the name of the .tpk or .tpkx file without the file extension) containing elevation data. |
- (instancetype) initWithTileCache: | (AGSTileCache *) | tileCache |
Creates a tiled elevation source based on a tile cache containing elevation data.
An ArcGIS tiled elevation source is added to an AGSSurface
and provides elevation data that layers may be draped or offset from. The ArcGIS tiled elevation source uses a tile cache to provide the elevation data. Only tile caches that contain LERC tiles are supported. Use an AGSExportTileCacheTask
to create an offline tile cache from an elevation image service.
tileCache | containing elevation data. |
- (instancetype) initWithURL: | (NSURL *) | URL |
Initialize a tiled elevation source based on an ArcGIS Image service or a local Tile Package (.tpk or .tpkx file) on disk containing elevation data.
URL | The URL to a tiled ArcGIS Image service or a local Tile Package (.tpk or .tpkx file) on disk containing elevation data. |
- (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.
Provided by category AGSLoadableBase(ForSubclassEyesOnly).
|
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.
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. |
- cancelLoad
to cancel loading - retryLoadWithCompletion:
to force reload - (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.
Provided by category AGSLoadableBase(ForSubclassEyesOnly).
|
requiredinherited |
Tries to reload when an object has failed to load. This method should be called judiciously. It should be called when:
cancelLoad
and then this methodIf 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.
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. |
|
readwritenonatomicstronginherited |
Security credentials to access the remote resource. Only applicable if the resource is secured.
|
readwritenonatomicassigninherited |
Indicates whether this elevation source is enabled or not
|
readnonatomicstrong |
The item being used by the elevation source, if any.
|
readnonatomicstronginherited |
The error that was encountered during the most recent load operation. Will be nil if the operation succeeded.
|
readrequirednonatomicassigninherited |
Status of the load operation.
|
readwritenonatomiccopyinherited |
Name of the elevation source
|
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.
|
readnonatomicstrong |
The tile cache being used by the elevation source, if any.
|
readrequirednonatomicstronginherited |
The URL of the remote resource.