ArcGIS Runtime SDK for iOS: AGSSurface.h Source File
ArcGIS Runtime SDK for iOS  100.11
AGSSurface.h
Go to the documentation of this file.
1 /*
2  COPYRIGHT 2021 ESRI
3 
4  All rights reserved under the copyright laws of the United States
5  and applicable international laws, treaties, and conventions.
6 
7  This material is licensed for use under the Esri Master License
8  Agreement (MLA), and is bound by the terms of that agreement.
9  You may redistribute and use this code without modification,
10  provided you adhere to the terms of the MLA and include this
11  copyright notice.
12 
13  See use restrictions at http://www.esri.com/legal/pdfs/mla_e204_e300/english
14 
15  For additional information, contact:
16  Environmental Systems Research Institute, Inc.
17  Attn: Contracts and Legal Services Department
18  380 New York Street
19  Redlands, California, 92373
20  USA
21 
22  email: contracts@esri.com
23  */
24  //Required for Globals API doc
26 
27 #import <Foundation/Foundation.h>
28 #import <ArcGIS/AGSLoadableBase.h>
29 
30 
31 
36 typedef NS_ENUM(NSInteger, AGSNavigationConstraint) {
39 };
40 
41 @class AGSElevationSource;
42 @class AGSPoint;
43 @class AGSBackgroundGrid;
44 
45 @protocol AGSCancelable;
46 
54 
55 #pragma mark -
56 #pragma mark initializers
57 
58 +(instancetype)surface;
59 
60 #pragma mark -
61 #pragma mark properties
62 
66 @property (nonatomic, strong, readwrite) AGSBackgroundGrid *backgroundGrid;
67 
71 @property (nonatomic, assign, readwrite) float elevationExaggeration;
72 
76 @property (nonatomic, copy, readwrite) NSArray<AGSElevationSource*> *elevationSources;
77 
81 @property (nonatomic, assign, readwrite, getter=isEnabled) BOOL enabled;
82 
86 @property (nonatomic, copy, readwrite) NSString *name;
87 
91 @property (nonatomic, assign, readwrite) AGSNavigationConstraint navigationConstraint;
92 
98 @property (nonatomic, assign, readwrite) float opacity;
99 
100 #pragma mark -
101 #pragma mark methods
102 
108 -(id<AGSCancelable>)elevationForPoint:(AGSPoint*)point completion:(void(^)(double elevation, NSError * __nullable error))completion;
109 
110 @end
111 
112 
AGSNavigationConstraint
Definition: AGSSurface.h:36
@ AGSNavigationConstraintStayAbove
Definition: AGSSurface.h:38
@ AGSNavigationConstraintNone
Definition: AGSSurface.h:37
A background grid defines the default color and context grid for display behind a map or scene surfac...
Definition: AGSBackgroundGrid.h:39
A base class for elevation sources used in a scene surface.
Definition: AGSElevationSource.h:39
A base class for loadables.
Definition: AGSLoadableBase.h:45
A location defined by x and y (and optionally z) coordinates.
Definition: AGSPoint.h:73
A surface providing elevation context for a scene.
Definition: AGSSurface.h:54
instancetype surface()
NSString * name
Definition: AGSSurface.h:86
float opacity
Definition: AGSSurface.h:98
BOOL enabled
Definition: AGSSurface.h:81
AGSBackgroundGrid * backgroundGrid
Definition: AGSSurface.h:66
NSArray< AGSElevationSource * > * elevationSources
Definition: AGSSurface.h:76
AGSNavigationConstraint navigationConstraint
Definition: AGSSurface.h:91
float elevationExaggeration
Definition: AGSSurface.h:71
A protocol exposed by operations that allow cancellation.
Definition: AGSCancelable.h:38