ArcGIS Runtime SDK for iOS
100.15
|
A 3D marker symbol based on simple shapes.
Instances of this class represent 3D marker scene symbols such as cone, cube, cylinder, sphere, diamond, and tetrahedron that can be rendered by AGSSceneView
in a scene.
Instance Methods | |
(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) | - initWithStyle:color:height:width:depth:anchorPosition: |
(BOOL) | - isEqualToSymbol: |
(nullable id) | - toJSON: |
Class Methods | |
(instancetype) | + coneWithColor:diameter:height: |
(instancetype) | + coneWithColor:diameter:height:anchorPosition: |
(instancetype) | + cubeWithColor:size: |
(instancetype) | + cubeWithColor:size:anchorPosition: |
(instancetype) | + cylinderWithColor:diameter:height: |
(instancetype) | + cylinderWithColor:diameter:height:anchorPosition: |
(instancetype) | + diamondWithColor:size:height: |
(instancetype) | + diamondWithColor:size:height:anchorPosition: |
(nullable id< AGSJSONSerializable >) | + fromJSON:error: |
(instancetype) | + simpleMarkerSceneSymbol |
(instancetype) | + simpleMarkerSceneSymbolWithStyle:color:height:width:depth:anchorPosition: |
(instancetype) | + sphereWithColor:diameter: |
(instancetype) | + sphereWithColor:diameter:anchorPosition: |
(instancetype) | + tetrahedronWithColor:size:height: |
(instancetype) | + tetrahedronWithColor:size:height:anchorPosition: |
Properties | |
AGSSceneSymbolAnchorPosition | anchorPosition |
AGSColor * | color |
double | depth |
double | heading |
double | height |
double | pitch |
double | roll |
AGSSimpleMarkerSceneSymbolStyle | style |
NSDictionary< NSString *, id > * | unknownJSON |
NSDictionary< NSString *, id > * | unsupportedJSON |
double | width |
+ (instancetype) coneWithColor: | (AGSColor *) | color | |
diameter: | (double) | diameter | |
height: | (double) | height | |
Creates a new 3D cone symbol with the provided arguments.
color | of the symbol. |
diameter | of cone's base, in meters. |
height | of the cone, in meters. |
+ (instancetype) coneWithColor: | (AGSColor *) | color | |
diameter: | (double) | diameter | |
height: | (double) | height | |
anchorPosition: | (AGSSceneSymbolAnchorPosition) | anchorPosition | |
Creates a new 3D cone symbol with the provided arguments.
color | of the symbol. |
diameter | of cone's base, in meters. |
height | of the cone, in meters. |
anchorPosition | of the symbol in 3D space. |
- (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 | |
+ (instancetype) cubeWithColor: | (AGSColor *) | color | |
size: | (double) | size | |
Creates a new 3D cube symbol with the provided arguments.
color | of the symbol. |
size | of the symbol, in meters. |
+ (instancetype) cubeWithColor: | (AGSColor *) | color | |
size: | (double) | size | |
anchorPosition: | (AGSSceneSymbolAnchorPosition) | anchorPosition | |
Creates a new 3D cube symbol with the provided arguments.
color | of the symbol. |
size | of the symbol, in meters. |
anchorPosition | of the symbol in 3D space. |
+ (instancetype) cylinderWithColor: | (AGSColor *) | color | |
diameter: | (double) | diameter | |
height: | (double) | height | |
Creates a new 3D cylinder symbol with the provided arguments.
color | of the symbol. |
diameter | of cylinder's base, in meters. |
height | of the cylinder, in meters. |
+ (instancetype) cylinderWithColor: | (AGSColor *) | color | |
diameter: | (double) | diameter | |
height: | (double) | height | |
anchorPosition: | (AGSSceneSymbolAnchorPosition) | anchorPosition | |
Creates a new 3D cylinder symbol with the provided arguments.
color | of the symbol. |
diameter | of cylinder's base, in meters. |
height | of the cylinder, in meters. |
anchorPosition | of the symbol in 3D space. |
+ (instancetype) diamondWithColor: | (AGSColor *) | color | |
size: | (double) | size | |
height: | (double) | height | |
Creates a new 3D diamond symbol with the provided arguments.
color | of the symbol. |
size | of the symbol, in meters. |
+ (instancetype) diamondWithColor: | (AGSColor *) | color | |
size: | (double) | size | |
height: | (double) | height | |
anchorPosition: | (AGSSceneSymbolAnchorPosition) | anchorPosition | |
Creates a new 3D diamond symbol with the provided arguments.
color | of the symbol. |
size | of the symbol, in meters. |
anchorPosition | of the symbol in 3D space. |
|
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) initWithStyle: | (AGSSimpleMarkerSceneSymbolStyle) | style | |
color: | (AGSColor *) | color | |
height: | (double) | height | |
width: | (double) | width | |
depth: | (double) | depth | |
anchorPosition: | (AGSSceneSymbolAnchorPosition) | anchorPosition | |
Creates a new 3D simple marker scene symbol with the provided arguments.
style | of the symbol. |
color | of the symbol. |
height | of the symbol, in meters. |
width | of the symbol, in meters. |
depth | of the symbol, in meters. |
anchorPosition | of the symbol in 3D space. |
- (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
. + (instancetype) simpleMarkerSceneSymbol |
+ (instancetype) simpleMarkerSceneSymbolWithStyle: | (AGSSimpleMarkerSceneSymbolStyle) | style | |
color: | (AGSColor *) | color | |
height: | (double) | height | |
width: | (double) | width | |
depth: | (double) | depth | |
anchorPosition: | (AGSSceneSymbolAnchorPosition) | anchorPosition | |
Creates a new 3D simple marker scene symbol with the provided arguments.
style | of the symbol. |
color | of the symbol. |
height | of the symbol, in meters. |
width | of the symbol, in meters. |
depth | of the symbol, in meters. |
anchorPosition | of the symbol in 3D space. |
+ (instancetype) sphereWithColor: | (AGSColor *) | color | |
diameter: | (double) | diameter | |
Creates a new 3D sphere symbol with the provided arguments.
color | of the symbol. |
diameter | of the symbol, in meters. |
+ (instancetype) sphereWithColor: | (AGSColor *) | color | |
diameter: | (double) | diameter | |
anchorPosition: | (AGSSceneSymbolAnchorPosition) | anchorPosition | |
Creates a new 3D sphere symbol with the provided arguments.
color | of the symbol. |
diameter | of the symbol, in meters. |
anchorPosition | of the symbol in 3D space. |
+ (instancetype) tetrahedronWithColor: | (AGSColor *) | color | |
size: | (double) | size | |
height: | (double) | height | |
Creates a new 3D tetrahedron symbol with the provided arguments.
color | of the symbol. |
size | of the symbol, in meters. |
height | of the symbol, in meters. |
+ (instancetype) tetrahedronWithColor: | (AGSColor *) | color | |
size: | (double) | size | |
height: | (double) | height | |
anchorPosition: | (AGSSceneSymbolAnchorPosition) | anchorPosition | |
Creates a new 3D tetrahedron symbol with the provided arguments.
color | of the symbol. |
size | of the symbol, in meters. |
height | of the symbol, in meters. |
anchorPosition | of the symbol in 3D space. |
|
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
|
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.
|
readwritenonatomicassigninherited |
Pitch of the 3D marker symbol, in degrees. Default value is 0.
|
readwritenonatomicassigninherited |
Roll of the 3D marker symbol, in degrees. Default value is 0.
|
readwritenonatomicassign |
The 3D marker's style.
|
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.
|
readwritenonatomicassigninherited |
Width of the 3D marker symbol, in meters.