RD-1380: Add areTilesLoaded method to the map - Kotlin (#91)

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

Author: 3 people

MapTilerSDK/src/main/java/com/maptiler/maptilersdk/commands/navigation/AreTilesLoaded.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 AreTilesLoaded : MTCommand {
+    override val isPrimitiveReturnType: Boolean = true
+
+    override fun toJS(): String = "${MTBridge.MAP_OBJECT}.areTilesLoaded();"
+}

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

@@ -404,8 +404,16 @@ class MTMapViewController(
      */
     override suspend fun getCenterClampedToGround(): Boolean = navigableWorker.getCenterClampedToGround()
 
+    /**
+     * Returns whether the map is set to render multiple world copies.
+     */
     override suspend fun getRenderWorldCopies(): Boolean = navigableWorker.getRenderWorldCopies()
 
+    /**
+     * Returns whether all currently requested tiles are loaded.
+     */
+    override suspend fun areTilesLoaded(): Boolean = navigableWorker.areTilesLoaded()
+
     /**
      * Returns the pixel ratio currently used to render the map.
      */

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

@@ -139,6 +139,11 @@ interface MTNavigable {
      */
     suspend fun getRenderWorldCopies(): Boolean
 
+    /**
+     * Returns whether all currently requested tiles are loaded.
+     */
+    suspend fun areTilesLoaded(): Boolean
+
     /**
      * Returns the pixel ratio currently used to render the map.
      */

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

@@ -11,6 +11,7 @@ import com.maptiler.maptilersdk.bridge.MTBridgeReturnType.BoolValue
 import com.maptiler.maptilersdk.bridge.MTBridgeReturnType.DoubleValue
 import com.maptiler.maptilersdk.bridge.MTBridgeReturnType.Null
 import com.maptiler.maptilersdk.bridge.MTBridgeReturnType.StringValue
+import com.maptiler.maptilersdk.commands.navigation.AreTilesLoaded
 import com.maptiler.maptilersdk.commands.navigation.EaseTo
 import com.maptiler.maptilersdk.commands.navigation.FitBounds
 import com.maptiler.maptilersdk.commands.navigation.FitToIpBounds
@@ -295,6 +296,27 @@ internal class NavigableWorker(
         }
     }
 
+    override suspend fun areTilesLoaded(): Boolean {
+        val returnTypeValue =
+            bridge.execute(
+                AreTilesLoaded(),
+            )
+
+        return when (returnTypeValue) {
+            is BoolValue -> returnTypeValue.value
+            is DoubleValue -> returnTypeValue.value != 0.0
+            is StringValue -> {
+                val normalized = returnTypeValue.value.trim().lowercase()
+                when (normalized) {
+                    "true" -> true
+                    "false" -> false
+                    else -> normalized.toDoubleOrNull()?.let { it != 0.0 } ?: false
+                }
+            }
+            else -> false
+        }
+    }
+
     override suspend fun getPixelRatio(): Double {
         val returnTypeValue =
             bridge.execute(

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

@@ -7,6 +7,7 @@
 package com.maptiler.maptilersdk
 
 import com.maptiler.maptilersdk.bridge.MTBridge
+import com.maptiler.maptilersdk.commands.navigation.AreTilesLoaded
 import com.maptiler.maptilersdk.commands.navigation.GetCenterClampedToGround
 import com.maptiler.maptilersdk.commands.navigation.GetCenterElevation
 import com.maptiler.maptilersdk.commands.navigation.GetMaxPitch
@@ -41,6 +42,11 @@ class NavigationTests {
         assertEquals("${MTBridge.MAP_OBJECT}.getRenderWorldCopies();", command.toJS())
     }
 
+    @Test fun areTilesLoadedToJS_ReturnsCorrectJSString() {
+        val command = AreTilesLoaded()
+        assertEquals("${MTBridge.MAP_OBJECT}.areTilesLoaded();", command.toJS())
+    }
+
     @Test fun getPixelRatioToJS_ReturnsCorrectJSString() {
         val command = GetPixelRatio()
         assertEquals("${MTBridge.MAP_OBJECT}.getPixelRatio();", command.toJS())

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

@@ -10,6 +10,7 @@ import com.maptiler.maptilersdk.bridge.MTBridge
 import com.maptiler.maptilersdk.bridge.MTBridgeReturnType
 import com.maptiler.maptilersdk.bridge.MTCommand
 import com.maptiler.maptilersdk.bridge.MTCommandExecutable
+import com.maptiler.maptilersdk.commands.navigation.AreTilesLoaded
 import com.maptiler.maptilersdk.commands.navigation.GetBearing
 import com.maptiler.maptilersdk.commands.navigation.GetCenterClampedToGround
 import com.maptiler.maptilersdk.commands.navigation.GetCenterElevation
@@ -124,6 +125,51 @@ class WorkerAndStyleTests {
             assertTrue(executedCommands.all { it is GetRenderWorldCopies })
         }
 
+    @Test fun navigableWorker_areTilesLoaded_ParsesPrimitiveReturnTypes() =
+        runBlocking {
+            val executedCommands = mutableListOf<MTCommand>()
+            val responses =
+                ArrayDeque(
+                    listOf(
+                        MTBridgeReturnType.BoolValue(true),
+                        MTBridgeReturnType.DoubleValue(0.0),
+                        MTBridgeReturnType.DoubleValue(1.0),
+                        MTBridgeReturnType.StringValue("false"),
+                        MTBridgeReturnType.StringValue("  TRUE  "),
+                        MTBridgeReturnType.StringValue("0"),
+                        MTBridgeReturnType.StringValue("unexpected"),
+                    ),
+                )
+
+            val exec =
+                object : MTCommandExecutable {
+                    override suspend fun execute(command: MTCommand): MTBridgeReturnType {
+                        executedCommands.add(command)
+                        return responses.removeFirst()
+                    }
+                }
+
+            val bridge = MTBridge(exec)
+            val worker = NavigableWorker(bridge, this)
+
+            val first = worker.areTilesLoaded()
+            val second = worker.areTilesLoaded()
+            val third = worker.areTilesLoaded()
+            val fourth = worker.areTilesLoaded()
+            val fifth = worker.areTilesLoaded()
+            val sixth = worker.areTilesLoaded()
+            val seventh = worker.areTilesLoaded()
+
+            assertEquals(true, first)
+            assertEquals(false, second)
+            assertEquals(true, third)
+            assertEquals(false, fourth)
+            assertEquals(true, fifth)
+            assertEquals(false, sixth)
+            assertEquals(false, seventh)
+            assertTrue(executedCommands.all { it is AreTilesLoaded })
+        }
+
     @Test fun navigableWorker_getCenterElevation_ParsesStringReturnType() =
         runBlocking {
             var usedGetCenterElevation = false