[google_maps_flutter] Add a new zIndexInt param to marker and deprecate zIndex

packages/google_maps_flutter/google_maps_flutter/CHANGELOG.md

@@ -1,4 +1,8 @@
-## NEXT
+## 2.9.2
+
+* Updates the example app to use the zIndexInt param instead of the deprecated zIndex.
+
+## 2.9.1
 
 * Updates README to indicate that Andoid SDK <21 is no longer supported.
 

packages/google_maps_flutter/google_maps_flutter/example/integration_test/src/maps_inspector.dart

@@ -890,6 +890,7 @@ Marker _copyMarkerWithClusterManagerId(
     rotation: marker.rotation,
     visible: marker.visible,
     zIndex: marker.zIndex,
+    zIndexInt: marker.zIndexInt,
     onTap: marker.onTap,
     onDragStart: marker.onDragStart,
     onDrag: marker.onDrag,

packages/google_maps_flutter/google_maps_flutter/example/lib/place_marker.dart

@@ -249,10 +249,10 @@ class PlaceMarkerBodyState extends State<PlaceMarkerBody> {
 
   Future<void> _changeZIndex(MarkerId markerId) async {
     final Marker marker = markers[markerId]!;
-    final double current = marker.zIndex;
+    final int current = marker.zIndexInt;
     setState(() {
       markers[markerId] = marker.copyWith(
-        zIndexParam: current == 12.0 ? 0.0 : current + 1.0,
+        zIndexIntParam: current == 12 ? 0 : current + 1,
       );
     });
   }

packages/google_maps_flutter/google_maps_flutter/example/pubspec.yaml

@@ -33,3 +33,8 @@ flutter:
   uses-material-design: true
   assets:
     - assets/
+
+# FOR TESTING AND INITIAL REVIEW ONLY. DO NOT MERGE.
+# See https://github.com/flutter/flutter/blob/master/docs/ecosystem/contributing/README.md#changing-federated-plugins
+dependency_overrides:
+   {google_maps_flutter_android: {path: ../../../../packages/google_maps_flutter/google_maps_flutter_android}, google_maps_flutter_ios: {path: ../../../../packages/google_maps_flutter/google_maps_flutter_ios}, google_maps_flutter_platform_interface: {path: ../../../../packages/google_maps_flutter/google_maps_flutter_platform_interface}}

packages/google_maps_flutter/google_maps_flutter/pubspec.yaml

@@ -6,7 +6,7 @@ version: 2.12.1
 
 environment:
   sdk: ^3.6.0
-  flutter: ">=3.27.0"
+  flutter: '>=3.27.0'
 
 flutter:
   plugin:
@@ -41,3 +41,19 @@ topics:
 # The example deliberately includes limited-use secrets.
 false_secrets:
   - /example/web/index.html
+
+# FOR TESTING AND INITIAL REVIEW ONLY. DO NOT MERGE.
+# See https://github.com/flutter/flutter/blob/master/docs/ecosystem/contributing/README.md#changing-federated-plugins
+dependency_overrides:
+  {
+    google_maps_flutter_android:
+      {
+        path: ../../../packages/google_maps_flutter/google_maps_flutter_android,
+      },
+    google_maps_flutter_ios:
+      { path: ../../../packages/google_maps_flutter/google_maps_flutter_ios },
+    google_maps_flutter_platform_interface:
+      {
+        path: ../../../packages/google_maps_flutter/google_maps_flutter_platform_interface,
+      },
+  }

packages/google_maps_flutter/google_maps_flutter_android/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 2.16.2
+
+* Deprecates `zIndex` parameter in Marker in favor of `zIndexInt`.
+
 ## 2.16.1
 
 * Removes obsolete code related to supporting SDK <21.

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

@@ -2009,6 +2009,7 @@ Marker _copyMarkerWithClusterManagerId(
     position: marker.position,
     rotation: marker.rotation,
     visible: marker.visible,
+    // The deprecated parameter is used here to avoid losing precision.
     zIndex: marker.zIndex,
     onTap: marker.onTap,
     onDragStart: marker.onDragStart,

packages/google_maps_flutter/google_maps_flutter_android/example/pubspec.yaml

@@ -33,3 +33,8 @@ flutter:
   uses-material-design: true
   assets:
     - assets/
+
+# FOR TESTING AND INITIAL REVIEW ONLY. DO NOT MERGE.
+# See https://github.com/flutter/flutter/blob/master/docs/ecosystem/contributing/README.md#changing-federated-plugins
+dependency_overrides:
+   {google_maps_flutter_platform_interface: {path: ../../../../packages/google_maps_flutter/google_maps_flutter_platform_interface}}

packages/google_maps_flutter/google_maps_flutter_android/pubspec.yaml

@@ -6,7 +6,7 @@ version: 2.16.1
 
 environment:
   sdk: ^3.6.0
-  flutter: ">=3.27.0"
+  flutter: '>=3.27.0'
 
 flutter:
   plugin:
@@ -30,10 +30,20 @@ dev_dependencies:
   flutter_test:
     sdk: flutter
   mockito: ^5.4.4
-  pigeon: ^22.6.0
+  pigeon: ^22.7.4
   plugin_platform_interface: ^2.1.7
 
 topics:
   - google-maps
   - google-maps-flutter
   - map
+
+# FOR TESTING AND INITIAL REVIEW ONLY. DO NOT MERGE.
+# See https://github.com/flutter/flutter/blob/master/docs/ecosystem/contributing/README.md#changing-federated-plugins
+dependency_overrides:
+  {
+    google_maps_flutter_platform_interface:
+      {
+        path: ../../../packages/google_maps_flutter/google_maps_flutter_platform_interface,
+      },
+  }

packages/google_maps_flutter/google_maps_flutter_ios/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 2.15.3
+
+* Deprecates `zIndex` parameter in Marker in favor of `zIndexInt`.
+
 ## 2.15.2
 
 * Fixes regression where updating a marker hides its info window.

packages/google_maps_flutter/google_maps_flutter_ios/example/ios14/pubspec.yaml

@@ -32,3 +32,8 @@ flutter:
   uses-material-design: true
   assets:
     - assets/
+
+# FOR TESTING AND INITIAL REVIEW ONLY. DO NOT MERGE.
+# See https://github.com/flutter/flutter/blob/master/docs/ecosystem/contributing/README.md#changing-federated-plugins
+dependency_overrides:
+   {google_maps_flutter_platform_interface: {path: ../../../../../packages/google_maps_flutter/google_maps_flutter_platform_interface}}

packages/google_maps_flutter/google_maps_flutter_ios/example/ios15/pubspec.yaml

@@ -32,3 +32,8 @@ flutter:
   uses-material-design: true
   assets:
     - assets/
+
+# FOR TESTING AND INITIAL REVIEW ONLY. DO NOT MERGE.
+# See https://github.com/flutter/flutter/blob/master/docs/ecosystem/contributing/README.md#changing-federated-plugins
+dependency_overrides:
+   {google_maps_flutter_platform_interface: {path: ../../../../../packages/google_maps_flutter/google_maps_flutter_platform_interface}}

packages/google_maps_flutter/google_maps_flutter_ios/example/shared/maps_example_dart/lib/place_marker.dart

@@ -269,10 +269,10 @@ class PlaceMarkerBodyState extends State<PlaceMarkerBody> {
 
   Future<void> _changeZIndex(MarkerId markerId) async {
     final Marker marker = markers[markerId]!;
-    final double current = marker.zIndex;
+    final int current = marker.zIndexInt;
     setState(() {
       markers[markerId] = marker.copyWith(
-        zIndexParam: current == 12.0 ? 0.0 : current + 1.0,
+        zIndexIntParam: current == 12 ? 0 : current + 1,
       );
     });
   }

packages/google_maps_flutter/google_maps_flutter_ios/example/shared/maps_example_dart/pubspec.yaml

@@ -27,3 +27,8 @@ dev_dependencies:
 
 flutter:
   uses-material-design: true
+
+# FOR TESTING AND INITIAL REVIEW ONLY. DO NOT MERGE.
+# See https://github.com/flutter/flutter/blob/master/docs/ecosystem/contributing/README.md#changing-federated-plugins
+dependency_overrides:
+   {google_maps_flutter_platform_interface: {path: ../../../../../../packages/google_maps_flutter/google_maps_flutter_platform_interface}}

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

@@ -104,8 +104,8 @@ - (void)setVisible:(BOOL)visible {
   }
 }
 
-- (void)setZIndex:(int)zIndex {
-  self.marker.zIndex = zIndex;
+- (void)setZIndex:(int)zIndexInt {
+  self.marker.zIndexInt = zIndexInt;
 }
 
 - (void)updateFromPlatformMarker:(FGMPlatformMarker *)platformMarker
@@ -121,7 +121,7 @@ - (void)updateFromPlatformMarker:(FGMPlatformMarker *)platformMarker
   [self setConsumeTapEvents:platformMarker.consumeTapEvents];
   [self setPosition:FGMGetCoordinateForPigeonLatLng(platformMarker.position)];
   [self setRotation:platformMarker.rotation];
-  [self setZIndex:platformMarker.zIndex];
+  [self setZIndexInt:platformMarker.zIndexInt];
   FGMPlatformInfoWindow *infoWindow = platformMarker.infoWindow;
   [self setInfoWindowAnchor:FGMGetCGPointForPigeonPoint(infoWindow.anchor)];
   if (infoWindow.title) {

packages/google_maps_flutter/google_maps_flutter_ios/pubspec.yaml

@@ -6,7 +6,7 @@ version: 2.15.2
 
 environment:
   sdk: ^3.4.0
-  flutter: ">=3.22.0"
+  flutter: '>=3.22.0'
 
 flutter:
   plugin:
@@ -35,3 +35,13 @@ topics:
   - google-maps
   - google-maps-flutter
   - map
+
+# FOR TESTING AND INITIAL REVIEW ONLY. DO NOT MERGE.
+# See https://github.com/flutter/flutter/blob/master/docs/ecosystem/contributing/README.md#changing-federated-plugins
+dependency_overrides:
+  {
+    google_maps_flutter_platform_interface:
+      {
+        path: ../../../packages/google_maps_flutter/google_maps_flutter_platform_interface,
+      },
+  }

packages/google_maps_flutter/google_maps_flutter_platform_interface/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 2.12.0
+
+* Deprecates `zIndex` parameter in Marker in favor of `zIndexInt`.
+
 ## 2.11.1
 
 * Updates READMEs and API docs.

packages/google_maps_flutter/google_maps_flutter_platform_interface/lib/src/types/marker.dart

@@ -135,7 +135,7 @@ class Marker implements MapsObject<Marker> {
   /// * is positioned at 0, 0; [position] is `LatLng(0.0, 0.0)`
   /// * has an axis-aligned icon; [rotation] is 0.0
   /// * is visible; [visible] is true
-  /// * is placed at the base of the drawing order; [zIndex] is 0.0
+  /// * is placed at the base of the drawing order; [zIndexInt] is 0
   /// * reports [onTap] events
   /// * reports [onDragEnd] events
   const Marker({
@@ -150,13 +150,21 @@ class Marker implements MapsObject<Marker> {
     this.position = const LatLng(0.0, 0.0),
     this.rotation = 0.0,
     this.visible = true,
-    this.zIndex = 0.0,
+    @Deprecated(
+      'Use zIndexInt instead. '
+      'On some platforms zIndex is truncated to an int, which can lead to incorrect/unstable ordering.',
+    )
+    double zIndex = 0.0,
+    int zIndexInt = 0,
     this.clusterManagerId,
     this.onTap,
     this.onDrag,
     this.onDragStart,
     this.onDragEnd,
-  }) : assert(0.0 <= alpha && alpha <= 1.0);
+  })  : assert(0.0 <= alpha && alpha <= 1.0),
+        assert(zIndex == 0.0 || zIndexInt == 0,
+            'Only one of zIndex and zIndexInt can be provided'),
+        _zIndexNum = zIndexInt == 0 ? zIndex : zIndexInt;
 
   /// Uniquely identifies a [Marker].
   final MarkerId markerId;
@@ -214,12 +222,26 @@ class Marker implements MapsObject<Marker> {
   /// True if the marker is visible.
   final bool visible;
 
+  final num _zIndexNum;
+
+  /// The z-index of the marker, used to determine relative drawing order of
+  /// map overlays.
+  ///
+  /// Overlays are drawn in order of z-index, so that lower values means drawn
+  /// earlier, and thus appearing to be closer to the surface of the Earth.
+  // TODO(stuartmorgan): Make this an int when removing the deprecated double zIndex parameter.
+  @Deprecated(
+    'Use zIndexInt instead. '
+    'On some platforms zIndex is truncated to an int, which can lead to incorrect/unstable ordering.',
+  )
+  double get zIndex => _zIndexNum.toDouble();
+
   /// The z-index of the marker, used to determine relative drawing order of
   /// map overlays.
   ///
   /// Overlays are drawn in order of z-index, so that lower values means drawn
   /// earlier, and thus appearing to be closer to the surface of the Earth.
-  final double zIndex;
+  int get zIndexInt => _zIndexNum.round();
 
   /// Callbacks to receive tap events for markers placed on this map.
   final VoidCallback? onTap;
@@ -246,7 +268,12 @@ class Marker implements MapsObject<Marker> {
     LatLng? positionParam,
     double? rotationParam,
     bool? visibleParam,
+    @Deprecated(
+      'Use zIndexIntParam instead. '
+      'On some platforms zIndex is truncated to an int, which can lead to incorrect/unstable ordering.',
+    )
     double? zIndexParam,
+    int? zIndexIntParam,
     VoidCallback? onTapParam,
     ValueChanged<LatLng>? onDragStartParam,
     ValueChanged<LatLng>? onDragParam,
@@ -266,6 +293,7 @@ class Marker implements MapsObject<Marker> {
       rotation: rotationParam ?? rotation,
       visible: visibleParam ?? visible,
       zIndex: zIndexParam ?? zIndex,
+      zIndexInt: zIndexIntParam ?? zIndexInt,
       onTap: onTapParam ?? onTap,
       onDragStart: onDragStartParam ?? onDragStart,
       onDrag: onDragParam ?? onDrag,
@@ -301,6 +329,7 @@ class Marker implements MapsObject<Marker> {
     addIfPresent('rotation', rotation);
     addIfPresent('visible', visible);
     addIfPresent('zIndex', zIndex);
+    addIfPresent('zIndexInt', zIndexInt);
     addIfPresent('clusterManagerId', clusterManagerId?.value);
     return json;
   }
@@ -326,6 +355,7 @@ class Marker implements MapsObject<Marker> {
         rotation == other.rotation &&
         visible == other.visible &&
         zIndex == other.zIndex &&
+        zIndexInt == other.zIndexInt &&
         clusterManagerId == other.clusterManagerId;
   }
 
@@ -337,7 +367,7 @@ class Marker implements MapsObject<Marker> {
     return 'Marker{markerId: $markerId, alpha: $alpha, anchor: $anchor, '
         'consumeTapEvents: $consumeTapEvents, draggable: $draggable, flat: $flat, '
         'icon: $icon, infoWindow: $infoWindow, position: $position, rotation: $rotation, '
-        'visible: $visible, zIndex: $zIndex, onTap: $onTap, onDragStart: $onDragStart, '
+        'visible: $visible, zIndex: $zIndex, zIndexInt:$zIndexInt onTap: $onTap, onDragStart: $onDragStart, '
         'onDrag: $onDrag, onDragEnd: $onDragEnd, clusterManagerId: $clusterManagerId}';
   }
 }

packages/google_maps_flutter/google_maps_flutter_platform_interface/pubspec.yaml

@@ -8,7 +8,7 @@ version: 2.11.1
 
 environment:
   sdk: ^3.4.0
-  flutter: ">=3.22.0"
+  flutter: '>=3.22.0'
 
 dependencies:
   collection: ^1.15.0

packages/google_maps_flutter/google_maps_flutter_platform_interface/test/types/marker_test.dart

@@ -3,7 +3,6 @@
 // found in the LICENSE file.
 
 import 'package:flutter_test/flutter_test.dart';
-
 import 'package:google_maps_flutter_platform_interface/google_maps_flutter_platform_interface.dart';
 
 void main() {
@@ -24,6 +23,7 @@ void main() {
       expect(marker.rotation, equals(0.0));
       expect(marker.visible, equals(true));
       expect(marker.zIndex, equals(0.0));
+      expect(marker.zIndexInt, equals(0));
       expect(marker.onTap, equals(null));
       expect(marker.onDrag, equals(null));
       expect(marker.onDragStart, equals(null));
@@ -60,7 +60,7 @@ void main() {
         position: const LatLng(50, 50),
         rotation: 100,
         visible: false,
-        zIndex: 100,
+        zIndexInt: 100,
         onTap: () {},
         onDragStart: (LatLng latLng) {},
         onDrag: (LatLng latLng) {},
@@ -86,6 +86,7 @@ void main() {
         'rotation': 100.0,
         'visible': false,
         'zIndex': 100.0,
+        'zIndexInt': 100,
       });
     });
     test('clone', () {

packages/google_maps_flutter/google_maps_flutter_web/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.5.12 + 1
+
+* Deprecates `zIndex` parameter in Marker in favor of `zIndexInt`.
+
 ## 0.5.12
 
 * Adds support for ground overlay.