[google_maps_flutter] Support for Ground Overlay - platform interface (#8518)

This PR contains platform interface for the upcoming ground overlays support (#8432). Original PR with all the changes hasn't been approved yet but it was [okayed](#8432 (review)) to create the first sub-PR.

I'm not the author of the original PR but helping @jokerttu while he's on vacation.

Linked issue: flutter/flutter#26479

Author: aednlaxer

packages/google_maps_flutter/google_maps_flutter_platform_interface/CHANGELOG.md

@@ -1,6 +1,7 @@
-## NEXT
+## 2.10.0
 
 * Updates minimum supported SDK version to Flutter 3.22/Dart 3.4.
+* Adds support for ground overlay.
 
 ## 2.9.5
 

packages/google_maps_flutter/google_maps_flutter_platform_interface/lib/src/events/map_event.dart

@@ -152,6 +152,14 @@ class CircleTapEvent extends MapEvent<CircleId> {
   CircleTapEvent(super.mapId, super.circleId);
 }
 
+/// An event fired when a [GroundOverlay] is tapped.
+class GroundOverlayTapEvent extends MapEvent<GroundOverlayId> {
+  /// Build a GroundOverlayTap Event triggered from the map represented by `mapId`.
+  ///
+  /// The `value` of this event is a [GroundOverlayId] object that represents the tapped GroundOverlay.
+  GroundOverlayTapEvent(super.mapId, super.croundOverlayId);
+}
+
 /// An event fired when a Map is tapped.
 class MapTapEvent extends _PositionedMapEvent<void> {
   /// Build an MapTap Event triggered from the map represented by `mapId`.

packages/google_maps_flutter/google_maps_flutter_platform_interface/lib/src/platform_interface/google_maps_flutter_platform.dart

@@ -169,6 +169,18 @@ abstract class GoogleMapsFlutterPlatform extends PlatformInterface {
         'updateClusterManagers() has not been implemented.');
   }
 
+  /// Updates ground overlay configuration.
+  ///
+  /// The returned [Future] completes once the update has been made on the
+  /// platform side.
+  Future<void> updateGroundOverlays(
+    GroundOverlayUpdates groundOverlayUpdates, {
+    required int mapId,
+  }) {
+    throw UnimplementedError(
+        'updateGroundOverlays() has not been implemented.');
+  }
+
   /// Clears the tile cache so that all tiles will be requested again from the
   /// [TileProvider].
   ///
@@ -389,6 +401,11 @@ abstract class GoogleMapsFlutterPlatform extends PlatformInterface {
     throw UnimplementedError('onClusterTap() has not been implemented.');
   }
 
+  /// A [GroundOverlay] has been tapped.
+  Stream<GroundOverlayTapEvent> onGroundOverlayTap({required int mapId}) {
+    throw UnimplementedError('onGroundOverlayTap() has not been implemented.');
+  }
+
   /// Dispose of whatever resources the `mapId` is holding on to.
   void dispose({required int mapId}) {
     throw UnimplementedError('dispose() has not been implemented.');

packages/google_maps_flutter/google_maps_flutter_platform_interface/lib/src/platform_interface/google_maps_inspector_platform.dart

@@ -117,11 +117,7 @@ abstract class GoogleMapsInspectorPlatform extends PlatformInterface {
   }
 
   /// If the platform supports getting information about heatmaps.
-  bool supportsGettingHeatmapInfo() {
-    throw UnimplementedError(
-      'supportsGettingHeatmapInfo() has not been implemented.',
-    );
-  }
+  bool supportsGettingHeatmapInfo() => false;
 
   /// Returns information about the heatmap with the given ID.
   ///
@@ -132,6 +128,20 @@ abstract class GoogleMapsInspectorPlatform extends PlatformInterface {
     throw UnimplementedError('getHeatmapInfo() has not been implemented.');
   }
 
+  /// If the platform supports getting information about ground overlays.
+  bool supportsGettingGroundOverlayInfo() => false;
+
+  /// Returns information about the ground overlay with the given ID.
+  ///
+  /// The returned object will be synthesized from platform data, so will not
+  /// be the same Dart object as the original [GroundOverlay] provided to the
+  /// platform interface with that ID, and not all fields will be populated.
+  Future<GroundOverlay?> getGroundOverlayInfo(GroundOverlayId groundOverlayId,
+      {required int mapId}) {
+    throw UnimplementedError(
+        'getGroundOverlayInfo() has not been implemented.');
+  }
+
   /// Returns current clusters from [ClusterManager].
   Future<List<Cluster>> getClusters(
       {required int mapId, required ClusterManagerId clusterManagerId}) {