Minor improvements to logic and documentation

Author: jokerttu

packages/google_maps_flutter/google_maps_flutter_android/android/src/main/java/io/flutter/plugins/googlemaps/Convert.java

@@ -861,7 +861,8 @@ static Tile tileFromPigeon(Messages.PlatformTile tile) {
    *     asset files stored in the application's assets directory.
    * @param density the density of the display, used to calculate pixel dimensions.
    * @param wrapper the BitmapDescriptorFactoryWrapper to create BitmapDescriptor.
-   * @return the identifier of the ground overlay.
+   * @return the identifier of the ground overlay. The identifier is valid as long as the ground
+   *     overlay exists.
    * @throws IllegalArgumentException if required fields are missing or invalid.
    */
   static @NonNull String interpretGroundOverlayOptions(
@@ -911,8 +912,12 @@ static Tile tileFromPigeon(Messages.PlatformTile tile) {
       @NonNull String groundOverlayId,
       boolean isCreatedWithBounds) {
 
-    // Dummy image is used as image is a required field of PlatformGroundOverlay and converting
-    // BitmapDescriptor used by Google Maps back to PlatformImageDescriptor is not currently supported.
+    // Image is mandatory field on PlatformGroundOverlay (and it should be kept
+    // non-nullable), therefore image must be set for the object. The image is
+    // description either contains set of bytes, or path to asset. This info is
+    // converted to format google maps uses (BitmapDescription), and the original
+    // data is not stored on native code. Therefore placeholder image is used for
+    // the image field.
     Messages.PlatformBitmap dummyImage =
         new Messages.PlatformBitmap.Builder()
             .setBitmap(

packages/google_maps_flutter/google_maps_flutter_android/android/src/main/java/io/flutter/plugins/googlemaps/GroundOverlaySink.java

@@ -12,21 +12,71 @@
 
 /** Receiver of GroundOverlayOptions configuration. */
 interface GroundOverlaySink {
+  /**
+   * Sets the transparency of the ground overlay.
+   *
+   * @param transparency the transparency value, where 0 is fully opaque and 1 is fully transparent.
+   */
   void setTransparency(float transparency);
 
+  /**
+   * Sets the zIndex of the ground overlay.
+   *
+   * @param zIndex the zIndex value.
+   */
   void setZIndex(float zIndex);
 
+  /**
+   * Sets the visibility of the ground overlay.
+   *
+   * @param visible true to make the ground overlay visible, false to make it invisible.
+   */
   void setVisible(boolean visible);
 
+  /**
+   * Sets the anchor point of the ground overlay.
+   *
+   * @param u the u-coordinate of the anchor, as a ratio of the image width (in the range [0, 1]).
+   * @param v the v-coordinate of the anchor, as a ratio of the image height (in the range [0, 1]).
+   */
   void setAnchor(float u, float v);
 
+  /**
+   * Sets the bearing of the ground overlay.
+   *
+   * @param bearing the bearing in degrees clockwise from north.
+   */
   void setBearing(float bearing);
 
+  /**
+   * Sets the clickability of the ground overlay.
+   *
+   * @param clickable true to make the ground overlay clickable, false otherwise. When clickable,
+   *     the ground overlay triggers click events.
+   */
   void setClickable(boolean clickable);
 
+  /**
+   * Sets the image for the ground overlay.
+   *
+   * @param imageDescriptor the BitmapDescriptor representing the image.
+   */
   void setImage(@NonNull BitmapDescriptor imageDescriptor);
 
+  /**
+   * Sets the position of the ground overlay using a location and dimensions.
+   *
+   * @param location the LatLng location of the anchor point.
+   * @param width the width of the ground overlay.
+   * @param height the height of the ground overlay, or null to calculate proportions of the image
+   *     automatically.
+   */
   void setPosition(@NonNull LatLng location, @NonNull Float width, @Nullable Float height);
 
+  /**
+   * Sets the position of the ground overlay using bounds.
+   *
+   * @param bounds the LatLngBounds to fit the ground overlay within.
+   */
   void setPositionFromBounds(@NonNull LatLngBounds bounds);
 }

packages/google_maps_flutter/google_maps_flutter_android/example/integration_test/google_maps_tests.dart

@@ -4,7 +4,6 @@
 
 import 'dart:async';
 import 'dart:convert';
-import 'dart:io';
 import 'dart:typed_data';
 import 'dart:ui' as ui;
 
@@ -1001,7 +1000,7 @@ void googleMapsTests() {
   },
       // TODO(cyanglaz): un-skip the test when we can test this on CI with API key enabled.
       // https://github.com/flutter/flutter/issues/57057
-      skip: Platform.isAndroid);
+      skip: true);
 
   testWidgets(
     'set tileOverlay correctly',

packages/google_maps_flutter/google_maps_flutter_ios/ios/Classes/FLTGoogleMapJSONConversions.m

@@ -116,8 +116,12 @@ GMSMapViewType FGMGetMapViewTypeForPigeonMapType(FGMPlatformMapType type) {
 FGMPlatformGroundOverlay *FGMGetPigeonGroundOverlay(GMSGroundOverlay *groundOverlay,
                                                     NSString *overlayId, BOOL isCreatedWithBounds,
                                                     NSNumber *zoomLevel) {
-  /// Dummy image is used as image is required field of FGMPlatformGroundOverlay and converting
-  /// image back to bitmap image is not currently supported.
+  // Image is mandatory field on FGMPlatformGroundOverlay (and it should be kept
+  // non-nullable), therefore image must be set for the object. The image is
+  // description either contains set of bytes, or path to asset. This info is
+  // converted to format google maps uses (BitmapDescription), and the original
+  // data is not stored on native code. Therefore placeholder image is used for
+  // the image field.
   FGMPlatformBitmap *placeholderImage =
       [FGMPlatformBitmap makeWithBitmap:[FGMPlatformBitmapDefaultMarker makeWithHue:0]];
   if (isCreatedWithBounds) {

packages/google_maps_flutter/google_maps_flutter_web/lib/src/google_maps_inspector_web.dart

@@ -97,6 +97,8 @@ class GoogleMapsInspectorWeb extends GoogleMapsInspectorPlatform {
       return null;
     }
 
+    final JSAny? clickable = groundOverlay.get('clickable');
+
     return GroundOverlay.fromBounds(
         groundOverlayId: groundOverlayId,
         image: BytesMapBitmap(
@@ -106,8 +108,7 @@ class GoogleMapsInspectorWeb extends GoogleMapsInspectorPlatform {
         bounds: gmLatLngBoundsTolatLngBounds(groundOverlay.bounds),
         transparency: 1.0 - groundOverlay.opacity,
         visible: groundOverlay.map != null,
-        clickable: groundOverlay.get('clickable') is JSAny &&
-            (groundOverlay.get('clickable')! as JSBoolean).toDart);
+        clickable: clickable != null && (clickable as JSBoolean).toDart);
   }
 
   @override

packages/google_maps_flutter/google_maps_flutter_web/lib/src/ground_overlay.dart

@@ -11,19 +11,21 @@ class GroundOverlayController {
   GroundOverlayController({
     required gmaps.GroundOverlay groundOverlay,
     required VoidCallback onTap,
-  }) {
-    _groundOverlay = groundOverlay;
-    _groundOverlay.onClick.listen((gmaps.MapMouseEvent event) {
+  }) : _groundOverlay = groundOverlay {
+    groundOverlay.onClick.listen((gmaps.MapMouseEvent event) {
       onTap.call();
     });
   }
 
   /// The [GroundOverlay] providing data for this controller.
-  gmaps.GroundOverlay get groundOverlay => _groundOverlay;
-  late gmaps.GroundOverlay _groundOverlay;
+  gmaps.GroundOverlay? get groundOverlay => _groundOverlay;
+  gmaps.GroundOverlay? _groundOverlay;
 
   /// Removes the [GroundOverlay] from the map.
   void remove() {
-    _groundOverlay.map = null;
+    if (_groundOverlay != null) {
+      _groundOverlay!.map = null;
+      _groundOverlay = null;
+    }
   }
 }

packages/google_maps_flutter/google_maps_flutter_web/lib/src/ground_overlays.dart

@@ -64,16 +64,16 @@ class GroundOverlaysController extends GeometryController {
     final GroundOverlayController? controller =
         _groundOverlayIdToController[groundOverlay.groundOverlayId];
 
-    if (controller == null) {
+    if (controller == null || controller.groundOverlay == null) {
       return;
     }
 
     assert(groundOverlay.bounds != null,
         'On Web platform, bounds must be provided for GroundOverlay');
 
-    controller.groundOverlay.set('clickable', groundOverlay.clickable.toJS);
-    controller.groundOverlay.map = groundOverlay.visible ? googleMap : null;
-    controller.groundOverlay.opacity = 1.0 - groundOverlay.transparency;
+    controller.groundOverlay!.set('clickable', groundOverlay.clickable.toJS);
+    controller.groundOverlay!.map = groundOverlay.visible ? googleMap : null;
+    controller.groundOverlay!.opacity = 1.0 - groundOverlay.transparency;
   }
 
   /// Removes the ground overlays associated with the given [GroundOverlayId]s.