AGSLocationDisplay.h

Go to the documentation of this file.

/*
 COPYRIGHT 1995-2020 ESRI
 
 TRADE SECRETS: ESRI PROPRIETARY AND CONFIDENTIAL
 Unpublished material - all rights reserved under the
 Copyright Laws of the United States and applicable international
 laws, treaties, and conventions.
 
 For additional information, contact:
 Environmental Systems Research Institute, Inc.
 Attn: Contracts and Legal Services Department
 380 New York Street
 Redlands, California, 92373
 USA
 
 email: contracts@esri.com
 */
 //Required for Globals API doc

#import <ArcGIS/AGSObject.h>



typedef NS_ENUM(NSInteger, AGSLocationDisplayAutoPanMode) {
    AGSLocationDisplayAutoPanModeOff = 0,               
    AGSLocationDisplayAutoPanModeRecenter = 1,          
    AGSLocationDisplayAutoPanModeNavigation = 2,        
    AGSLocationDisplayAutoPanModeCompassNavigation = 3  
};

@class AGSLocation;
@class AGSSymbol;
@class AGSPoint;
@class AGSLocationDataSource;

@interface AGSLocationDisplay : AGSObject

#pragma mark -
#pragma mark initializers



#pragma mark -
#pragma mark properties

@property (nonatomic, assign, readonly) BOOL started;

@property (nonatomic, strong, readwrite) AGSLocationDataSource *dataSource;

@property (nonatomic, assign, readwrite) AGSLocationDisplayAutoPanMode autoPanMode;

@property (nonatomic, assign, readwrite) double initialZoomScale;

@property (nonatomic, assign, readwrite) float navigationPointHeightFactor;

@property (nonatomic, assign, readwrite) float wanderExtentFactor;

@property (nullable, nonatomic, strong, readonly) AGSLocation *location;


@property (nullable, nonatomic, copy, readonly) AGSPoint *mapLocation;


@property (nonatomic, assign, readonly) double heading;

@property (nullable, nonatomic, copy, readwrite) void (^autoPanModeChangedHandler)(AGSLocationDisplayAutoPanMode autoPanMode);

@property (nullable, nonatomic, copy, readwrite) void (^locationChangedHandler)(AGSLocation *location);

@property (nullable, nonatomic, copy, readwrite) void (^dataSourceStatusChangedHandler)(BOOL started);

@property (nonatomic, strong, readwrite) AGSSymbol *accuracySymbol;

@property (nonatomic, strong, readwrite) AGSSymbol *acquiringSymbol;

@property (nonatomic, strong, readwrite) AGSSymbol *pingAnimationSymbol;

@property (nonatomic, strong, readwrite) AGSSymbol *courseSymbol;

@property (nonatomic, strong, readwrite) AGSSymbol *defaultSymbol;

@property (nonatomic, strong, readwrite) AGSSymbol *headingSymbol;

@property (nonatomic, assign, readwrite) BOOL useCourseSymbolOnMovement;

@property (nonatomic, assign, readwrite) float opacity;

@property (nonatomic, assign, readwrite) BOOL showAccuracy;

@property (nonatomic, assign, readwrite) BOOL showLocation;

@property (nonatomic, assign, readwrite) BOOL showPingAnimationSymbol;

#pragma mark -
#pragma mark methods

-(void)startWithCompletion:(nullable void(^)(NSError *__nullable error))completion;

-(void)stop;

@end