ArcGIS Runtime SDK for iOS: AGSMapViewCommon.h Source File
ArcGIS Runtime SDK for iOS  100.15
AGSMapViewCommon.h
Go to the documentation of this file.
1 /*
2  COPYRIGHT 2022 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/AGSGeoView.h>
29 #import <ArcGIS/AGSCancelable.h>
30 
31 
32 
36 typedef NS_ENUM(NSInteger, AGSAnimationCurve) {
59 };
60 
65 typedef NS_ENUM(NSInteger, AGSWrapAroundMode) {
68 };
69 
70 @class AGSMap;
71 @class AGSPolygon;
72 @class AGSEnvelope;
73 @class AGSPoint;
74 @class AGSLocationDisplay;
75 @class AGSBackgroundGrid;
76 @class AGSGrid;
78 @class AGSGeometry;
79 @class AGSSketchEditor;
80 
88 
89 #pragma mark -
90 #pragma mark initializers
91 #pragma mark -
92 
93 #pragma mark -
94 #pragma mark properties
95 #pragma mark -
96 
103 @property (nullable, nonatomic, strong, readwrite) AGSMap *map;
104 
108 @property (nullable, nonatomic, strong, readwrite) AGSGrid *grid;
109 
122 @property (nullable, nonatomic, strong, readwrite) AGSBackgroundGrid *backgroundGrid;
123 
127 @property (nonatomic, assign, readonly) double rotation;
128 
132 @property (nonatomic, assign, readonly) double mapScale;
133 
137 @property (nonatomic, assign, readonly) double unitsPerPoint;
138 
147 @property (nullable, nonatomic, strong, readonly) AGSPolygon *visibleArea;
148 
152 @property (nonatomic, strong, readwrite) AGSLocationDisplay *locationDisplay;
153 
157 @property (nullable, nonatomic, strong, readwrite) AGSSketchEditor *sketchEditor;
158 
159 #pragma mark - behavioral
160 
164 @property (nonatomic, strong, readwrite) AGSMapViewInteractionOptions *interactionOptions;
165 
170 @property (nonatomic, assign, readwrite) AGSWrapAroundMode wrapAroundMode;
171 
177 @property (nonatomic, assign, readwrite) UIEdgeInsets contentInset;
178 
183 @property (nonatomic, assign, readonly) UIEdgeInsets adjustedContentInset;
184 
191 @property (nonatomic, assign, readwrite) BOOL insetsContentInsetFromSafeArea;
192 
193 #pragma mark -
194 #pragma mark methods
195 
196 #pragma mark -
197 #pragma mark conversion methods
198 
204 -(CGPoint)locationToScreen:(AGSPoint *)mapLocation;
205 
211 -(AGSPoint*)screenToLocation:(CGPoint)screen;
212 
213 #pragma mark navigation methods
214 
224 -(id<AGSCancelable>)setViewpoint:(AGSViewpoint*)viewpoint duration:(double)duration curve:(AGSAnimationCurve)curve completion:(nullable void(^)(BOOL finished))completion;
225 
233 -(id<AGSCancelable>)setViewpointCenter:(AGSPoint*)center completion:(nullable void(^)(BOOL finished))completion;
234 
243 -(id<AGSCancelable>)setViewpointCenter:(AGSPoint*)center scale:(double)scale completion:(nullable void(^)(BOOL finished))completion;
244 
252 -(id<AGSCancelable>)setViewpointScale:(double)scale completion:(nullable void(^)(BOOL finished))completion;
253 
261 -(id<AGSCancelable>)setViewpointRotation:(double)angle completion:(nullable void(^)(BOOL finished))completion;
262 
270 -(id<AGSCancelable>)setViewpointGeometry:(AGSGeometry*)geometry completion:(nullable void(^)(BOOL finished))completion;
271 
280 -(id<AGSCancelable>)setViewpointGeometry:(AGSGeometry*)geometry padding:(double)paddingInScreenPoints completion:(nullable void(^)(BOOL finished))completion;
281 
282 @end
283 
284 
AGSAnimationCurve
Definition: AGSMapViewCommon.h:36
@ AGSAnimationCurveEaseOutQuint
Definition: AGSMapViewCommon.h:48
@ AGSAnimationCurveEaseInOutCubic
Definition: AGSMapViewCommon.h:43
@ AGSAnimationCurveEaseOutQuad
Definition: AGSMapViewCommon.h:39
@ AGSAnimationCurveEaseInOutSine
Definition: AGSMapViewCommon.h:52
@ AGSAnimationCurveEaseInCirc
Definition: AGSMapViewCommon.h:56
@ AGSAnimationCurveEaseOutQuart
Definition: AGSMapViewCommon.h:45
@ AGSAnimationCurveEaseOutExpo
Definition: AGSMapViewCommon.h:54
@ AGSAnimationCurveEaseInOutQuad
Definition: AGSMapViewCommon.h:40
@ AGSAnimationCurveEaseInOutQuart
Definition: AGSMapViewCommon.h:46
@ AGSAnimationCurveEaseOutCubic
Definition: AGSMapViewCommon.h:42
@ AGSAnimationCurveEaseInCubic
Definition: AGSMapViewCommon.h:41
@ AGSAnimationCurveEaseOutSine
Definition: AGSMapViewCommon.h:51
@ AGSAnimationCurveEaseInQuint
Definition: AGSMapViewCommon.h:47
@ AGSAnimationCurveEaseInExpo
Definition: AGSMapViewCommon.h:53
@ AGSAnimationCurveEaseInQuart
Definition: AGSMapViewCommon.h:44
@ AGSAnimationCurveEaseInOutQuint
Definition: AGSMapViewCommon.h:49
@ AGSAnimationCurveEaseOutCirc
Definition: AGSMapViewCommon.h:57
@ AGSAnimationCurveEaseInOutCirc
Definition: AGSMapViewCommon.h:58
@ AGSAnimationCurveEaseInQuad
Definition: AGSMapViewCommon.h:38
@ AGSAnimationCurveLinear
Definition: AGSMapViewCommon.h:37
@ AGSAnimationCurveEaseInSine
Definition: AGSMapViewCommon.h:50
@ AGSAnimationCurveEaseInOutExpo
Definition: AGSMapViewCommon.h:55
AGSWrapAroundMode
Definition: AGSMapViewCommon.h:65
@ AGSWrapAroundModeEnabledWhenSupported
Definition: AGSMapViewCommon.h:66
@ AGSWrapAroundModeDisabled
Definition: AGSMapViewCommon.h:67
A background grid defines the default color and context grid for display behind a map or scene surfac...
Definition: AGSBackgroundGrid.h:39
A geometry that represents a rectangular shape.
Definition: AGSEnvelope.h:55
A base class for all views that can display geographic content on screen.
Definition: AGSGeoView.h:67
Base class for all classes that represent geometric shapes.
Definition: AGSGeometry.h:121
A base class for displaying coordinate system grids on a map.
Definition: AGSGrid.h:70
Displays device location on a map.
Definition: AGSLocationDisplay.h:65
A map containing 2D geographic content.
Definition: AGSMap.h:61
A base class for AGSMapView.
Definition: AGSMapViewCommon.h:88
UIEdgeInsets contentInset
Definition: AGSMapViewCommon.h:177
AGSPolygon * visibleArea
Definition: AGSMapViewCommon.h:147
AGSMap * map
Definition: AGSMapViewCommon.h:103
AGSWrapAroundMode wrapAroundMode
Definition: AGSMapViewCommon.h:170
AGSBackgroundGrid * backgroundGrid
Definition: AGSMapViewCommon.h:122
AGSSketchEditor * sketchEditor
Definition: AGSMapViewCommon.h:157
AGSMapViewInteractionOptions * interactionOptions
Definition: AGSMapViewCommon.h:164
double mapScale
Definition: AGSMapViewCommon.h:132
double unitsPerPoint
Definition: AGSMapViewCommon.h:137
UIEdgeInsets adjustedContentInset
Definition: AGSMapViewCommon.h:183
AGSGrid * grid
Definition: AGSMapViewCommon.h:108
double rotation
Definition: AGSMapViewCommon.h:127
BOOL insetsContentInsetFromSafeArea
Definition: AGSMapViewCommon.h:191
AGSLocationDisplay * locationDisplay
Definition: AGSMapViewCommon.h:152
Options to configure Map View user interactions.
Definition: AGSMapViewInteractionOptions.h:36
A location defined by x and y (and optionally z) coordinates.
Definition: AGSPoint.h:73
A multipart shape used to represent an area.
Definition: AGSPolygon.h:78
A class that allows the user to sketch geometries on the map.
Definition: AGSSketchEditor.h:75
Represents the view location of an AGSMapView or AGSSceneView object.
Definition: AGSViewpoint.h:51
A protocol exposed by operations that allow cancellation.
Definition: AGSCancelable.h:38