ArcGIS Runtime SDK for iOS: AGSLocationDisplay.h Source File
ArcGIS Runtime SDK for iOS  100.15
AGSLocationDisplay.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/AGSObject.h>
29 
30 
31 
35 typedef NS_ENUM(NSInteger, AGSLocationDisplayAutoPanMode) {
40 };
41 
42 @class AGSLocation;
43 @class AGSSymbol;
44 @class AGSPoint;
46 
65 
66 #pragma mark -
67 #pragma mark initializers
68 
69 
70 
71 #pragma mark -
72 #pragma mark properties
73 
77 @property (nonatomic, assign, readonly) BOOL started;
78 
84 @property (nonatomic, strong, readwrite) AGSLocationDataSource *dataSource;
85 
90 @property (nonatomic, assign, readwrite) AGSLocationDisplayAutoPanMode autoPanMode;
91 
98 @property (nonatomic, assign, readwrite) double initialZoomScale;
99 
105 @property (nonatomic, assign, readwrite) float navigationPointHeightFactor;
106 
112 @property (nonatomic, assign, readwrite) float wanderExtentFactor;
113 
119 @property (nullable, nonatomic, strong, readonly) AGSLocation *location;
120 
124 @property (nullable, nonatomic, copy, readonly) AGSPoint *mapLocation;
125 
129 @property (nonatomic, assign, readonly) double heading;
130 
136 @property (nullable, nonatomic, copy, readwrite) void (^autoPanModeChangedHandler)(AGSLocationDisplayAutoPanMode autoPanMode);
137 
143 @property (nullable, nonatomic, copy, readwrite) void (^locationChangedHandler)(AGSLocation *location);
144 
150 @property (nullable, nonatomic, copy, readwrite) void (^dataSourceStatusChangedHandler)(BOOL started);
151 
155 @property (nonatomic, strong, readwrite) AGSSymbol *accuracySymbol;
156 
161 @property (nonatomic, strong, readwrite) AGSSymbol *acquiringSymbol;
162 
166 @property (nonatomic, strong, readwrite) AGSSymbol *pingAnimationSymbol;
167 
171 @property (nonatomic, strong, readwrite) AGSSymbol *courseSymbol;
172 
177 @property (nonatomic, strong, readwrite) AGSSymbol *defaultSymbol;
178 
182 @property (nonatomic, strong, readwrite) AGSSymbol *headingSymbol;
183 
187 @property (nonatomic, assign, readwrite) BOOL useCourseSymbolOnMovement;
188 
193 @property (nonatomic, assign, readwrite) float opacity;
194 
198 @property (nonatomic, assign, readwrite) BOOL showAccuracy;
199 
203 @property (nonatomic, assign, readwrite) BOOL showLocation;
204 
208 @property (nonatomic, assign, readwrite) BOOL showPingAnimationSymbol;
209 
210 #pragma mark -
211 #pragma mark methods
212 
217 -(void)startWithCompletion:(nullable void(^)(NSError *__nullable error))completion;
218 
222 -(void)stop;
223 
224 @end
225 
226 
AGSLocationDisplayAutoPanMode
Definition: AGSLocationDisplay.h:35
@ AGSLocationDisplayAutoPanModeNavigation
Definition: AGSLocationDisplay.h:38
@ AGSLocationDisplayAutoPanModeCompassNavigation
Definition: AGSLocationDisplay.h:39
@ AGSLocationDisplayAutoPanModeRecenter
Definition: AGSLocationDisplay.h:37
@ AGSLocationDisplayAutoPanModeOff
Definition: AGSLocationDisplay.h:36
An abstract base class that provides location updates to AGSLocationDisplay.
Definition: AGSLocationDataSource.h:56
Displays device location on a map.
Definition: AGSLocationDisplay.h:65
AGSSymbol * courseSymbol
Definition: AGSLocationDisplay.h:171
void(^ dataSourceStatusChangedHandler)(BOOL started)
void(^ locationChangedHandler)(AGSLocation *location)
BOOL showAccuracy
Definition: AGSLocationDisplay.h:198
BOOL started
Definition: AGSLocationDisplay.h:77
BOOL useCourseSymbolOnMovement
Definition: AGSLocationDisplay.h:187
BOOL showPingAnimationSymbol
Definition: AGSLocationDisplay.h:208
AGSLocationDataSource * dataSource
Definition: AGSLocationDisplay.h:84
AGSSymbol * headingSymbol
Definition: AGSLocationDisplay.h:182
AGSSymbol * acquiringSymbol
Definition: AGSLocationDisplay.h:161
float wanderExtentFactor
Definition: AGSLocationDisplay.h:112
AGSSymbol * pingAnimationSymbol
Definition: AGSLocationDisplay.h:166
double heading
Definition: AGSLocationDisplay.h:129
AGSSymbol * defaultSymbol
Definition: AGSLocationDisplay.h:177
AGSSymbol * accuracySymbol
Definition: AGSLocationDisplay.h:155
AGSLocationDisplayAutoPanMode autoPanMode
Definition: AGSLocationDisplay.h:90
BOOL showLocation
Definition: AGSLocationDisplay.h:203
void(^ autoPanModeChangedHandler)(AGSLocationDisplayAutoPanMode autoPanMode)
float opacity
Definition: AGSLocationDisplay.h:193
double initialZoomScale
Definition: AGSLocationDisplay.h:98
AGSLocation * location
Definition: AGSLocationDisplay.h:119
AGSPoint * mapLocation
Definition: AGSLocationDisplay.h:124
float navigationPointHeightFactor
Definition: AGSLocationDisplay.h:105
Represents a location update provided by a location datasource.
Definition: AGSLocation.h:106
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:93