RD-1382: Add getCameraTargetElevation method to the map - Kotlin (#93)

Co-authored-by: klokantechsysadmin <[email protected]>
Co-authored-by: sasaprodribaba <[email protected]>

Author: 3 people

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

@@ -0,0 +1,16 @@
+/*
+ * Copyright (c) 2025, MapTiler
+ * All rights reserved.
+ * SPDX-License-Identifier: BSD 3-Clause
+ */
+
+package com.maptiler.maptilersdk.commands.navigation
+
+import com.maptiler.maptilersdk.bridge.MTBridge
+import com.maptiler.maptilersdk.bridge.MTCommand
+
+internal class GetCameraTargetElevation : MTCommand {
+    override val isPrimitiveReturnType: Boolean = true
+
+    override fun toJS(): String = "${MTBridge.MAP_OBJECT}.getCameraTargetElevation();"
+}

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

@@ -429,6 +429,11 @@ class MTMapViewController(
      */
     override suspend fun getCenterElevation(): Double = navigableWorker.getCenterElevation()
 
+    /**
+     * Returns the elevation of the location currently targeted by the camera, in meters above sea level.
+     */
+    override suspend fun getCameraTargetElevation(): Double = navigableWorker.getCameraTargetElevation()
+
     /**
      * Returns the geographical constraints currently applied to the map, if any.
      */

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

@@ -159,6 +159,11 @@ interface MTNavigable {
      */
     suspend fun getCenterElevation(): Double
 
+    /**
+     * Returns the elevation of the point currently targeted by the camera, in meters above sea level.
+     */
+    suspend fun getCameraTargetElevation(): Double
+
     /**
      * Returns the geographical constraints currently applied to the map, if any.
      */

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

@@ -19,6 +19,7 @@ import com.maptiler.maptilersdk.commands.navigation.FitToIpBounds
 import com.maptiler.maptilersdk.commands.navigation.FlyTo
 import com.maptiler.maptilersdk.commands.navigation.GetBearing
 import com.maptiler.maptilersdk.commands.navigation.GetBounds
+import com.maptiler.maptilersdk.commands.navigation.GetCameraTargetElevation
 import com.maptiler.maptilersdk.commands.navigation.GetCenter
 import com.maptiler.maptilersdk.commands.navigation.GetCenterClampedToGround
 import com.maptiler.maptilersdk.commands.navigation.GetCenterElevation
@@ -353,6 +354,19 @@ internal class NavigableWorker(
         }
     }
 
+    override suspend fun getCameraTargetElevation(): Double {
+        val returnTypeValue =
+            bridge.execute(
+                GetCameraTargetElevation(),
+            )
+
+        return when (returnTypeValue) {
+            is DoubleValue -> returnTypeValue.value
+            is StringValue -> returnTypeValue.value.toDoubleOrNull() ?: 0.0
+            else -> 0.0
+        }
+    }
+
     override suspend fun project(coordinates: LngLat): MTPoint {
         val returnTypeValue =
             bridge.execute(

MapTilerSDK/src/test/java/com/maptiler/maptilersdk/NavigationTests.kt

@@ -8,6 +8,7 @@ package com.maptiler.maptilersdk
 
 import com.maptiler.maptilersdk.bridge.MTBridge
 import com.maptiler.maptilersdk.commands.navigation.AreTilesLoaded
+import com.maptiler.maptilersdk.commands.navigation.GetCameraTargetElevation
 import com.maptiler.maptilersdk.commands.navigation.GetCenterClampedToGround
 import com.maptiler.maptilersdk.commands.navigation.GetCenterElevation
 import com.maptiler.maptilersdk.commands.navigation.GetMaxPitch
@@ -57,6 +58,11 @@ class NavigationTests {
         assertEquals("${MTBridge.MAP_OBJECT}.getCenterElevation();", command.toJS())
     }
 
+    @Test fun getCameraTargetElevationToJS_ReturnsCorrectJSString() {
+        val command = GetCameraTargetElevation()
+        assertEquals("${MTBridge.MAP_OBJECT}.getCameraTargetElevation();", command.toJS())
+    }
+
     @Test fun getMaxZoomToJS_ReturnsCorrectJSString() {
         val command = GetMaxZoom()
         assertEquals("${MTBridge.MAP_OBJECT}.getMaxZoom();", command.toJS())

MapTilerSDK/src/test/java/com/maptiler/maptilersdk/WorkerAndStyleTests.kt

@@ -13,6 +13,7 @@ import com.maptiler.maptilersdk.bridge.MTCommandExecutable
 import com.maptiler.maptilersdk.commands.navigation.AreTilesLoaded
 import com.maptiler.maptilersdk.commands.navigation.CenterOnIpPoint
 import com.maptiler.maptilersdk.commands.navigation.GetBearing
+import com.maptiler.maptilersdk.commands.navigation.GetCameraTargetElevation
 import com.maptiler.maptilersdk.commands.navigation.GetCenterClampedToGround
 import com.maptiler.maptilersdk.commands.navigation.GetCenterElevation
 import com.maptiler.maptilersdk.commands.navigation.GetRenderWorldCopies
@@ -208,6 +209,26 @@ class WorkerAndStyleTests {
             assertTrue(usedGetCenterElevation)
         }
 
+    @Test fun navigableWorker_getCameraTargetElevation_ParsesStringReturnType() =
+        runBlocking {
+            var usedGetCameraTargetElevation = false
+            val exec =
+                object : MTCommandExecutable {
+                    override suspend fun execute(command: MTCommand): MTBridgeReturnType {
+                        if (command is GetCameraTargetElevation) {
+                            usedGetCameraTargetElevation = true
+                        }
+                        return MTBridgeReturnType.StringValue("1337.0")
+                    }
+                }
+            val bridge = MTBridge(exec)
+            val worker = NavigableWorker(bridge, this)
+
+            val result = worker.getCameraTargetElevation()
+            assertEquals(1337.0, result, 0.0)
+            assertTrue(usedGetCameraTargetElevation)
+        }
+
     @Test fun stylableWorker_getProjection_UsesGetProjectionCommand() =
         runBlocking {
             var usedGetProjection = false