Add new moveToMarker api using a destination scale, and improve animation

Author: p-lr

Readme.md

@@ -1,4 +1,4 @@
-[ ![Download](https://api.bintray.com/packages/peterlaurence/maven/mapview/images/download.svg?version=2.0.8) ](https://bintray.com/peterlaurence/maven/mapview/2.0.8/link)
+[ ![Download](https://api.bintray.com/packages/peterlaurence/maven/mapview/images/download.svg?version=2.0.9) ](https://bintray.com/peterlaurence/maven/mapview/2.0.9/link)
 
 # MapView
 
@@ -60,7 +60,7 @@ There are some breaking changes, although most of them are just package refactor
 
 Add this to your module's build.gradle
 ```groovy
-implementation 'com.peterlaurence:mapview:2.0.8'
+implementation 'com.peterlaurence:mapview:2.0.9'
 ```
 
 ## Origin and motivation

mapview/build.gradle

@@ -5,7 +5,7 @@ apply plugin: 'kotlin-android'
 apply plugin: 'kotlin-android-extensions'
 apply plugin: 'kotlinx-serialization'
 
-def versionTag = "2.0.8"
+def versionTag = "2.0.9"
 
 androidExtensions {
     experimental = true
@@ -23,7 +23,6 @@ buildscript {
 android {
     compileSdkVersion 29
 
-
     defaultConfig {
         minSdkVersion 24
         targetSdkVersion 29

mapview/src/main/java/com/peterlaurence/mapview/api/MarkerApi.kt

@@ -9,7 +9,7 @@ import com.peterlaurence.mapview.markers.MarkerTapListener
  * Add a marker to the the MapView.  The marker can be any View.
  * No LayoutParams are required; the View will be laid out using WRAP_CONTENT for both width and height, and positioned based on the parameters.
  *
- * @param view    View instance to be added to the TileView.
+ * @param view    View instance to be added to the MapView.
  * @param x       Relative x position the View instance should be positioned at.
  * @param y       Relative y position the View instance should be positioned at.
  * @param relativeAnchorLeft The x-axis position of a marker will be offset by a number equal to the width of the marker multiplied by this value.
@@ -66,39 +66,58 @@ fun MapView.getMarkerFromPosition(x: Double, y: Double): View? {
 }
 
 /**
- * Scroll the TileView so that the View passed is centered in the viewport.
+ * Scrolls the MapView so that the View passed is centered in the viewport.
+ * The scale remains constant.
  *
- * @param view          The View marker that the TileView should center on.
- * @param shouldAnimate True if the movement should use a transition effect.
+ * The scroll position is animated if [shouldAnimate] is set to `true`.
+ *
+ * @param view The marker that the MapView should center on.
+ * @param shouldAnimate `true` if the movement should use a transition effect.
  */
 @Suppress("unused")
 fun MapView.moveToMarker(view: View, shouldAnimate: Boolean) {
+    moveToMarker(view, scale, shouldAnimate)
+}
+
+/**
+ * Scrolls the MapView so that the marker passed is centered in the viewport.
+ * Takes an additional [destinationScale] parameter.
+ *
+ * The scroll position and scale are animated if [shouldAnimate] is set to `true`.
+ *
+ * @param view The marker that the MapView should center on.
+ * @param destinationScale The scale of the MapView when centered on the marker
+ * @param shouldAnimate True if the movement should use a transition effect.
+ */
+@Suppress("unused")
+fun MapView.moveToMarker(view: View, destinationScale: Float, shouldAnimate: Boolean) {
     if (markerLayout?.indexOfChild(view) == -1) {
         throw IllegalStateException("The view passed is not an existing marker")
     }
     val params = view.layoutParams
     if (params is MarkerLayoutParams) {
-        val scaledX = (params.x * scale).toInt()
-        val scaledY = (params.y * scale).toInt()
+        val scaledX = (params.x * destinationScale).toInt()
+        val scaledY = (params.y * destinationScale).toInt()
         if (shouldAnimate) {
-            slideToAndCenter(scaledX, scaledY)
+            slideToAndCenterWithScale(scaledX, scaledY, destinationScale)
         } else {
+            scale = destinationScale
             scrollToAndCenter(scaledX, scaledY)
         }
     }
 }
 
 /**
- * Removes a marker View from the TileView's view tree.
+ * Removes a marker from the MapView's view tree.
  *
- * @param view The marker View to be removed.
+ * @param view The marker to be removed.
  */
 fun MapView.removeMarker(view: View) {
     markerLayout?.removeMarker(view)
 }
 
 /**
- * Add a callout to the the MapView.  The callout can be any View.
+ * Add a callout to the the MapView. The callout can be any View.
  * No LayoutParams are required; the View will be laid out using WRAP_CONTENT for both width and height, and positioned based on the parameters.
  *
  * @param view    View instance to be added to the MapView.

mapview/src/main/java/com/peterlaurence/mapview/core/CoordinateTranslater.kt

@@ -51,6 +51,7 @@ class CoordinateTranslater(val baseWidth: Int, val baseHeight: Int, val left: Do
      * and an angle alpha. This return the X coordinate by applying a rotation of -alpha around the
      * center.
      */
+    @Suppress("unused")
     fun reverseRotationX(rd: ReferentialData, x: Float, y: Float): Double {
         val centerX = rd.centerX * baseWidth * rd.scale
         val centerY = rd.centerY * baseHeight * rd.scale
@@ -62,6 +63,7 @@ class CoordinateTranslater(val baseWidth: Int, val baseHeight: Int, val left: Do
      * and an angle alpha. This return the Y coordinate by applying a rotation of -alpha around the
      * center.
      */
+    @Suppress("unused")
     fun reverseRotationY(rd: ReferentialData, x: Float, y: Float): Double {
         val centerX = rd.centerX * baseWidth * rd.scale
         val centerY = rd.centerY * baseHeight * rd.scale

mapview/src/main/java/com/peterlaurence/mapview/layout/GestureLayout.kt

@@ -231,6 +231,7 @@ abstract class GestureLayout @JvmOverloads constructor(context: Context, attrs:
      * @param x Horizontal destination point.
      * @param y Vertical destination point.
      */
+    @Suppress("unused")
     fun slideToAndCenter(x: Int, y: Int) {
         slideTo(x - halfWidth, y - halfHeight)
     }

mapview/src/main/java/com/peterlaurence/mapview/layout/animators/ZoomPanAnimator.kt

@@ -2,89 +2,88 @@ package com.peterlaurence.mapview.layout.animators
 
 import android.animation.Animator
 import android.animation.ValueAnimator
-import android.view.animation.Interpolator
-import kotlin.math.pow
+import android.view.animation.AccelerateInterpolator
 
 class ZoomPanAnimator(private val listener: OnZoomPanAnimationListener) : ValueAnimator(),
     ValueAnimator.AnimatorUpdateListener, Animator.AnimatorListener {
 
-    private val mStartState = ZoomPanState()
-    private val mEndState = ZoomPanState()
-    private var mHasPendingZoomUpdates: Boolean = false
-    private var mHasPendingPanUpdates: Boolean = false
+    private val startState = ZoomPanState()
+    private val endState = ZoomPanState()
+    private var hasPendingZoomUpdates: Boolean = false
+    private var hasPendingPanUpdates: Boolean = false
 
     init {
         addUpdateListener(this)
         addListener(this)
         setFloatValues(0f, 1f)
-        interpolator = FastEaseInInterpolator()
+        interpolator = AccelerateInterpolator()
     }
 
     private fun setupPanAnimation(x: Int, y: Int): Boolean {
-        mStartState.x = listener.getScrollX()
-        mStartState.y = listener.getScrollY()
-        mEndState.x = x
-        mEndState.y = y
-        return mStartState.x != mEndState.x || mStartState.y != mEndState.y
+        startState.x = listener.getScrollX()
+        startState.y = listener.getScrollY()
+        endState.x = x
+        endState.y = y
+        return startState.x != endState.x || startState.y != endState.y
     }
 
     private fun setupZoomAnimation(scale: Float): Boolean {
-        mStartState.scale = listener.getScale()
-        mEndState.scale = scale
-        return mStartState.scale != mEndState.scale
+        startState.scale = listener.getScale()
+        endState.scale = scale
+        return startState.scale != endState.scale
     }
 
     fun animateZoomPan(x: Int, y: Int, scale: Float) {
-        mHasPendingZoomUpdates = setupZoomAnimation(scale)
-        mHasPendingPanUpdates = setupPanAnimation(x, y)
-        if (mHasPendingPanUpdates || mHasPendingZoomUpdates) {
+        hasPendingZoomUpdates = setupZoomAnimation(scale)
+        hasPendingPanUpdates = setupPanAnimation(x, y)
+        if (hasPendingPanUpdates || hasPendingZoomUpdates) {
             start()
         }
     }
 
     fun animateZoom(scale: Float) {
-        mHasPendingZoomUpdates = setupZoomAnimation(scale)
-        if (mHasPendingZoomUpdates) {
+        hasPendingZoomUpdates = setupZoomAnimation(scale)
+        if (hasPendingZoomUpdates) {
             start()
         }
     }
 
     fun animatePan(x: Int, y: Int) {
-        mHasPendingPanUpdates = setupPanAnimation(x, y)
-        if (mHasPendingPanUpdates) {
+        hasPendingPanUpdates = setupPanAnimation(x, y)
+        if (hasPendingPanUpdates) {
             start()
         }
     }
 
     override fun onAnimationUpdate(animation: ValueAnimator) {
         val progress = animation.animatedValue as Float
-        if (mHasPendingZoomUpdates) {
-            val scale = mStartState.scale + (mEndState.scale - mStartState.scale) * progress
+        if (hasPendingZoomUpdates) {
+            val scale = startState.scale + (endState.scale - startState.scale) * progress
             listener.setScale(scale)
         }
-        if (mHasPendingPanUpdates) {
-            val x = (mStartState.x + (mEndState.x - mStartState.x) * progress).toInt()
-            val y = (mStartState.y + (mEndState.y - mStartState.y) * progress).toInt()
+        if (hasPendingPanUpdates) {
+            val x = (startState.x + (endState.x - startState.x) * progress).toInt()
+            val y = (startState.y + (endState.y - startState.y) * progress).toInt()
             listener.scrollTo(x, y)
         }
     }
 
     override fun onAnimationStart(animator: Animator) {
-        if (mHasPendingZoomUpdates) {
+        if (hasPendingZoomUpdates) {
             listener.setIsScaling(true)
         }
-        if (mHasPendingPanUpdates) {
+        if (hasPendingPanUpdates) {
             listener.setIsSliding(true)
         }
     }
 
     override fun onAnimationEnd(animator: Animator) {
-        if (mHasPendingZoomUpdates) {
-            mHasPendingZoomUpdates = false
+        if (hasPendingZoomUpdates) {
+            hasPendingZoomUpdates = false
             listener.setIsScaling(false)
         }
-        if (mHasPendingPanUpdates) {
-            mHasPendingPanUpdates = false
+        if (hasPendingPanUpdates) {
+            hasPendingPanUpdates = false
             listener.setIsSliding(false)
         }
     }
@@ -103,12 +102,6 @@ class ZoomPanAnimator(private val listener: OnZoomPanAnimationListener) : ValueA
         var scale: Float = 0.toFloat()
     }
 
-    private class FastEaseInInterpolator : Interpolator {
-        override fun getInterpolation(input: Float): Float {
-            return (1 - (1 - input).toDouble().pow(8.0)).toFloat()
-        }
-    }
-
     interface OnZoomPanAnimationListener {
         fun setIsScaling(isScaling: Boolean)
         fun setIsSliding(isSliding: Boolean)