Merge branch '56-pass-zoom-level-to-tile-request-and-zoom-to-incremental-padding' into 'master'

Resolve "Pass zoom level to tile request and zoom to incremental padding"

Closes #56

See merge request pace/mobile/android/pace-cloud-sdk!45

Author: Martin Dinh

library/src/main/java/cloud/pace/sdk/poikit/POIKit.kt

@@ -41,7 +41,6 @@ object POIKit : CloudSDKKoinComponent, LifecycleObserver {
     private val navigationApi: NavigationApiClient by inject()
     private val addressSearchApi: AddressSearchClient by inject()
     private val locationProvider: LocationProvider by inject()
-    var maxPoiSearchBoxSize = 15000.0
 
     fun startLocationListener(): LocationProvider {
         ProcessLifecycleOwner.get().lifecycle.addObserver(this)
@@ -63,8 +62,8 @@ object POIKit : CloudSDKKoinComponent, LifecycleObserver {
     }
 
     @JvmOverloads
-    fun observe(visibleRegion: VisibleRegion, withMaxPoiSearchBoxSize: Boolean = true, completion: (Completion<List<PointOfInterest>>) -> Unit): VisibleRegionNotificationToken {
-        return VisibleRegionNotificationToken(visibleRegion, withMaxPoiSearchBoxSize, database.gasStationDao(), completion)
+    fun observe(visibleRegion: VisibleRegion, padding: Double = 0.0, completion: (Completion<List<PointOfInterest>>) -> Unit): VisibleRegionNotificationToken {
+        return VisibleRegionNotificationToken(visibleRegion, padding, database.gasStationDao(), completion)
     }
 
     fun observe(vararg ids: String, completion: (Completion<List<PointOfInterest>>) -> Unit): IDsNotificationToken {

library/src/main/java/cloud/pace/sdk/poikit/poi/PoiKitObserverToken.kt

@@ -3,14 +3,11 @@ package cloud.pace.sdk.poikit.poi
 import androidx.lifecycle.LiveData
 import androidx.lifecycle.MutableLiveData
 import androidx.lifecycle.Observer
-import cloud.pace.sdk.poikit.POIKit
 import cloud.pace.sdk.poikit.database.GasStationDAO
 import cloud.pace.sdk.poikit.poi.download.TileDownloader
 import cloud.pace.sdk.poikit.poi.download.TileQueryRequestOuterClass.TileQueryRequest.*
 import cloud.pace.sdk.poikit.utils.POIKitConfig
-import cloud.pace.sdk.poikit.utils.ZoomException
-import cloud.pace.sdk.poikit.utils.diameter
-import cloud.pace.sdk.poikit.utils.zoomToDiameter
+import cloud.pace.sdk.poikit.utils.addPadding
 import cloud.pace.sdk.utils.CloudSDKKoinComponent
 import cloud.pace.sdk.utils.Completion
 import cloud.pace.sdk.utils.Failure
@@ -29,7 +26,7 @@ open class PoiKitObserverToken : CloudSDKKoinComponent {
     val loading = MutableLiveData<Boolean>()
     var lastRefreshTime: Date? = null
 
-    open fun refresh() {
+    open fun refresh(zoomLevel: Int = POIKitConfig.ZOOMLEVEL) {
         lastRefreshTime = Date()
     }
 
@@ -38,7 +35,7 @@ open class PoiKitObserverToken : CloudSDKKoinComponent {
 
 class VisibleRegionNotificationToken(
     val visibleRegion: VisibleRegion,
-    withMaxPoiSearchBoxSize: Boolean,
+    padding: Double,
     private val gasStationDao: GasStationDAO,
     private val completion: (Completion<List<PointOfInterest>>) -> Unit
 ) : PoiKitObserverToken() {
@@ -48,37 +45,28 @@ class VisibleRegionNotificationToken(
     private var downloadTask: Call? = null
 
     init {
-        if (withMaxPoiSearchBoxSize && visibleRegion.diameter() > POIKit.maxPoiSearchBoxSize) {
-            completion(Failure(ZoomException()))
-        } else {
-            // load all the points that are around a certain radius of the visible center
-            val regionToLoad = if (withMaxPoiSearchBoxSize) {
-                visibleRegion.zoomToDiameter(POIKit.maxPoiSearchBoxSize)
-            } else {
-                visibleRegion
-            }
-            gasStations = gasStationDao.getInBoundingBoxLive(
-                minLat = regionToLoad.latLngBounds.southwest.latitude,
-                minLon = regionToLoad.latLngBounds.southwest.longitude,
-                maxLat = regionToLoad.latLngBounds.northeast.latitude,
-                maxLon = regionToLoad.latLngBounds.northeast.longitude
-            )
-
-            gasStationsObserver = Observer {
-                completion(Success(it))
-            }
-
-            gasStationsObserver?.let { gasStations?.observeForever(it) }
+        // load all the points that are around a certain radius of the visible center
+        val regionToLoad = visibleRegion.addPadding(padding)
+
+        gasStations = gasStationDao.getInBoundingBoxLive(
+            minLat = regionToLoad.latLngBounds.southwest.latitude,
+            minLon = regionToLoad.latLngBounds.southwest.longitude,
+            maxLat = regionToLoad.latLngBounds.northeast.latitude,
+            maxLon = regionToLoad.latLngBounds.northeast.longitude
+        )
+
+        gasStationsObserver = Observer {
+            completion(Success(it))
         }
+
+        gasStationsObserver?.let { gasStations?.observeForever(it) }
     }
 
-    override fun refresh() {
-        // TODO: Calculate best zoom level based on the diameter of the request + meta data which discribes what is available at what zoom level
+    override fun refresh(zoomLevel: Int) {
         if (gasStationsObserver == null) return
 
         loading.value = true
 
-        val zoomLevel = POIKitConfig.ZOOMLEVEL
         val northEast = visibleRegion.latLngBounds.northeast.toLocationPoint().tileInfo(zoom = zoomLevel)
         val southWest = visibleRegion.latLngBounds.southwest.toLocationPoint().tileInfo(zoom = zoomLevel)
 
@@ -116,7 +104,7 @@ class VisibleRegionNotificationToken(
             }
         }
 
-        super.refresh()
+        super.refresh(zoomLevel)
     }
 
     override fun invalidate() {
@@ -139,12 +127,9 @@ class IDsNotificationToken(
         gasStations.observeForever(gasStationsObserver)
     }
 
-    override fun refresh() {
+    override fun refresh(zoomLevel: Int) {
         loading.value = true
 
-        // TODO: Calculate best zoom level based on the diameter of the request + meta data which discribes what is available at what zoom level
-        val zoomLevel = POIKitConfig.ZOOMLEVEL
-
         GlobalScope.launch {
             // Build request from bounding box
             val tiles = gasStationDao
@@ -177,7 +162,7 @@ class IDsNotificationToken(
             }
         }
 
-        super.refresh()
+        super.refresh(zoomLevel)
     }
 
     override fun invalidate() {

library/src/main/java/cloud/pace/sdk/poikit/utils/PoiKitExceptions.kt

@@ -1,8 +1,6 @@
 package cloud.pace.sdk.poikit.utils
 
-open class PoiKitExceptions : Exception()
-class ZoomException : PoiKitExceptions()
-class ApiException(val errorCode: Int, val errorMessage: String) : Exception() {
+class ApiException(private val errorCode: Int, private val errorMessage: String) : Exception() {
     override fun toString(): String {
         return super.toString() + "\n" +
             "code = $errorCode || message = $errorMessage"

library/src/main/java/cloud/pace/sdk/poikit/utils/VisibleRegion.kt

@@ -46,3 +46,44 @@ fun VisibleRegion.zoomToDiameter(diameter: Double): VisibleRegion {
 
     return VisibleRegion(nearLeft, nearRight, farLeft, farRight, bounds)
 }
+
+/**
+ * Adds the [padding] to each side of [this] [VisibleRegion] and returns a new padded [VisibleRegion].
+ *
+ * @return A new [VisibleRegion] with the added [padding]
+ */
+fun VisibleRegion.addPadding(padding: Double): VisibleRegion {
+    val diameter = diameter()
+    val paddedDiameter = diameter + diameter * padding
+
+    // calculate the headings to each edge
+    val center = latLngBounds.center
+    val nearLeft = SphericalUtil.computeOffset(center, paddedDiameter / 2.0, center.headingTo(nearLeft))
+    val nearRight = SphericalUtil.computeOffset(center, paddedDiameter / 2.0, center.headingTo(nearRight))
+    val farLeft = SphericalUtil.computeOffset(center, paddedDiameter / 2.0, center.headingTo(farLeft))
+    val farRight = SphericalUtil.computeOffset(center, paddedDiameter / 2.0, center.headingTo(farRight))
+
+    val bounds = LatLngBounds.Builder()
+        .include(nearLeft)
+        .include(nearRight)
+        .include(farLeft)
+        .include(farRight)
+        .build()
+
+    return VisibleRegion(nearLeft, nearRight, farLeft, farRight, bounds)
+}
+
+/**
+ * Calculates the incremental padding depending on the [currentIncrement].
+ * It ensures that the value lies in the specified range [minPadding]..[maxPadding].
+ *
+ * @param maxIncrements The maximum number of increments/steps
+ */
+fun incrementalPadding(maxIncrements: Int, currentIncrement: Int, maxPadding: Double = 0.85, minPadding: Double = 0.2): Double {
+    val paddingDifference = maxPadding - minPadding
+    val factor = maxIncrements - currentIncrement
+    val relativePadding = (paddingDifference / maxIncrements) * factor
+    val padding = relativePadding + minPadding
+
+    return padding.coerceIn(minPadding, maxPadding)
+}