summaryrefslogtreecommitdiff
path: root/platform/ios/src/MGLCompassButton.h
blob: f42d5f315d6d3748b852756102c31751e4664b28 (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
#import <UIKit/UIKit.h>
#import <CoreLocation/CoreLocation.h>

#import "MGLTypes.h"

NS_ASSUME_NONNULL_BEGIN

/**
 A specialized view that displays the current compass heading for its associated map.
 */
@interface MGLCompassButton : UIImageView

/**
 The visibility of the compass button.

 You can configure a compass button to be visible all the time or only when the compass heading changes.
 */
@property (nonatomic, assign) MGLOrnamentVisibility compassVisibility;

// TODO: Make these private
+ (instancetype)compassButton;
- (void)updateCompassWithDirection:(CLLocationDirection)direction;

@end

NS_ASSUME_NONNULL_END