ArcGIS Runtime SDK for iOS
100.15
|
A surface providing elevation context for a scene.
Instances of this class represent a surface which provides an elevation context for a scene's basemap and operational layers. The surface is defined by a mesh of elevation points. Z values for geographic data can then be interpreted as relative/draped (placed using a specific surface) or absolute (not using any surface).
Instance Methods | |
(void) | - cancelLoad |
(void) | - doCancelLoading |
(void) | - doStartLoading: |
(id< AGSCancelable >) | - elevationForPoint:completion: |
(void) | - loadDidFinishWithError: |
(void) | - loadWithCompletion: |
(void) | - onLoadStatusChanged |
(void) | - retryLoadWithCompletion: |
Class Methods | |
(instancetype) | + surface |
Properties | |
AGSBackgroundGrid * | backgroundGrid |
float | elevationExaggeration |
NSArray< AGSElevationSource * > * | elevationSources |
BOOL | enabled |
NSError * | loadError |
AGSLoadStatus | loadStatus |
NSString * | name |
AGSNavigationConstraint | navigationConstraint |
float | opacity |
|
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).
- (id<AGSCancelable>) elevationForPoint: | (AGSPoint *) | point | |
completion: | (void(^)(double elevation, NSError *__nullable error)) | completion | |
Elevation (in meters) at the given location on the surface.
point | on the surface. |
completion | block that will be invoked when the operation completes. |
- (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. |
+ (instancetype) surface |
|
readwritenonatomicstrong |
The background grid used with the surface.
|
readwritenonatomicassign |
The exaggeration for the surface. The altitude values of the surface data are multiplied by the exaggeration value. Default is 1.0
.
|
readwritenonatomiccopy |
The list of elevation sources in the surface. Values from all sources are combined to arrive at final elevation values for the surface.
|
readwritenonatomicassign |
Indicates whether the surface is enabled or not.
|
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.
|
readwritenonatomiccopy |
Name of the surface.
|
readwritenonatomicassign |
The type of navigation constraint from the surface.
|
readwritenonatomicassign |
Opacity of the surface. Defaults to 1
(fully opaque). Permitted values range between 0
- 1
(both inclusive). All layers in the basemap associated with this surface are affected by the opacity of the surface, as is the backgroundGrid
of the surface. The opacity of the basemap layers and background grid are multiplied by this opacity value.