RD-980: Add panning functions

Author: sasaprodribaba

MapTilerSDK/src/main/java/com/maptiler/maptilersdk/commands/navigation/PanBy.kt

@@ -0,0 +1,23 @@
+/*
+ * Copyright (c) 2025, MapTiler
+ * All rights reserved.
+ * SPDX-License-Identifier: BSD 3-Clause
+ */
+
+package com.maptiler.maptilersdk.commands.navigation
+
+import com.maptiler.maptilersdk.bridge.JSString
+import com.maptiler.maptilersdk.bridge.MTBridge
+import com.maptiler.maptilersdk.bridge.MTCommand
+import com.maptiler.maptilersdk.helpers.JsonConfig
+import com.maptiler.maptilersdk.map.types.MTPoint
+
+internal data class PanBy(
+    val offset: MTPoint,
+) : MTCommand {
+    override fun toJS(): String {
+        val offsetString: JSString = JsonConfig.json.encodeToString(offset)
+
+        return "${MTBridge.MAP_OBJECT}.panBy($offsetString);"
+    }
+}

MapTilerSDK/src/main/java/com/maptiler/maptilersdk/commands/navigation/PanTo.kt

@@ -0,0 +1,23 @@
+/*
+ * Copyright (c) 2025, MapTiler
+ * All rights reserved.
+ * SPDX-License-Identifier: BSD 3-Clause
+ */
+
+package com.maptiler.maptilersdk.commands.navigation
+
+import com.maptiler.maptilersdk.bridge.JSString
+import com.maptiler.maptilersdk.bridge.MTBridge
+import com.maptiler.maptilersdk.bridge.MTCommand
+import com.maptiler.maptilersdk.helpers.JsonConfig
+import com.maptiler.maptilersdk.map.LngLat
+
+internal data class PanTo(
+    val coordinates: LngLat,
+) : MTCommand {
+    override fun toJS(): String {
+        val coordinatesString: JSString = JsonConfig.json.encodeToString(coordinates)
+
+        return "${MTBridge.MAP_OBJECT}.panTo($coordinatesString);"
+    }
+}

MapTilerSDK/src/main/java/com/maptiler/maptilersdk/map/MTMapCameraHelper.kt

@@ -12,16 +12,16 @@ import kotlinx.serialization.Serializable
  * A geographical location which contains a latitude, longitude pair.
  */
 @Serializable
-data class LatLng(
-    val lon: Double,
+data class LngLat(
+    val lng: Double,
     val lat: Double,
 )
 
 /**
  * Sets combination of center, bearing and pitch, as well as roll and elevation.
  */
 class MTMapCameraHelper private constructor(
-    val centerCoordinate: LatLng? = null,
+    val centerCoordinate: LngLat? = null,
     val bearing: Double? = null,
     val pitch: Double? = null,
     val roll: Double? = null,
@@ -33,7 +33,7 @@ class MTMapCameraHelper private constructor(
          */
         fun getCamera(): MTMapCameraHelper =
             MTMapCameraHelper(
-                centerCoordinate = LatLng(0.0, 0.0),
+                centerCoordinate = LngLat(0.0, 0.0),
                 bearing = 0.0,
                 pitch = 0.0,
                 roll = 0.0,
@@ -51,7 +51,7 @@ class MTMapCameraHelper private constructor(
          * Returns camera object with the given center coordinate, bearing, pitch, roll and elevation.
          */
         fun cameraLookingAtCenterCoordinate(
-            centerCoordinate: LatLng,
+            centerCoordinate: LngLat,
             bearing: Double,
             pitch: Double,
             roll: Double,
@@ -72,7 +72,7 @@ class MTMapCameraHelper private constructor(
          * If they are not specified in the style, they will default to 0.
          */
         fun cameraLookingAtCenterCoordinate(
-            centerCoordinate: LatLng,
+            centerCoordinate: LngLat,
             bearing: Double,
             pitch: Double,
         ): MTMapCameraHelper =

MapTilerSDK/src/main/java/com/maptiler/maptilersdk/map/MTMapOptions.kt

@@ -31,7 +31,7 @@ class MTMapOptions {
      * If center is not specified, SDK will look for it in the map style object.
      * If it is not specified in the style, it will default to (latitude: 0.0, longitude: 0.0).
      */
-    var center: LatLng? = null
+    var center: LngLat? = null
         private set
 
     /**
@@ -350,36 +350,36 @@ class MTMapOptions {
         private set
 
     /** Initializes map options with center, zoom, bearing, and pitch. */
-    constructor(center: LatLng?, zoom: Double?, bearing: Double?, pitch: Double?) {
+    constructor(center: LngLat?, zoom: Double?, bearing: Double?, pitch: Double?) {
         this.center = center
         this.zoom = zoom
         this.bearing = bearing
         this.pitch = pitch
     }
 
     /** Initializes map options with center and zoom. */
-    constructor(center: LatLng?, zoom: Double?) {
+    constructor(center: LngLat?, zoom: Double?) {
         this.center = center
         this.zoom = zoom
     }
 
     /** Initializes map options with center, zoom and language. */
-    constructor(center: LatLng?, zoom: Double?, language: MTLanguage) {
+    constructor(center: LngLat?, zoom: Double?, language: MTLanguage) {
         this.center = center
         this.zoom = zoom
         this.language = language
     }
 
     /** Initializes map options with center, zoom and terrain. */
-    constructor(center: LatLng?, zoom: Double?, terrainIsEnabled: Boolean?, terrainExaggeration: Double?) {
+    constructor(center: LngLat?, zoom: Double?, terrainIsEnabled: Boolean?, terrainExaggeration: Double?) {
         this.center = center
         this.zoom = zoom
         this.terrainIsEnabled = terrainIsEnabled
         this.terrainExaggeration = terrainExaggeration
     }
 
     /** Initializes map options with center, zoom and projection. */
-    constructor(center: LatLng?, zoom: Double?, projection: MTProjectionType?) {
+    constructor(center: LngLat?, zoom: Double?, projection: MTProjectionType?) {
         this.center = center
         this.zoom = zoom
         this.projection = projection

MapTilerSDK/src/main/java/com/maptiler/maptilersdk/map/MTMapViewController.kt

@@ -17,6 +17,9 @@ import com.maptiler.maptilersdk.logging.MTLogType
 import com.maptiler.maptilersdk.logging.MTLogger
 import com.maptiler.maptilersdk.map.gestures.MTGestureService
 import com.maptiler.maptilersdk.map.style.MTStyle
+import com.maptiler.maptilersdk.map.types.MTPoint
+import com.maptiler.maptilersdk.map.workers.navigable.MTNavigable
+import com.maptiler.maptilersdk.map.workers.navigable.NavigableWorker
 import com.maptiler.maptilersdk.map.workers.zoomable.MTZoomable
 import com.maptiler.maptilersdk.map.workers.zoomable.ZoomableWorker
 import kotlinx.coroutines.CoroutineScope
@@ -34,8 +37,9 @@ interface MTMapViewDelegate {
 class MTMapViewController(
     private val context: Context,
 ) : WebViewExecutorDelegate,
-    MTZoomable {
-    var coroutineScope: CoroutineScope? = null
+    MTZoomable,
+    MTNavigable {
+    private var coroutineScope: CoroutineScope? = null
 
     private var bridge: MTBridge? = null
     private var webViewExecutor: WebViewExecutor? =
@@ -44,6 +48,7 @@ class MTMapViewController(
         }
 
     private lateinit var zoomableWorker: ZoomableWorker
+    private lateinit var navigableWorker: NavigableWorker
 
     /**
      * Proxy style object of the map.
@@ -98,6 +103,7 @@ class MTMapViewController(
 
     private fun initializeWorkers() {
         zoomableWorker = ZoomableWorker(bridge!!)
+        navigableWorker = NavigableWorker(bridge!!)
     }
 
     fun bind(scope: CoroutineScope) {
@@ -120,15 +126,55 @@ class MTMapViewController(
         }
     }
 
+    // ZOOMABLE
+
+    /**
+     * Increases the map's zoom level by 1.
+     */
     override suspend fun zoomIn() = zoomableWorker.zoomIn()
 
+    /**
+     * Decreases the map's zoom level by 1.
+     */
     override suspend fun zoomOut() = zoomableWorker.zoomOut()
 
+    /**
+     * Returns the map's current zoom level.
+     */
     override suspend fun getZoom(): Double = zoomableWorker.getZoom()
 
+    /**
+     * Sets the map's zoom level.
+     *
+     * @param zoom The zoom level to set (0-20).
+     */
     override suspend fun setZoom(zoom: Double) = zoomableWorker.setZoom(zoom)
 
+    /**
+     * Sets the map's maximum zoom.
+     * @param maxZoom Desired zoom.
+     */
     override suspend fun setMaxZoom(maxZoom: Double) = zoomableWorker.setMaxZoom(maxZoom)
 
+    /**
+     * Sets the map's minimum zoom.
+     * @param minZoom Desired zoom.
+     */
     override suspend fun setMinZoom(minZoom: Double) = zoomableWorker.setMinZoom(minZoom)
+
+    // NAVIGABLE
+
+    /**
+     * Pans the map by the specified offset.
+     *
+     * @param offset Offset to pan by.
+     */
+    override suspend fun panBy(offset: MTPoint) = navigableWorker.panBy(offset)
+
+    /**
+     * Pans the map to the specified location with an animated transition.
+     *
+     * @param coordinates Coordinates to pan to.
+     */
+    override suspend fun panTo(coordinates: LngLat) = navigableWorker.panTo(coordinates)
 }

MapTilerSDK/src/main/java/com/maptiler/maptilersdk/map/types/MTPoint.kt

@@ -0,0 +1,18 @@
+/*
+ * Copyright (c) 2025, MapTiler
+ * All rights reserved.
+ * SPDX-License-Identifier: BSD 3-Clause
+ */
+
+package com.maptiler.maptilersdk.map.types
+
+import kotlinx.serialization.Serializable
+
+/**
+ * Two numbers representing x and y screen coordinates in pixels.
+ */
+@Serializable
+data class MTPoint(
+    val x: Double,
+    val y: Double,
+)

MapTilerSDK/src/main/java/com/maptiler/maptilersdk/map/workers/navigable/MTNavigable.kt

@@ -0,0 +1,16 @@
+/*
+ * Copyright (c) 2025, MapTiler
+ * All rights reserved.
+ * SPDX-License-Identifier: BSD 3-Clause
+ */
+
+package com.maptiler.maptilersdk.map.workers.navigable
+
+import com.maptiler.maptilersdk.map.LngLat
+import com.maptiler.maptilersdk.map.types.MTPoint
+
+interface MTNavigable {
+    suspend fun panBy(offset: MTPoint)
+
+    suspend fun panTo(coordinates: LngLat)
+}

MapTilerSDK/src/main/java/com/maptiler/maptilersdk/map/workers/navigable/NavigableWorker.kt

@@ -0,0 +1,29 @@
+/*
+ * Copyright (c) 2025, MapTiler
+ * All rights reserved.
+ * SPDX-License-Identifier: BSD 3-Clause
+ */
+
+package com.maptiler.maptilersdk.map.workers.navigable
+
+import com.maptiler.maptilersdk.bridge.MTBridge
+import com.maptiler.maptilersdk.commands.navigation.PanBy
+import com.maptiler.maptilersdk.commands.navigation.PanTo
+import com.maptiler.maptilersdk.map.LngLat
+import com.maptiler.maptilersdk.map.types.MTPoint
+
+internal class NavigableWorker(
+    private val bridge: MTBridge,
+) : MTNavigable {
+    override suspend fun panBy(offset: MTPoint) {
+        bridge.execute(
+            PanBy(offset),
+        )
+    }
+
+    override suspend fun panTo(coordinates: LngLat) {
+        bridge.execute(
+            PanTo(coordinates),
+        )
+    }
+}

MapTilerSDK/src/main/java/com/maptiler/maptilersdk/map/workers/zoomable/ZoomableWorker.kt

@@ -37,10 +37,10 @@ internal class ZoomableWorker(
                 GetZoom(),
             )
 
-        when (returnTypeValue) {
-            is StringValue -> return returnTypeValue.value.toDouble()
-            is DoubleValue -> return returnTypeValue.value
-            else -> return 0.0
+        return when (returnTypeValue) {
+            is StringValue -> returnTypeValue.value.toDouble()
+            is DoubleValue -> returnTypeValue.value
+            else -> 0.0
         }
     }