Get Flutter asset path in application bundle (#608)

- Provide correct path for local asset in application bundle for url with "asset" scheme

Author: maios

CHANGELOG.md

@@ -1,3 +1,7 @@
+### main
+
+* Support local assets for 3D puck and `ModelLayer`. To use a local assets, please specify it with `asset://` scheme in the uri.
+
 ### 2.1.0
 
 * Add ModelLayer API.

android/src/main/kotlin/com/mapbox/maps/mapbox_maps/LocationComponentController.kt

@@ -8,8 +8,10 @@ import com.mapbox.maps.mapbox_maps.pigeons.*
 import com.mapbox.maps.plugin.locationcomponent.createDefault2DPuck
 import com.mapbox.maps.plugin.locationcomponent.location
 
-class LocationComponentController(private val mapView: MapView, private val context: Context) :
-  _LocationComponentSettingsInterface {
+class LocationComponentController(
+  private val mapView: MapView,
+  private val context: Context
+) : _LocationComponentSettingsInterface {
   override fun getSettings(): LocationComponentSettings = mapView.location.toFLT(context)
 
   override fun updateSettings(settings: LocationComponentSettings, useDefaultPuck2DIfNeeded: Boolean) {

android/src/main/kotlin/com/mapbox/maps/mapbox_maps/MapboxMapFactory.kt

@@ -18,13 +18,15 @@ import com.mapbox.maps.Style
 import com.mapbox.maps.ViewportMode
 import com.mapbox.maps.applyDefaultParams
 import com.mapbox.maps.mapbox_maps.mapping.turf.PointDecoder
+import io.flutter.embedding.engine.plugins.FlutterPlugin
 import io.flutter.plugin.common.BinaryMessenger
 import io.flutter.plugin.common.StandardMessageCodec
 import io.flutter.plugin.platform.PlatformView
 import io.flutter.plugin.platform.PlatformViewFactory
 
 class MapboxMapFactory(
   private val messenger: BinaryMessenger,
+  private val flutterAssets: FlutterPlugin.FlutterAssets,
   private val lifecycleProvider: MapboxMapsPlugin.LifecycleProvider
 ) : PlatformViewFactory(StandardMessageCodec.INSTANCE) {
 

android/src/main/kotlin/com/mapbox/maps/mapbox_maps/MapboxMapsPlugin.kt

@@ -12,6 +12,7 @@ import com.mapbox.maps.mapbox_maps.pigeons._SnapshotterInstanceManager
 import com.mapbox.maps.mapbox_maps.pigeons._TileStoreInstanceManager
 import com.mapbox.maps.mapbox_maps.snapshot.SnapshotterInstanceManager
 import io.flutter.embedding.engine.plugins.FlutterPlugin
+import io.flutter.embedding.engine.plugins.FlutterPlugin.FlutterAssets
 import io.flutter.embedding.engine.plugins.activity.ActivityAware
 import io.flutter.embedding.engine.plugins.activity.ActivityPluginBinding
 import io.flutter.embedding.engine.plugins.lifecycle.FlutterLifecycleAdapter
@@ -28,19 +29,19 @@ class MapboxMapsPlugin : FlutterPlugin, ActivityAware {
         "plugins.flutter.io/mapbox_maps",
         MapboxMapFactory(
           flutterPluginBinding.binaryMessenger,
+          flutterPluginBinding.flutterAssets,
           object : LifecycleProvider {
             override fun getLifecycle(): Lifecycle? {
               return lifecycle
             }
           }
         )
       )
-
-    setupStaticChannels(flutterPluginBinding.applicationContext, flutterPluginBinding.binaryMessenger)
+    setupStaticChannels(flutterPluginBinding.applicationContext, flutterPluginBinding.binaryMessenger, flutterPluginBinding.flutterAssets)
   }
 
-  private fun setupStaticChannels(context: Context, binaryMessenger: BinaryMessenger) {
-    val optionsController = MapboxOptionsController()
+  private fun setupStaticChannels(context: Context, binaryMessenger: BinaryMessenger, flutterAssets: FlutterAssets) {
+    val optionsController = MapboxOptionsController(flutterAssets)
     val snapshotterInstanceManager = SnapshotterInstanceManager(context, binaryMessenger)
     val offlineMapInstanceManager = OfflineMapInstanceManager(context, binaryMessenger)
     val offlineSwitch = OfflineSwitch()

android/src/main/kotlin/com/mapbox/maps/mapbox_maps/MapboxOptionsController.kt

@@ -7,8 +7,11 @@ import com.mapbox.common.SettingsServiceFactory
 import com.mapbox.common.SettingsServiceStorageType
 import com.mapbox.maps.MapboxMapsOptions
 import com.mapbox.maps.mapbox_maps.pigeons.*
+import io.flutter.embedding.engine.plugins.FlutterPlugin.FlutterAssets
 
-class MapboxOptionsController : _MapboxMapsOptions, _MapboxOptions {
+class MapboxOptionsController(
+  private val flutterAssets: FlutterAssets
+) : _MapboxMapsOptions, _MapboxOptions {
   private val settingsService = SettingsServiceFactory.getInstance(SettingsServiceStorageType.PERSISTENT)
 
   override fun getAccessToken(): String {
@@ -39,6 +42,10 @@ class MapboxOptionsController : _MapboxMapsOptions, _MapboxOptions {
     return ""
   }
 
+  override fun getFlutterAssetPath(flutterAssetUri: String?): String? {
+    return flutterAssetUri?.replace("""^asset://(.+)""".toRegex(), "asset://${flutterAssets.getAssetFilePathBySubpath("$1")}")
+  }
+
   override fun setAssetPath(path: String) {
     // ignored on Android
   }

android/src/main/kotlin/com/mapbox/maps/mapbox_maps/pigeons/MapInterfaces.kt

@@ -4332,6 +4332,7 @@ interface _MapboxMapsOptions {
   fun setDataPath(path: String)
   fun getAssetPath(): String
   fun setAssetPath(path: String)
+  fun getFlutterAssetPath(flutterAssetUri: String?): String?
   fun getTileStoreUsageMode(): TileStoreUsageMode
   fun setTileStoreUsageMode(mode: TileStoreUsageMode)
   fun getWorldview(): String?
@@ -4453,6 +4454,24 @@ interface _MapboxMapsOptions {
           channel.setMessageHandler(null)
         }
       }
+      run {
+        val channel = BasicMessageChannel<Any?>(binaryMessenger, "dev.flutter.pigeon.mapbox_maps_flutter._MapboxMapsOptions.getFlutterAssetPath$separatedMessageChannelSuffix", codec)
+        if (api != null) {
+          channel.setMessageHandler { message, reply ->
+            val args = message as List<Any?>
+            val flutterAssetUriArg = args[0] as String?
+            var wrapped: List<Any?>
+            try {
+              wrapped = listOf<Any?>(api.getFlutterAssetPath(flutterAssetUriArg))
+            } catch (exception: Throwable) {
+              wrapped = wrapError(exception)
+            }
+            reply.reply(wrapped)
+          }
+        } else {
+          channel.setMessageHandler(null)
+        }
+      }
       run {
         val channel = BasicMessageChannel<Any?>(binaryMessenger, "dev.flutter.pigeon.mapbox_maps_flutter._MapboxMapsOptions.getTileStoreUsageMode$separatedMessageChannelSuffix", codec)
         if (api != null) {

example/assets/sportcar.glb

@@ -115,7 +115,7 @@ void main() {
                 modelTranslation: [0.0, 1.0, 2.0],
                 modelScaleExpression: expression)));
 
-    location.updateSettings(settings);
+    await location.updateSettings(settings);
 
     final updatedSettings = await location.getSettings();
     expect(updatedSettings.enabled, settings.enabled);

example/integration_test/location_test.dart

@@ -1,3 +1,4 @@
+import 'package:flutter/cupertino.dart';
 import 'package:flutter/material.dart';
 import 'package:flutter/services.dart';
 import 'package:mapbox_maps_flutter/mapbox_maps_flutter.dart';
@@ -180,9 +181,9 @@ class LocationPageBodyState extends State<LocationPageBody> {
     );
   }
 
-  Widget _switchLocationPuck3D() {
+  Widget _switchLocationPuck3D_duck() {
     return TextButton(
-      child: Text('switch to 3d puck'),
+      child: Text('switch to 3d puck with duck model'),
       onPressed: () {
         mapboxMap?.location.updateSettings(LocationComponentSettings(
             locationPuck: LocationPuck(
@@ -194,6 +195,19 @@ class LocationPageBodyState extends State<LocationPageBody> {
     );
   }
 
+  Widget _switchLocationPuck3D_car() {
+    return TextButton(
+      child: Text('switch to 3d puck with car model'),
+      onPressed: () {
+        mapboxMap?.location.updateSettings(LocationComponentSettings(
+            locationPuck: LocationPuck(
+                locationPuck3D: LocationPuck3D(
+                    modelUri: "asset://assets/sportcar.glb",
+                    modelScale: [_puckScale, _puckScale, _puckScale]))));
+      },
+    );
+  }
+
   Widget _switchPuckScale() {
     return TextButton(
       child: Text('scale 3d puck'),
@@ -262,7 +276,8 @@ class LocationPageBodyState extends State<LocationPageBody> {
         _show(),
         _hide(),
         _switchLocationPuck2D(),
-        _switchLocationPuck3D(),
+        _switchLocationPuck3D_duck(),
+        _switchLocationPuck3D_car(),
         _switchPuckScale(),
         _showBearing(),
         _hideBearing(),

example/lib/location.dart

@@ -58,19 +58,30 @@ class _ModelLayerState extends State<ModelLayerWidget> {
       throw Exception("MapboxMap is not ready yet");
     }
 
-    var modelId = "model-test-id";
-    var uri =
+    final buggyModelId = "model-test-id";
+    final buggyModelUri =
         "https://github.com/KhronosGroup/glTF-Sample-Models/raw/d7a3cc8e51d7c573771ae77a57f16b0662a905c6/2.0/Buggy/glTF/Buggy.gltf";
-    await mapboxMap?.style.addStyleModel(modelId, uri);
+    await mapboxMap?.style.addStyleModel(buggyModelId, buggyModelUri);
+
+    final carModelId = "model-car-id";
+    final carModelUri = "asset://assets/sportcar.glb";
+    await mapboxMap?.style.addStyleModel(carModelId, carModelUri);
 
     await mapboxMap?.style
         .addSource(GeoJsonSource(id: "sourceId", data: json.encode(value)));
 
-    var modelLayer = ModelLayer(id: "modelLayer", sourceId: "sourceId");
-    modelLayer.modelId = modelId;
+    var modelLayer = ModelLayer(id: "modelLayer-buggy", sourceId: "sourceId");
+    modelLayer.modelId = buggyModelId;
     modelLayer.modelScale = [0.15, 0.15, 0.15];
     modelLayer.modelRotation = [0, 0, 90];
     modelLayer.modelType = ModelType.COMMON_3D;
     mapboxMap?.style.addLayer(modelLayer);
+
+    var modelLayer1 = ModelLayer(id: "modelLayer-car", sourceId: "sourceId");
+    modelLayer1.modelId = carModelId;
+    modelLayer1.modelScale = [0.15, 0.15, 0.15];
+    modelLayer1.modelRotation = [0, 0, 90];
+    modelLayer1.modelType = ModelType.COMMON_3D;
+    mapboxMap?.style.addLayer(modelLayer1);
   }
 }