ArcGIS Runtime SDK for iOS
100.15
|
Used to display point or multipoint AGSGeoElement
in a scene using a 3D model.
Instances of this class represent a marker symbol based on a 3D model that can be displayed in a scene by AGSSceneview
.
The following file formats are supported -
AGSGraphicsOverlay::renderingMode
for graphics and AGSFeatureLayer::renderingMode
for feature layers. Instance Methods | |
(void) | - cancelLoad |
(id< AGSCancelable >) | - createSwatchWithBackgroundColor:screen:completion: |
(id< AGSCancelable >) | - createSwatchWithCompletion: |
(id< AGSCancelable >) | - createSwatchWithGeometry:width:height:screen:backgroundColor:completion: |
(nullable id< AGSCancelable >) | - createSwatchWithWidth:height:screen:backgroundColor:completion: |
(instancetype) | - initWithName:extension:scale: |
(instancetype) | - initWithURL:scale: |
(BOOL) | - isEqualToSymbol: |
(void) | - loadWithCompletion: |
(void) | - retryLoadWithCompletion: |
(nullable id) | - toJSON: |
Class Methods | |
(nullable id< AGSJSONSerializable >) | + fromJSON:error: |
(instancetype) | + modelSceneSymbolWithName:extension:scale: |
(instancetype) | + modelSceneSymbolWithURL:scale: |
Properties | |
AGSSceneSymbolAnchorPosition | anchorPosition |
AGSColor * | color |
AGSCredential * | credential |
double | depth |
double | heading |
double | height |
NSError * | loadError |
AGSLoadStatus | loadStatus |
double | pitch |
AGSRequestConfiguration * | requestConfiguration |
double | roll |
AGSSymbolSizeUnits | symbolSizeUnits |
NSDictionary< NSString *, id > * | unknownJSON |
NSDictionary< NSString *, id > * | unsupportedJSON |
NSURL * | URL |
double | width |
|
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
- (id<AGSCancelable>) createSwatchWithBackgroundColor: | (nullable AGSColor *) | backgroundColor | |
screen: | (nullable AGSScreen *) | screen | |
completion: | (void(^)(AGSImage *__nullable swatch, NSError *__nullable error)) | completion | |
Creates swatch with provided background color.
backgroundColor | Desired background color of the image. |
screen | Screen that the swatch will be rendered for. If you specify nil then the main screen will be used. |
completion | A block that is invoked when the operation completes. |
- (id<AGSCancelable>) createSwatchWithCompletion: | (void(^)(AGSImage *__nullable swatch, NSError *__nullable error)) | completion |
Creates a swatch with a clear background color. This method uses main screen's scale to determine the size of the image.
completion | block that is invoked when operation completes. |
- (id<AGSCancelable>) createSwatchWithGeometry: | (AGSGeometry *) | geometry | |
width: | (NSInteger) | width | |
height: | (NSInteger) | height | |
screen: | (nullable AGSScreen *) | screen | |
backgroundColor: | (nullable AGSColor *) | backgroundColor | |
completion: | (void(^)(AGSImage *__nullable swatch, NSError *__nullable error)) | completion | |
Creates a swatch using the provided geometry and other parameters. This is the most configurable of the methods to create swatches. You can pass the pixels per inch that you would like the image to be rendered at. This will determine how many pixels are used to render symbols of sizes that are specified in points.
geometry | The geometry of the symbol to be drawn in the swatch image. The specified geometry is in DIPs, with the point {0,0} located at the center of the swatch image. The X-axis increases towards the right side of the swatch image. The Y-axis increases towards the top of the swatch image. For example: when creating a swatch for an AGSMarkerSymbol , specifying a geometry of {10,10} will draw the marker 10 DIPs up and to the right of the center of the swatch. The geometry type (AGSPoint , AGSPolyline , AGSPolygon ) should correspond to the symbol type (AGSMarkerSymbol , AGSLineSymbol , AGSFillSymbol ). The geometry's spatial reference is ignored. |
width | Desired width of the image in pixels. |
height | Desired height of the image in pixels. |
screen | The screen that the swatch will be rendered for. If you specify nil then the main screen will be used. |
backgroundColor | The desired background color of the image. |
completion | A block that is invoked when operation completes. |
- (nullable id<AGSCancelable>) createSwatchWithWidth: | (NSInteger) | width | |
height: | (NSInteger) | height | |
screen: | (nullable AGSScreen *) | screen | |
backgroundColor: | (nullable AGSColor *) | backgroundColor | |
completion: | (void(^)(AGSImage *__nullable swatch, NSError *__nullable error)) | completion | |
|
staticrequiredinherited |
Initializes and returns an object from its JSON representation.
JSONObject | NSDictionary or NSArray containing the JSON. |
error | encountered during the operation, if any. |
- (instancetype) initWithName: | (NSString *) | name | |
extension: | (NSString *) | extension | |
scale: | (float) | scale | |
Initialize a model marker symbol with a model file within the application bundle or shared documents directory.
name | of the model file |
extension | of the model file |
scale | factor to adjust the size of the model |
AGSGraphicsOverlay::renderingMode
for graphics and AGSFeatureLayer::renderingMode
for feature layers. - (instancetype) initWithURL: | (NSURL *) | URL | |
scale: | (float) | scale | |
Initialize a model marker symbol with a URL to a model file on the network or on disk.
URL | to the model file on the network or on disk |
scale | factor to adjust the size of the model |
AGSGraphicsOverlay::renderingMode
for graphics and AGSFeatureLayer::renderingMode
for feature layers. - (BOOL) isEqualToSymbol: | (AGSSymbol *) | other |
Compares this symbol to another for equality.
other | The other symbol to compare this one to. |
YES
if the two symbols are equal, otherwise NO
.
|
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 + (instancetype) modelSceneSymbolWithName: | (NSString *) | name | |
extension: | (NSString *) | extension | |
scale: | (float) | scale | |
Initialize a model marker symbol with a model file within the application bundle or shared documents directory.
name | of the model file |
extension | of the model file |
scale | factor to adjust the size of the model |
AGSGraphicsOverlay::renderingMode
for graphics and AGSFeatureLayer::renderingMode
for feature layers. + (instancetype) modelSceneSymbolWithURL: | (NSURL *) | URL | |
scale: | (float) | scale | |
Initialize a model marker symbol with a URL to a model file on the network or on disk.
URL | to the model file on the network or on disk |
scale | factor to adjust the size of the model |
AGSGraphicsOverlay::renderingMode
for graphics and AGSFeatureLayer::renderingMode
for feature layers.
|
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. |
|
requiredinherited |
Returns JSON representation for this object.
error | encountered during the operation, if any. |
NSDictionary
or NSArray
containing the JSON. Reimplemented in AGSPortalItem.
|
readwritenonatomicassigninherited |
Specifies how the symbol should be anchored in 3D space. Default is Bottom
.
|
readwritenonatomicstronginherited |
Color of the 3D marker symbol
|
readwritenonatomicstronginherited |
Security credentials to access the remote resource. Only applicable if the resource is secured.
|
readwritenonatomicassigninherited |
Depth of the 3D marker symbol, in meters.
|
readwritenonatomicassigninherited |
Heading of the 3D marker symbol, degrees. Default value is 0
|
readwritenonatomicassigninherited |
Height of the 3D marker symbol, in meters.
|
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.
|
readwritenonatomicassigninherited |
Pitch of the 3D marker symbol, in degrees. Default value is 0.
|
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.
|
readwritenonatomicassigninherited |
Roll of the 3D marker symbol, in degrees. Default value is 0.
|
readwritenonatomicassign |
The size unit of the model scene symbol.
|
readrequirednonatomiccopyinherited |
A dictionary of values that was in the source JSON but was unparsed by API.
NSDictionary
containing the unknown JSON.
|
readnonatomiccopyinherited |
A dictionary of values that are supported by the REST API, but not exposed through the SDK API.
NSDictionary
containing the unsupported JSON.
|
readrequirednonatomicstronginherited |
The URL of the remote resource.
|
readwritenonatomicassigninherited |
Width of the 3D marker symbol, in meters.