aboutsummaryrefslogtreecommitdiff
path: root/iosApp/WhirlyGlobeMaplyComponent.xcframework/ios-arm64_x86_64-simulator/WhirlyGlobeMaplyComponent.framework/Headers/MaplyLocationTracker.h
blob: d759183fe7582de4505faba23263ade42964b953 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
/*
 *  MaplyBaseViewController.h
 *  MaplyComponent
 *
 *  Created by Ranen Ghosh on 11/23/16.
 *  Copyright 2012-2022 mousebird consulting
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *  http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *
 */

#import <UIKit/UIKit.h>
#import <CoreLocation/CoreLocation.h>
#import <WhirlyGlobeMaplyComponent/MaplyCoordinate.h>

#define LOC_TRACKER_POS_MARKER_SIZE 32

@class MaplyBaseViewController;

typedef struct
{
    float lonDeg;
    float latDeg;
    float headingDeg;
} MaplyLocationTrackerSimulationPoint;

typedef enum {MaplyLocationLockNone, MaplyLocationLockNorthUp, MaplyLocationLockHeadingUp, MaplyLocationLockHeadingUpOffset} MaplyLocationLockType;

/* 
    Implement the MaplyLocationTrackerDelegate protocol to receive location services callbacks.
*/
@protocol MaplyLocationTrackerDelegate

// This is to handle problems / failures further up the line.
- (void) locationManager:(CLLocationManager * __nonnull)manager didFailWithError:(NSError * __nonnull)error;

- (void) locationManager:(CLLocationManager * __nonnull)manager didChangeAuthorizationStatus:(CLAuthorizationStatus)status;

@optional

- (void) updateLocation:(CLLocation * __nonnull)location;

@end

/*
    Implement the MaplyLocationSimulatorDelegate protocol to provide simulated locations
*/
@protocol MaplyLocationSimulatorDelegate

- (MaplyLocationTrackerSimulationPoint)getSimulationPoint;

@optional

- (bool)hasValidLocation;

@end

/* 
    The MaplyLocationTracker class provides support for showing current position and heading on the map or globe.
   
    Be sure to set NSLocationWhenInUseUsageDescription in your app's Info.plist before using.
 */
@interface MaplyLocationTracker : NSObject <CLLocationManagerDelegate>

/// Exposes MaplyLocationTracker's location manager for use elsewhere
@property (nonatomic, readonly, nullable) CLLocationManager *locationManager;

/**
    MaplyLocationTracker constructor
 
    @param viewC The globe or map view controller
 
    @param useHeading Use location services heading information (requires physical magnetometer)
 
    @param useCourse Use location services course information as fallback if heading unavailable
 */
- (nonnull instancetype)initWithViewC:(MaplyBaseViewController *__nullable)viewC
                           useHeading:(bool)useHeading
                            useCourse:(bool)useCourse;

/** 
    MaplyLocationTracker constructor
 
    @param viewC The globe or map view controller
 
    @param delegate The MaplyLocationTrackerDelegate for receiving location event callbacks
 
    @param useHeading Use location services heading information (requires physical magnetometer)
 
    @param useCourse Use location services course information as fallback if heading unavailable
 */
- (nonnull instancetype)initWithViewC:(MaplyBaseViewController *__nullable)viewC
                             delegate:(NSObject<MaplyLocationTrackerDelegate> *__nullable)delegate
                           useHeading:(bool)useHeading
                            useCourse:(bool)useCourse;

/**
    MaplyLocationTracker constructor
 
    @param viewC The globe or map view controller
 
    @param delegate The MaplyLocationTrackerDelegate for receiving location event callbacks

    @param simulator  The MaplyLocationSimulatorDelegate for generating simulated locations

    @param useHeading Use location services heading information (requires physical magnetometer)
 
    @param useCourse Use location services course information as fallback if heading unavailable
 */
- (nonnull instancetype)initWithViewC:(MaplyBaseViewController *__nullable)viewC
                             delegate:(NSObject<MaplyLocationTrackerDelegate> *__nullable)delegate
                            simulator:(NSObject<MaplyLocationSimulatorDelegate> *__nullable)simulator
                          simInterval:(NSTimeInterval)simInterval
                           useHeading:(bool)useHeading
                            useCourse:(bool)useCourse;

/**
    Min/max visibility for the marker assigned to follow location.
  */
@property (nonatomic,assign) float markerMinVis,markerMaxVis;

/**
    Draw priority for the marker assigned to follow location.
  */
@property (nonatomic,assign) int markerDrawPriority;

/** 
    Change lock type
 
    @param lockType The MaplyLocationLockType value for lock behavior
 
    @param forwardTrackOffset The vertical offset if using MaplyLocationLockHeadingUpOffset (positive values are below the view center)
 */
- (void) changeLockType:(MaplyLocationLockType)lockType forwardTrackOffset:(int)forwardTrackOffset;

/** 
    Stop the MaplyLocationTracker behavior and shut it down.
 */
- (void) teardown;

/** 
    Get the current device location
 
    @return The coordinate if valid, else kMaplyNullCoordinate
 */
- (MaplyCoordinate)getLocation;

/**
    Set the current simulated location.
 */
- (void) setLocation:(MaplyLocationTrackerSimulationPoint)point
            altitude:(double)altitude;

/**
    Set the current simulated location.
 */
- (void) setLocation:(MaplyLocationTrackerSimulationPoint)point
            altitude:(double)altitude
  horizontalAccuracy:(double)horizontalAccuracy
    verticalAccuracy:(double)verticalAccuracy
               speed:(double)speed;
;

@end