ArcGIS Runtime SDK for iOS: AGSLocationDisplay.h Source File
ArcGIS Runtime SDK for iOS  100.11
AGSLocationDisplay.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/AGSObject.h>
29 
30 
31 
36 typedef NS_ENUM(NSInteger, AGSLocationDisplayAutoPanMode) {
41 };
42 
43 @class AGSLocation;
44 @class AGSSymbol;
45 @class AGSPoint;
47 
66 
67 #pragma mark -
68 #pragma mark initializers
69 
70 
71 
72 #pragma mark -
73 #pragma mark properties
74 
78 @property (nonatomic, assign, readonly) BOOL started;
79 
85 @property (nonatomic, strong, readwrite) AGSLocationDataSource *dataSource;
86 
91 @property (nonatomic, assign, readwrite) AGSLocationDisplayAutoPanMode autoPanMode;
92 
99 @property (nonatomic, assign, readwrite) double initialZoomScale;
100 
106 @property (nonatomic, assign, readwrite) float navigationPointHeightFactor;
107 
113 @property (nonatomic, assign, readwrite) float wanderExtentFactor;
114 
120 @property (nullable, nonatomic, strong, readonly) AGSLocation *location;
121 
125 @property (nullable, nonatomic, copy, readonly) AGSPoint *mapLocation;
126 
130 @property (nonatomic, assign, readonly) double heading;
131 
137 @property (nullable, nonatomic, copy, readwrite) void (^autoPanModeChangedHandler)(AGSLocationDisplayAutoPanMode autoPanMode);
138 
144 @property (nullable, nonatomic, copy, readwrite) void (^locationChangedHandler)(AGSLocation *location);
145 
151 @property (nullable, nonatomic, copy, readwrite) void (^dataSourceStatusChangedHandler)(BOOL started);
152 
156 @property (nonatomic, strong, readwrite) AGSSymbol *accuracySymbol;
157 
162 @property (nonatomic, strong, readwrite) AGSSymbol *acquiringSymbol;
163 
167 @property (nonatomic, strong, readwrite) AGSSymbol *pingAnimationSymbol;
168 
172 @property (nonatomic, strong, readwrite) AGSSymbol *courseSymbol;
173 
178 @property (nonatomic, strong, readwrite) AGSSymbol *defaultSymbol;
179 
183 @property (nonatomic, strong, readwrite) AGSSymbol *headingSymbol;
184 
188 @property (nonatomic, assign, readwrite) BOOL useCourseSymbolOnMovement;
189 
194 @property (nonatomic, assign, readwrite) float opacity;
195 
199 @property (nonatomic, assign, readwrite) BOOL showAccuracy;
200 
204 @property (nonatomic, assign, readwrite) BOOL showLocation;
205 
209 @property (nonatomic, assign, readwrite) BOOL showPingAnimationSymbol;
210 
211 #pragma mark -
212 #pragma mark methods
213 
218 -(void)startWithCompletion:(nullable void(^)(NSError *__nullable error))completion;
219 
223 -(void)stop;
224 
225 @end
226 
227 
AGSLocationDisplayAutoPanMode
Definition: AGSLocationDisplay.h:36
@ AGSLocationDisplayAutoPanModeNavigation
Definition: AGSLocationDisplay.h:39
@ AGSLocationDisplayAutoPanModeCompassNavigation
Definition: AGSLocationDisplay.h:40
@ AGSLocationDisplayAutoPanModeRecenter
Definition: AGSLocationDisplay.h:38
@ AGSLocationDisplayAutoPanModeOff
Definition: AGSLocationDisplay.h:37
An abstract base class that provides location updates to AGSLocationDisplay.
Definition: AGSLocationDataSource.h:55
Displays device location on a map.
Definition: AGSLocationDisplay.h:66
AGSSymbol * courseSymbol
Definition: AGSLocationDisplay.h:172
void(^ dataSourceStatusChangedHandler)(BOOL started)
void(^ locationChangedHandler)(AGSLocation *location)
BOOL showAccuracy
Definition: AGSLocationDisplay.h:199
BOOL started
Definition: AGSLocationDisplay.h:78
BOOL useCourseSymbolOnMovement
Definition: AGSLocationDisplay.h:188
BOOL showPingAnimationSymbol
Definition: AGSLocationDisplay.h:209
AGSLocationDataSource * dataSource
Definition: AGSLocationDisplay.h:85
AGSSymbol * headingSymbol
Definition: AGSLocationDisplay.h:183
AGSSymbol * acquiringSymbol
Definition: AGSLocationDisplay.h:162
float wanderExtentFactor
Definition: AGSLocationDisplay.h:113
AGSSymbol * pingAnimationSymbol
Definition: AGSLocationDisplay.h:167
double heading
Definition: AGSLocationDisplay.h:130
AGSSymbol * defaultSymbol
Definition: AGSLocationDisplay.h:178
AGSSymbol * accuracySymbol
Definition: AGSLocationDisplay.h:156
AGSLocationDisplayAutoPanMode autoPanMode
Definition: AGSLocationDisplay.h:91
BOOL showLocation
Definition: AGSLocationDisplay.h:204
void(^ autoPanModeChangedHandler)(AGSLocationDisplayAutoPanMode autoPanMode)
float opacity
Definition: AGSLocationDisplay.h:194
double initialZoomScale
Definition: AGSLocationDisplay.h:99
AGSLocation * location
Definition: AGSLocationDisplay.h:120
AGSPoint * mapLocation
Definition: AGSLocationDisplay.h:125
float navigationPointHeightFactor
Definition: AGSLocationDisplay.h:106
Represents a location update provided by a location datasource.
Definition: AGSLocation.h:73
Definition: AGSObject.h:28
A location defined by x and y (and optionally z) coordinates.
Definition: AGSPoint.h:73
A symbol used to display a graphic or a feature.
Definition: AGSSymbol.h:91