fix!: more jni related improvements, animateCamera no longer awaits until finished (#90)

- [x] use onMapReady callback
- [x] [breaking] animateCamera don't await until the animation has
finished

Author: josxha

android/src/main/kotlin/com/github/josxha/maplibre/MapLibreMapController.kt

@@ -141,6 +141,7 @@ class MapLibreMapController(
             this.style = loadedStyle
             flutterApi.onStyleLoaded { }
         }
+        flutterApi.onMapReady { }
     }
 
     override fun dispose() {
@@ -165,6 +166,7 @@ class MapLibreMapController(
                                 val expression = Expression.Converter.convert(json)
                                 PaintPropertyValue(entry.key, expression)
                             }
+
                             else -> {
                                 PaintPropertyValue(entry.key, value.toArray())
                             }
@@ -191,6 +193,7 @@ class MapLibreMapController(
                                 val expression = Expression.Converter.convert(json)
                                 LayoutPropertyValue(entry.key, expression)
                             }
+
                             else -> {
                                 LayoutPropertyValue(entry.key, value.toArray())
                             }

android/src/main/kotlin/com/github/josxha/maplibre/Pigeon.g.kt

@@ -776,6 +776,24 @@ class MapLibreFlutterApi(private val binaryMessenger: BinaryMessenger, private v
       } 
     }
   }
+  /** Callback for when the map is ready and can be used. */
+  fun onMapReady(callback: (Result<Unit>) -> Unit)
+{
+    val separatedMessageChannelSuffix = if (messageChannelSuffix.isNotEmpty()) ".$messageChannelSuffix" else ""
+    val channelName = "dev.flutter.pigeon.maplibre.MapLibreFlutterApi.onMapReady$separatedMessageChannelSuffix"
+    val channel = BasicMessageChannel<Any?>(binaryMessenger, channelName, codec)
+    channel.send(null) {
+      if (it is List<*>) {
+        if (it.size > 1) {
+          callback(Result.failure(FlutterError(it[0] as String, it[1] as String, it[2] as String?)))
+        } else {
+          callback(Result.success(Unit))
+        }
+      } else {
+        callback(Result.failure(createConnectionError(channelName)))
+      } 
+    }
+  }
   /** Callback when the user clicks on the map. */
   fun onClick(pointArg: LngLat, callback: (Result<Unit>) -> Unit)
 {

example/lib/two_maps_page.dart

@@ -66,6 +66,8 @@ class _ButtonsWidget extends StatelessWidget {
               controller?.moveCamera(
                 center: Position(172.4714, -42.4862),
                 zoom: 4,
+                bearing: 0,
+                pitch: 0,
               );
             },
             child: const Text('Move to New Zealand'),

ios/Classes/Pigeon.g.swift

@@ -743,6 +743,8 @@ protocol MapLibreFlutterApiProtocol {
   func getOptions(completion: @escaping (Result<MapOptions, PigeonError>) -> Void)
   /// Callback for when the style has been loaded.
   func onStyleLoaded(completion: @escaping (Result<Void, PigeonError>) -> Void)
+  /// Callback for when the map is ready and can be used.
+  func onMapReady(completion: @escaping (Result<Void, PigeonError>) -> Void)
   /// Callback when the user clicks on the map.
   func onClick(point pointArg: LngLat, completion: @escaping (Result<Void, PigeonError>) -> Void)
   /// Callback when the map idles.
@@ -812,6 +814,25 @@ class MapLibreFlutterApi: MapLibreFlutterApiProtocol {
       }
     }
   }
+  /// Callback for when the map is ready and can be used.
+  func onMapReady(completion: @escaping (Result<Void, PigeonError>) -> Void) {
+    let channelName: String = "dev.flutter.pigeon.maplibre.MapLibreFlutterApi.onMapReady\(messageChannelSuffix)"
+    let channel = FlutterBasicMessageChannel(name: channelName, binaryMessenger: binaryMessenger, codec: codec)
+    channel.sendMessage(nil) { response in
+      guard let listResponse = response as? [Any?] else {
+        completion(.failure(createConnectionError(withChannelName: channelName)))
+        return
+      }
+      if listResponse.count > 1 {
+        let code: String = listResponse[0] as! String
+        let message: String? = nilOrValue(listResponse[1])
+        let details: String? = nilOrValue(listResponse[2])
+        completion(.failure(PigeonError(code: code, message: message, details: details)))
+      } else {
+        completion(.success(Void()))
+      }
+    }
+  }
   /// Callback when the user clicks on the map.
   func onClick(point pointArg: LngLat, completion: @escaping (Result<Void, PigeonError>) -> Void) {
     let channelName: String = "dev.flutter.pigeon.maplibre.MapLibreFlutterApi.onClick\(messageChannelSuffix)"

lib/src/map.dart

@@ -33,12 +33,16 @@ class MapLibreMap extends StatefulWidget {
   /// for gestures that were not claimed by any other gesture recognizer.
   final Set<Factory<OneSequenceGestureRecognizer>>? gestureRecognizers;
 
+  /// Called when the native platform view has been created and the map is
+  /// ready.
+  ///
   /// Please note: you should only add annotations (e.g. symbols or circles)
   /// after `onStyleLoadedCallback` has been called.
   final MapCreatedCallback? onMapCreated;
 
   /// Called when the map style has been successfully loaded and the annotation
-  /// managers have been enabled.
+  /// manager is active.
+  ///
   /// Please note: you should only add annotations (e.g. symbols or circles)
   /// after this callback has been called.
   final VoidCallback? onStyleLoaded;

lib/src/native/pigeon.g.dart

@@ -794,6 +794,9 @@ abstract class MapLibreFlutterApi {
   /// Callback for when the style has been loaded.
   void onStyleLoaded();
 
+  /// Callback for when the map is ready and can be used.
+  void onMapReady();
+
   /// Callback when the user clicks on the map.
   void onClick(LngLat point);
 
@@ -872,6 +875,29 @@ abstract class MapLibreFlutterApi {
         });
       }
     }
+    {
+      final BasicMessageChannel<
+          Object?> pigeonVar_channel = BasicMessageChannel<
+              Object?>(
+          'dev.flutter.pigeon.maplibre.MapLibreFlutterApi.onMapReady$messageChannelSuffix',
+          pigeonChannelCodec,
+          binaryMessenger: binaryMessenger);
+      if (api == null) {
+        pigeonVar_channel.setMessageHandler(null);
+      } else {
+        pigeonVar_channel.setMessageHandler((Object? message) async {
+          try {
+            api.onMapReady();
+            return wrapResponse(empty: true);
+          } on PlatformException catch (e) {
+            return wrapResponse(error: e);
+          } catch (e) {
+            return wrapResponse(
+                error: PlatformException(code: 'error', message: e.toString()));
+          }
+        });
+      }
+    }
     {
       final BasicMessageChannel<
           Object?> pigeonVar_channel = BasicMessageChannel<

lib/src/native/widget_state_jni.dart

@@ -1,5 +1,4 @@
 import 'dart:async';
-import 'dart:io';
 import 'dart:ui';
 
 import 'package:flutter/material.dart';
@@ -38,42 +37,39 @@ final class MapLibreMapStateJni extends State<MapLibreMap>
 
   @override
   Widget build(BuildContext context) {
-    if (Platform.isAndroid) {
-      // Texture Layer (or Texture Layer Hybrid Composition)
-      // Platform Views are rendered into a texture. Flutter draws the
-      // platform views (via the texture). Flutter content is rendered
-      // directly into a Surface.
-      // + good performance for Android Views
-      // + best performance for Flutter rendering.
-      // + all transformations work correctly.
-      // - quick scrolling (e.g. a web view) will be janky
-      // - SurfaceViews are problematic in this mode and will be moved into a
-      //   virtual display (breaking a11y)
-      // - Text magnifier will break unless Flutter is rendered into a
-      //   TextureView.
-      // https://docs.flutter.dev/platform-integration/android/platform-views#texturelayerhybridcompisition
-      return AndroidView(
-        viewType: 'plugins.flutter.io/maplibre',
-        onPlatformViewCreated: _onPlatformViewCreated,
-        gestureRecognizers: widget.gestureRecognizers,
-        creationParamsCodec: const StandardMessageCodec(),
-      );
-    } else if (Platform.isIOS) {
-      return UiKitView(
-        viewType: 'plugins.flutter.io/maplibre',
-        onPlatformViewCreated: _onPlatformViewCreated,
-        gestureRecognizers: widget.gestureRecognizers,
-        creationParamsCodec: const StandardMessageCodec(),
-      );
-    }
-    throw UnsupportedError('[MapLibreMap] Unsupported Platform');
+    // Texture Layer (or Texture Layer Hybrid Composition)
+    // Platform Views are rendered into a texture. Flutter draws the
+    // platform views (via the texture). Flutter content is rendered
+    // directly into a Surface.
+    // + good performance for Android Views
+    // + best performance for Flutter rendering.
+    // + all transformations work correctly.
+    // - quick scrolling (e.g. a web view) will be janky
+    // - SurfaceViews are problematic in this mode and will be moved into a
+    //   virtual display (breaking a11y)
+    // - Text magnifier will break unless Flutter is rendered into a
+    //   TextureView.
+    // https://docs.flutter.dev/platform-integration/android/platform-views#texturelayerhybridcompisition
+    return AndroidView(
+      viewType: 'plugins.flutter.io/maplibre',
+      onPlatformViewCreated: _onPlatformViewCreated,
+      gestureRecognizers: widget.gestureRecognizers,
+      creationParamsCodec: const StandardMessageCodec(),
+    );
   }
 
+  /// This method gets called when the platform view is created. It is not
+  /// guaranteed that the map is ready.
   void _onPlatformViewCreated(int viewId) {
     final channelSuffix = viewId.toString();
     _hostApi = pigeon.MapLibreHostApi(messageChannelSuffix: channelSuffix);
     pigeon.MapLibreFlutterApi.setUp(this, messageChannelSuffix: channelSuffix);
     _viewId = viewId;
+    jni.Logger.setVerbosity(jni.Logger.WARN);
+  }
+
+  @override
+  void onMapReady() {
     widget.onEvent?.call(MapEventMapCreated(mapController: this));
     widget.onMapCreated?.call(this);
   }
@@ -96,10 +92,6 @@ final class MapLibreMapStateJni extends State<MapLibreMap>
 
   Future<void> _updateOptions(MapLibreMap oldWidget) async {
     final jniMap = _jniMapLibreMap;
-    // We need to check for null to avoid crashes of the app when the map
-    // options change before the map has been initialized.
-    if (jniMap.isNull) return;
-
     final oldOptions = oldWidget.options;
     final options = _options;
     await runOnPlatformThread(() {
@@ -196,6 +188,7 @@ final class MapLibreMapStateJni extends State<MapLibreMap>
     double? bearing,
     double? pitch,
   }) async {
+    final jniMap = _jniMapLibreMap;
     final cameraPositionBuilder = jni.CameraPosition_Builder();
     if (center != null) cameraPositionBuilder.target(center.toLatLng());
     if (zoom != null) cameraPositionBuilder.zoom(zoom);
@@ -206,24 +199,21 @@ final class MapLibreMapStateJni extends State<MapLibreMap>
     cameraPositionBuilder.release();
     final cameraUpdate =
         jni.CameraUpdateFactory.newCameraPosition(cameraPosition);
-
-    final jniMap = _jniMapLibreMap;
     await runOnPlatformThread(() {
       final completer = Completer<void>();
-      jniMap.moveCamera$1(
+      jniMap.moveCamera(cameraUpdate);
+      /*jniMap.moveCamera$1(
         cameraUpdate,
         jni.MapLibreMap_CancelableCallback.implement(
           jni.$MapLibreMap_CancelableCallback(
-            onCancel: () => completer.completeError(
-              Exception('Animation cancelled.'),
-            ),
+            onCancel: () =>
+                completer.completeError(Exception('Animation cancelled.')),
             onFinish: completer.complete,
             onFinish$async: true,
             onCancel$async: true,
           ),
         ),
-      );
-      jniMap.moveCamera(cameraUpdate);
+      );*/
       return completer.future;
     });
     cameraUpdate.release();
@@ -239,6 +229,7 @@ final class MapLibreMapStateJni extends State<MapLibreMap>
     double webSpeed = 1.2,
     Duration? webMaxDuration,
   }) async {
+    final jniMap = _jniMapLibreMap;
     final cameraPositionBuilder = jni.CameraPosition_Builder();
     if (center != null) cameraPositionBuilder.target(center.toLatLng());
     if (zoom != null) cameraPositionBuilder.zoom(zoom);
@@ -250,23 +241,22 @@ final class MapLibreMapStateJni extends State<MapLibreMap>
     final cameraUpdate =
         jni.CameraUpdateFactory.newCameraPosition(cameraPosition);
 
-    final jniMapLibreMap = _jniMapLibreMap;
-    await runOnPlatformThread(() {
+    await runOnPlatformThread(() async {
       final completer = Completer<void>();
-      jniMapLibreMap.animateCamera$3(
+      jniMap.animateCamera$2(cameraUpdate, nativeDuration.inMilliseconds);
+      /*jniMap.animateCamera$3(
         cameraUpdate,
         nativeDuration.inMilliseconds,
         jni.MapLibreMap_CancelableCallback.implement(
           jni.$MapLibreMap_CancelableCallback(
-            onCancel: () => completer.completeError(
-              Exception('Animation cancelled.'),
-            ),
+            onCancel: () =>
+                completer.completeError(Exception('Animation cancelled.')),
             onFinish: completer.complete,
             onFinish$async: true,
             onCancel$async: true,
           ),
         ),
-      );
+      );*/
       return completer.future;
     });
     cameraUpdate.release();
@@ -285,12 +275,8 @@ final class MapLibreMapStateJni extends State<MapLibreMap>
     bool webLinear = false,
     EdgeInsets padding = EdgeInsets.zero,
   }) async {
-    final latLngBounds = jni.LatLngBounds.from(
-      bounds.latitudeNorth,
-      bounds.longitudeEast,
-      bounds.latitudeSouth,
-      bounds.longitudeWest,
-    );
+    final jniMap = _jniMapLibreMap;
+    final latLngBounds = bounds.toLatLngBounds();
     final cameraUpdate = jni.CameraUpdateFactory.newLatLngBounds$3(
       latLngBounds,
       bearing ?? -1.0,
@@ -302,23 +288,22 @@ final class MapLibreMapStateJni extends State<MapLibreMap>
     );
     latLngBounds.release();
 
-    final jniMapLibreMap = _jniMapLibreMap;
     await runOnPlatformThread(() {
       final completer = Completer<void>();
-      jniMapLibreMap.animateCamera$3(
+      jniMap.animateCamera$2(cameraUpdate, nativeDuration.inMilliseconds);
+      /*jniMap.animateCamera$3(
         cameraUpdate,
         nativeDuration.inMilliseconds,
         jni.MapLibreMap_CancelableCallback.implement(
           jni.$MapLibreMap_CancelableCallback(
-            onCancel: () => completer.completeError(
-              Exception('Animation cancelled.'),
-            ),
+            onCancel: () =>
+                completer.completeError(Exception('Animation cancelled.')),
             onFinish: completer.complete,
             onCancel$async: true,
             onFinish$async: true,
           ),
         ),
-      );
+      );*/
       return completer.future;
     });
     cameraUpdate.release();
@@ -522,16 +507,14 @@ final class MapLibreMapStateJni extends State<MapLibreMap>
   @override
   MapCamera getCamera() {
     final jniCamera = _jniMapLibreMap.getCameraPosition();
+    final jniTarget = jniCamera.target;
     final camera = MapCamera(
-      center: Position(
-        jniCamera.target.getLongitude(),
-        jniCamera.target.getLatitude(),
-      ),
+      center: Position(jniTarget.getLongitude(), jniTarget.getLatitude()),
       zoom: jniCamera.zoom,
       pitch: jniCamera.tilt,
       bearing: jniCamera.bearing,
     );
-    jniCamera.target.release();
+    jniTarget.release();
     jniCamera.release();
     return camera;
   }
@@ -550,7 +533,6 @@ final class MapLibreMapStateJni extends State<MapLibreMap>
     final jniBounds = await runOnPlatformThread<jni.LatLngBounds>(() {
       final region = projection.getVisibleRegion();
       final bounds = region.latLngBounds;
-      region.latLngBounds.release();
       region.release();
       return bounds;
     });
@@ -561,6 +543,7 @@ final class MapLibreMapStateJni extends State<MapLibreMap>
       latitudeNorth: jniBounds.latitudeNorth,
     );
     jniBounds.release();
+    jniBounds.release();
     return bounds;
   }