Add ModelLayer support (#554)

* Add ModelLayer support

* Add ModelLayer example page

* Add Android support

* Store test results

Author: OdNairy

.circleci/config.yml

@@ -1,6 +1,6 @@
 version: 2.1
 
-orbs: 
+orbs:
   flutter: circleci/flutter@2.0.2
   macos: circleci/macos@2.4.1
   gcp-cli: circleci/gcp-cli@3.1.1
@@ -14,7 +14,7 @@ commands:
           command: |
             echo "machine api.mapbox.com login mapbox password ${SDK_REGISTRY_TOKEN}" >> ~/.netrc
             chmod 0600 ~/.netrc
-  
+
   setup-gcloud:
     steps:
       - gcp-cli/setup:
@@ -86,7 +86,7 @@ jobs:
               --num-flaky-test-attempts 3 \
               --no-record-video \
               --no-performance-metrics
-                         
+
   build-ios:
     parameters:
       workspace-path:
@@ -145,7 +145,23 @@ jobs:
               --test << parameters.workspace-path >>/build_products.zip \
               --device model=iphone13pro,version=15.7 \
               --timeout 5m \
-              --num-flaky-test-attempts 3
+              --num-flaky-test-attempts 3 2>&1 | tee firebase_test_lab_run.log
+      - run:
+          name: Download XCResults
+          command: |
+            TEST_LAB_PATH=$(cat firebase_test_lab_run.log | grep -o "test-lab.*/")
+
+            mkdir testlab_results
+            gsutil -m cp -r "gs://${TEST_LAB_PATH}i*" testlab_results
+            zip -r testlab_results.zip testlab_results
+          when: always
+      - store_artifacts:
+          path: firebase_test_lab_run.log
+      - store_artifacts:
+          path: testlab_results.zip
+      - store_test_results:
+          path: testlab_results
+
 
 
 

CHANGELOG.md

@@ -1,3 +1,7 @@
+### main
+
+* Add ModelLayer API.
+
 ### 2.0.0
 
 #### ⚠️ Breaking changes
@@ -68,7 +72,7 @@ PolygonAnnotationOptions(
 )
 PolylineAnnotationOptions(
   geometry: LineString(coordinates: [
-    Position(1.0, 2.0), 
+    Position(1.0, 2.0),
     Position(10.0, 20.0)
   ]).toJson()
 )
@@ -93,7 +97,7 @@ PolygonAnnotationOptions(
 )
 PolylineAnnotationOptions(
   geometry: LineString(coordinates: [
-    Position(1.0, 2.0), 
+    Position(1.0, 2.0),
     Position(10.0, 20.0)
   ])
 )
@@ -145,8 +149,8 @@ Please note that the `snapshot()` method works best if the Mapbox Map is fully l
 * Fix multi-word enum cases decoding/encoding when being sent to/from the platform side.
 * [Android] Add Gradle 8 compatibility.
 * Introduce experimental `RasterArraySource`, note that `rasterLayers` is a get-only property and cannot be set.
-* Introduce `TileCacheBudget`, a property to set per-source cache budgets in either megabytes or tiles. 
-* Expose `iconColorSaturation`, `rasterArrayBand`, `rasterElevation`, `rasterEmissiveStrength`, `hillshadeEmissiveStrength`, and `fillExtrusionEmissiveStrength` on their respective layers. 
+* Introduce `TileCacheBudget`, a property to set per-source cache budgets in either megabytes or tiles.
+* Expose `iconColorSaturation`, `rasterArrayBand`, `rasterElevation`, `rasterEmissiveStrength`, `hillshadeEmissiveStrength`, and `fillExtrusionEmissiveStrength` on their respective layers.
 * Mark `MapboxMapsOptions.get/setWorldview()` and `MapboxMapsOptions.get/setLanguage()` as experimental.
 * Bump Pigeon to 17.1.2
 * [iOS] Fix crash in `onStyleImageMissingListener`.
@@ -267,7 +271,7 @@ We have matched screen-related units expected by the maps plugin to the units th
 
 ## 0.4.3
 ### Common
-* Fix multiple memory leaks. 
+* Fix multiple memory leaks.
 
 ## 0.4.2
 ### Common
@@ -279,7 +283,7 @@ We have matched screen-related units expected by the maps plugin to the units th
 * Fix vertical scrollMode lock on gesture settings update.
 
 ### Android
-* Fix ImageStretches mapping. 
+* Fix ImageStretches mapping.
 
 ## 0.4.1
 
@@ -292,16 +296,16 @@ We have matched screen-related units expected by the maps plugin to the units th
 ### iOS
 * Fix `pixelsForCoordinates` implementation.
 
-## 0.4.0 
+## 0.4.0
 
 ### Common
-* Expose `style.localizeLabels`. 
+* Expose `style.localizeLabels`.
 * Expose `mapboxMap.attribution`, `mapboxMap.logo`, `mapboxMap.compass` and `mapboxMap.scaleBar` settings.
 
 ### iOS
 * Fix deployment target for iOS to 11.
 
-## 0.3.0 
+## 0.3.0
 
 ### Common
 * Rename library to `mapbox_maps_flutter` due to naming conflict to be able publish to `pub.dev`.

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

@@ -3,6 +3,8 @@ package com.mapbox.maps.mapbox_maps
 import android.content.Context
 import android.graphics.Bitmap
 import com.google.gson.Gson
+import com.mapbox.bindgen.Expected
+import com.mapbox.bindgen.None
 import com.mapbox.geojson.*
 import com.mapbox.maps.EdgeInsets
 import com.mapbox.maps.extension.style.layers.properties.generated.ProjectionName
@@ -524,4 +526,12 @@ fun Bitmap.toMbxImage(): MbxImage {
   val outputStream = ByteArrayOutputStream(byteCount)
   compress(Bitmap.CompressFormat.PNG, 100, outputStream)
   return MbxImage(width.toLong(), height.toLong(), outputStream.toByteArray())
+}
+
+fun Expected<String, None>.handleResult(callback: (Result<Unit>) -> Unit) {
+  if (this.isError) {
+    callback(Result.failure(Throwable(this.error)))
+  } else {
+    callback(Result.success(Unit))
+  }
 }

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

@@ -604,6 +604,16 @@ class StyleController(private val context: Context, private val styleManager: Ma
       callback(Result.success(Unit))
     }
   }
+
+  override fun addStyleModel(modelId: String, modelUri: String, callback: (Result<Unit>) -> Unit) {
+    styleManager.addStyleModel(modelId, modelUri)
+      .handleResult(callback)
+  }
+
+  override fun removeStyleModel(modelId: String, callback: (Result<Unit>) -> Unit) {
+    styleManager.removeStyleModel(modelId)
+      .handleResult(callback)
+  }
 }
 
 fun Any.toValue(): Value {

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

@@ -5939,6 +5939,26 @@ interface StyleManager {
    * @return True if image exists, false otherwise.
    */
   fun hasStyleImage(imageId: String, callback: (Result<Boolean>) -> Unit)
+  /**
+   * Adds a model to be used in the style. This API can also be used for updating
+   * a model. If the model for a given `modelId` was already added, it gets replaced by the new model.
+   *
+   * The model can be used in `model-id` property in model layer.
+   *
+   * @param modelId An identifier of the model.
+   * @param modelUri A URI for the model.
+   *
+   * @return A string describing an error if the operation was not successful, empty otherwise.
+   */
+  fun addStyleModel(modelId: String, modelUri: String, callback: (Result<Unit>) -> Unit)
+  /**
+   * Removes a model from the style.
+   *
+   * @param modelId The identifier of the model to remove.
+   *
+   * @return A string describing an error if the operation was not successful, empty otherwise.
+   */
+  fun removeStyleModel(modelId: String, callback: (Result<Unit>) -> Unit)
   /**
    * Set tile data of a custom geometry.
    *
@@ -6899,6 +6919,45 @@ interface StyleManager {
           channel.setMessageHandler(null)
         }
       }
+      run {
+        val channel = BasicMessageChannel<Any?>(binaryMessenger, "dev.flutter.pigeon.mapbox_maps_flutter.StyleManager.addStyleModel$separatedMessageChannelSuffix", codec)
+        if (api != null) {
+          channel.setMessageHandler { message, reply ->
+            val args = message as List<Any?>
+            val modelIdArg = args[0] as String
+            val modelUriArg = args[1] as String
+            api.addStyleModel(modelIdArg, modelUriArg) { result: Result<Unit> ->
+              val error = result.exceptionOrNull()
+              if (error != null) {
+                reply.reply(wrapError(error))
+              } else {
+                reply.reply(wrapResult(null))
+              }
+            }
+          }
+        } else {
+          channel.setMessageHandler(null)
+        }
+      }
+      run {
+        val channel = BasicMessageChannel<Any?>(binaryMessenger, "dev.flutter.pigeon.mapbox_maps_flutter.StyleManager.removeStyleModel$separatedMessageChannelSuffix", codec)
+        if (api != null) {
+          channel.setMessageHandler { message, reply ->
+            val args = message as List<Any?>
+            val modelIdArg = args[0] as String
+            api.removeStyleModel(modelIdArg) { result: Result<Unit> ->
+              val error = result.exceptionOrNull()
+              if (error != null) {
+                reply.reply(wrapError(error))
+              } else {
+                reply.reply(wrapResult(null))
+              }
+            }
+          }
+        } else {
+          channel.setMessageHandler(null)
+        }
+      }
       run {
         val channel = BasicMessageChannel<Any?>(binaryMessenger, "dev.flutter.pigeon.mapbox_maps_flutter.StyleManager.invalidateStyleCustomGeometrySourceTile$separatedMessageChannelSuffix", codec)
         if (api != null) {

example/integration_test/style/layer/model_layer_test.dart

@@ -0,0 +1,68 @@
+// This file is generated.
+import 'dart:convert';
+import 'package:flutter/material.dart' hide Visibility;
+import 'package:flutter/services.dart';
+import 'package:flutter_test/flutter_test.dart';
+import 'package:integration_test/integration_test.dart';
+import 'package:mapbox_maps_flutter/mapbox_maps_flutter.dart';
+import 'package:mapbox_maps_example/empty_map_widget.dart' as app;
+
+void main() {
+  IntegrationTestWidgetsFlutterBinding.ensureInitialized();
+
+  testWidgets('Add ModelLayer', (WidgetTester tester) async {
+    final mapFuture = app.main();
+    await tester.pumpAndSettle();
+    final mapboxMap = await mapFuture;
+
+    await mapboxMap.style.addLayer(ModelLayer(
+      id: 'layer',
+      sourceId: "composite",
+      sourceLayer: "building",
+      visibility: Visibility.NONE,
+      minZoom: 1.0,
+      maxZoom: 20.0,
+      slot: LayerSlot.BOTTOM,
+      modelId: "abc",
+      modelAmbientOcclusionIntensity: 1.0,
+      modelCastShadows: true,
+      modelColor: Colors.red.value,
+      modelColorMixIntensity: 1.0,
+      modelCutoffFadeRange: 1.0,
+      modelEmissiveStrength: 1.0,
+      modelHeightBasedEmissiveStrengthMultiplier: [0.0, 1.0, 2.0, 3.0, 4.0],
+      modelOpacity: 1.0,
+      modelReceiveShadows: true,
+      modelRotation: [0.0, 1.0, 2.0],
+      modelRoughness: 1.0,
+      modelScale: [0.0, 1.0, 2.0],
+      modelScaleMode: ModelScaleMode.MAP,
+      modelTranslation: [0.0, 1.0, 2.0],
+      modelType: ModelType.COMMON_3D,
+    ));
+    var layer = await mapboxMap.style.getLayer('layer') as ModelLayer;
+    expect('composite', layer.sourceId);
+    expect(layer.minZoom, 1);
+    expect(layer.maxZoom, 20);
+    expect(layer.slot, LayerSlot.BOTTOM);
+    expect(layer.visibility, Visibility.NONE);
+    expect(layer.modelId, "abc");
+    expect(layer.modelAmbientOcclusionIntensity, 1.0);
+    expect(layer.modelCastShadows, true);
+    expect(layer.modelColor, Colors.red.value);
+    expect(layer.modelColorMixIntensity, 1.0);
+    expect(layer.modelCutoffFadeRange, 1.0);
+    expect(layer.modelEmissiveStrength, 1.0);
+    expect(layer.modelHeightBasedEmissiveStrengthMultiplier,
+        [0.0, 1.0, 2.0, 3.0, 4.0]);
+    expect(layer.modelOpacity, 1.0);
+    expect(layer.modelReceiveShadows, true);
+    expect(layer.modelRotation, [0.0, 1.0, 2.0]);
+    expect(layer.modelRoughness, 1.0);
+    expect(layer.modelScale, [0.0, 1.0, 2.0]);
+    expect(layer.modelScaleMode, ModelScaleMode.MAP);
+    expect(layer.modelTranslation, [0.0, 1.0, 2.0]);
+    expect(layer.modelType, ModelType.COMMON_3D);
+  });
+}
+// End of generated file.

example/ios/Podfile.lock

@@ -42,7 +42,7 @@ EXTERNAL SOURCES:
 
 SPEC CHECKSUMS:
   Flutter: e0871f40cf51350855a761d2e70bf5af5b9b5de7
-  integration_test: ce0a3ffa1de96d1a89ca0ac26fca7ea18a749ef4
+  integration_test: 13825b8a9334a850581300559b8839134b124670
   mapbox_maps_flutter: 2ef4455f071d3c707c30d37fc2990c7c927fb844
   MapboxCommon: 6acbd8ff41d66abf498e1558b0739f25c562945a
   MapboxCoreMaps: f306bb1b10ebe995a2247b40e99322ab7f9b8071

example/lib/main.dart

@@ -4,6 +4,7 @@ import 'package:mapbox_maps_example/animation.dart';
 import 'package:mapbox_maps_example/camera.dart';
 import 'package:mapbox_maps_example/circle_annotations.dart';
 import 'package:mapbox_maps_example/cluster.dart';
+import 'package:mapbox_maps_example/model_layer.dart';
 import 'package:mapbox_maps_example/ornaments.dart';
 import 'package:mapbox_maps_example/geojson_line.dart';
 import 'package:mapbox_maps_example/image_source.dart';
@@ -46,6 +47,7 @@ final List<ExamplePage> _allPages = <ExamplePage>[
   AnimatedRoutePage(),
   SnapshotterPage(),
   TrafficRouteLinePage(),
+  ModelLayerPage(),
 ];
 
 class MapsDemo extends StatelessWidget {