From 619130afaf96a469cd0442bbed71f18f615fa61c Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Minh=20Nguy=E1=BB=85n?= <mxn@1ec5.org>
Date: Thu, 2 Jul 2015 13:25:18 -0700
Subject: [PATCH] Turned the compass into a button

Touching down on the compass but dragging outside it should cause the map to pan, not reset to north. Also renamed the property to reflect its new type.

This change obsoletes part of 90af18e708b617591766950413e3691449cad2ce but leaves out the accessibility-related changes there.
---
 include/mbgl/ios/MGLMapView.h |  4 ++--
 platform/ios/MGLMapView.mm    | 39 +++++++++++++++++++----------------
 2 files changed, 23 insertions(+), 20 deletions(-)

diff --git a/include/mbgl/ios/MGLMapView.h b/include/mbgl/ios/MGLMapView.h
index d0704a41c6a..f847c0d5468 100644
--- a/include/mbgl/ios/MGLMapView.h
+++ b/include/mbgl/ios/MGLMapView.h
@@ -73,8 +73,8 @@ IB_DESIGNABLE
 *   The default value of this property is `YES`. */
 @property(nonatomic, getter=isRotateEnabled) BOOL rotateEnabled;
 
-/** The compass image view shown in the upper-right when the map is rotated. */
-@property (nonatomic, readonly) UIImageView *compassView;
+/** The compass button shown in the upper-right when the map is rotated. */
+@property (nonatomic, readonly) UIButton *compassButton;
 
 /** The Mapbox logo image view shown in the lower-left of the map. */
 @property (nonatomic, readonly) UIImageView *logoView;
diff --git a/platform/ios/MGLMapView.mm b/platform/ios/MGLMapView.mm
index 06a2ef36be8..3e59117600b 100644
--- a/platform/ios/MGLMapView.mm
+++ b/platform/ios/MGLMapView.mm
@@ -69,7 +69,7 @@ @interface MGLMapView () <UIGestureRecognizerDelegate, GLKViewDelegate, CLLocati
 @property (nonatomic) GLKView *glView;
 @property (nonatomic) UIImageView *glSnapshotView;
 @property (nonatomic) NSOperationQueue *regionChangeDelegateQueue;
-@property (nonatomic, readwrite) UIImageView *compassView;
+@property (nonatomic, readwrite) UIButton *compassButton;
 @property (nonatomic, readwrite) UIImageView *logoView;
 @property (nonatomic) NS_MUTABLE_ARRAY_OF(NSLayoutConstraint *) *logoViewConstraints;
 @property (nonatomic, readwrite) UIButton *attributionButton;
@@ -314,14 +314,16 @@ - (void)commonInit
 
     // setup compass
     //
-    _compassView = [[UIImageView alloc] initWithImage:[MGLMapView resourceImageNamed:@"Compass.png"]];
-    _compassView.accessibilityLabel = @"Compass";
-    _compassView.frame = CGRectMake(0, 0, _compassView.image.size.width, _compassView.image.size.height);
-    _compassView.alpha = 0;
+    _compassButton = [UIButton buttonWithType:UIButtonTypeCustom];
+    UIImage *compassImage = [MGLMapView resourceImageNamed:@"Compass.png"];
+    [_compassButton setImage:compassImage forState:UIControlStateNormal];
+    _compassButton.accessibilityLabel = @"Compass";
+    _compassButton.frame = CGRectMake(0, 0, compassImage.size.width, compassImage.size.height);
+    _compassButton.alpha = 0;
+    [_compassButton addTarget:self action:@selector(resetNorthWithCompass:) forControlEvents:UIControlEventTouchUpInside];
     UIView *container = [[UIView alloc] initWithFrame:CGRectZero];
-    [container addSubview:_compassView];
+    [container addSubview:_compassButton];
     container.translatesAutoresizingMaskIntoConstraints = NO;
-    [container addGestureRecognizer:[[UITapGestureRecognizer alloc] initWithTarget:self action:@selector(handleCompassTapGesture:)]];
     [self addSubview:container];
 
     // setup interaction
@@ -499,7 +501,7 @@ - (void)updateConstraints
 
     // compass
     //
-    UIView *compassContainer = self.compassView.superview;
+    UIView *compassContainer = self.compassButton.superview;
     if ([NSLayoutConstraint respondsToSelector:@selector(deactivateConstraints:)])
     {
         [NSLayoutConstraint deactivateConstraints:compassContainer.constraints];
@@ -539,6 +541,7 @@ - (void)updateConstraints
                                  multiplier:1
                                    constant:5]];
 
+    UIImage *compassImage = [self.compassButton imageForState:UIControlStateNormal];
     [compassContainerConstraints addObject:
      [NSLayoutConstraint constraintWithItem:compassContainer
                                   attribute:NSLayoutAttributeWidth
@@ -546,7 +549,7 @@ - (void)updateConstraints
                                      toItem:nil
                                   attribute:NSLayoutAttributeNotAnAttribute
                                  multiplier:1
-                                   constant:self.compassView.image.size.width]];
+                                   constant:compassImage.size.width]];
 
     [compassContainerConstraints addObject:
      [NSLayoutConstraint constraintWithItem:compassContainer
@@ -555,7 +558,7 @@ - (void)updateConstraints
                                      toItem:nil
                                   attribute:NSLayoutAttributeNotAnAttribute
                                  multiplier:1
-                                   constant:self.compassView.image.size.height]];
+                                   constant:compassImage.size.height]];
     if ([NSLayoutConstraint respondsToSelector:@selector(activateConstraints:)])
     {
         [NSLayoutConstraint activateConstraints:compassContainerConstraints];
@@ -700,7 +703,7 @@ - (void)layoutSubviews
         [self.attributionSheet dismissWithClickedButtonIndex:self.attributionSheet.cancelButtonIndex animated:YES];
     }
 
-    if (self.compassView.alpha)
+    if (self.compassButton.alpha)
     {
         [self updateHeadingForDeviceOrientation];
         [self updateCompass];
@@ -789,7 +792,7 @@ - (void)updateTintColorForView:(UIView *)view
 
 #pragma mark - Gestures -
 
-- (void)handleCompassTapGesture:(__unused id)sender
+- (void)resetNorthWithCompass:(__unused id)sender
 {
     [self resetNorthAnimated:YES];
 
@@ -1403,7 +1406,7 @@ - (void)resetNorthAnimated:(BOOL)animated
     [UIView animateWithDuration:duration
                      animations:^
                      {
-                         self.compassView.transform = CGAffineTransformIdentity;
+                         self.compassButton.transform = CGAffineTransformIdentity;
                      }
                      completion:^(BOOL finished)
                      {
@@ -2628,27 +2631,27 @@ - (void)updateCompass
     while (degrees >= 360) degrees -= 360;
     while (degrees < 0) degrees += 360;
 
-    self.compassView.transform = CGAffineTransformMakeRotation(MGLRadiansFromDegrees(degrees));
+    self.compassButton.transform = CGAffineTransformMakeRotation(MGLRadiansFromDegrees(degrees));
 
-    if (_mbglMap->getBearing() && self.compassView.alpha < 1)
+    if (_mbglMap->getBearing() && self.compassButton.alpha < 1)
     {
         [UIView animateWithDuration:MGLAnimationDuration
                               delay:0
                             options:UIViewAnimationOptionBeginFromCurrentState
                          animations:^
                          {
-                             self.compassView.alpha = 1;
+                             self.compassButton.alpha = 1;
                          }
                          completion:nil];
     }
-    else if (_mbglMap->getBearing() == 0 && self.compassView.alpha > 0)
+    else if (_mbglMap->getBearing() == 0 && self.compassButton.alpha > 0)
     {
         [UIView animateWithDuration:MGLAnimationDuration
                               delay:0
                             options:UIViewAnimationOptionBeginFromCurrentState
                          animations:^
                          {
-                             self.compassView.alpha = 0;
+                             self.compassButton.alpha = 0;
                          }
                          completion:nil];
     }