Finalize custom marker size functionality and tests

Author: jokerttu

packages/google_maps_flutter/google_maps_flutter/example/lib/custom_marker_icon.dart

@@ -2,13 +2,12 @@
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
-// ignore_for_file: public_member_api_docs
-
 import 'dart:typed_data';
 import 'dart:ui' as ui;
 
 import 'package:flutter/material.dart';
 
+/// Returns a generated png image in [ByteData] format with the requested size.
 Future<ByteData> createCustomMarkerIconImage({required Size size}) async {
   final ui.PictureRecorder recorder = ui.PictureRecorder();
   final Canvas canvas = Canvas(recorder);

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

@@ -960,23 +960,6 @@ void googleMapsTests() {
     expect(iwVisibleStatus, false);
   });
 
-  testWidgets('createFromAsset', (WidgetTester tester) async {
-    const double pixelRatio = 2;
-    const ImageConfiguration imageConfiguration =
-        ImageConfiguration(devicePixelRatio: pixelRatio);
-    final BitmapDescriptor mip = await BitmapDescriptor.createFromAsset(
-      imageConfiguration,
-      'red_square.png',
-    );
-    final BitmapDescriptor scaled = await BitmapDescriptor.createFromAsset(
-      imageConfiguration,
-      'red_square.png',
-      mipmaps: false,
-    );
-    expect((mip.toJson() as List<dynamic>)[3], 1.0);
-    expect((scaled.toJson() as List<dynamic>)[3], 2);
-  });
-
   testWidgets('testTakeSnapshot', (WidgetTester tester) async {
     final Completer<ExampleGoogleMapController> controllerCompleter =
         Completer<ExampleGoogleMapController>();

packages/google_maps_flutter/google_maps_flutter_android/example/lib/custom_marker_icon.dart

@@ -2,13 +2,12 @@
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
-// ignore_for_file: public_member_api_docs
-
 import 'dart:typed_data';
 import 'dart:ui' as ui;
 
 import 'package:flutter/material.dart';
 
+/// Returns a generated png image in [ByteData] format with the requested size.
 Future<ByteData> createCustomMarkerIconImage({required Size size}) async {
   final ui.PictureRecorder recorder = ui.PictureRecorder();
   final Canvas canvas = Canvas(recorder);

packages/google_maps_flutter/google_maps_flutter_ios/example/ios11/integration_test/google_maps_test.dart

@@ -805,23 +805,6 @@ void main() {
     expect(iwVisibleStatus, false);
   });
 
-  testWidgets('createFromAsset', (WidgetTester tester) async {
-    const double pixelRatio = 2;
-    const ImageConfiguration imageConfiguration =
-        ImageConfiguration(devicePixelRatio: pixelRatio);
-    final BitmapDescriptor mip = await BitmapDescriptor.createFromAsset(
-      imageConfiguration,
-      'red_square.png',
-    );
-    final BitmapDescriptor scaled = await BitmapDescriptor.createFromAsset(
-      imageConfiguration,
-      'red_square.png',
-      mipmaps: false,
-    );
-    expect((mip.toJson() as List<dynamic>)[3], 1.0);
-    expect((scaled.toJson() as List<dynamic>)[3], 2);
-  });
-
   testWidgets('testTakeSnapshot', (WidgetTester tester) async {
     final Completer<ExampleGoogleMapController> controllerCompleter =
         Completer<ExampleGoogleMapController>();

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

@@ -2,13 +2,12 @@
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
-// ignore_for_file: public_member_api_docs
-
 import 'dart:typed_data';
 import 'dart:ui' as ui;
 
 import 'package:flutter/material.dart';
 
+/// Returns a generated png image in [ByteData] format with the requested size.
 Future<ByteData> createCustomMarkerIconImage({required Size size}) async {
   final ui.PictureRecorder recorder = ui.PictureRecorder();
   final Canvas canvas = Canvas(recorder);

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

@@ -198,7 +198,7 @@ - (UIImage *)extractIconFromData:(NSArray *)iconData
         image = [self scaleImage:image scale:screenScale];
         // Create resized image.
         CGSize size = [FLTGoogleMapJSONConversions sizeFromArray:iconData[4] scale:screenScale];
-        image = [self scaleImage:image size:size];
+        image = [self scaleImage:image toSize:size];
       }
     }
 
@@ -223,7 +223,7 @@ - (UIImage *)extractIconFromData:(NSArray *)iconData
           image = [UIImage imageWithData:[byteData data] scale:screenScale];
           // Create resized image.
           CGSize size = [FLTGoogleMapJSONConversions sizeFromArray:iconData[4] scale:screenScale];
-          image = [self scaleImage:image size:size];
+          image = [self scaleImage:image toSize:size];
         }
       } else {
         // No scaling, load image from bytes without scale parameter.
@@ -263,7 +263,16 @@ - (UIImage *)scaleImage:(UIImage *)image scale:(CGFloat)scale {
   return image;
 }
 
-- (UIImage *)scaleImage:(UIImage *)image size:(CGSize)size {
+/**
+ Scales an input UIImage to a specified size. If the aspect ratio of the input image
+ is similar to the target size, the image's scale property is updated rather than resizing the
+ image. If the aspect ratios significantly differ, the method redraws the image at the target size.
+
+ @param image The UIImage to scale.
+ @param size The target CGSize to scale the image to.
+ @return UIImage Returns the scaled UIImage.
+ */
+- (UIImage *)scaleImage:(UIImage *)image toSize:(CGSize)size {
   if (fabs(((int)image.size.width * image.scale) - size.width) > 0 ||
       fabs(((int)image.size.height * image.scale) - size.height) > 0) {
     if (fabs(image.size.width / image.size.height - size.width / size.height) < 1e-2) {

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

@@ -15,14 +15,14 @@ import 'package:flutter/widgets.dart'
         Size,
         WidgetsBinding;
 
-/// Type of bitmap scaling options to use on BitmapDescriptor creation.
+/// Type of bitmap scaling to use on BitmapDescriptor creation.
 enum BitmapScaling {
   /// Automatically scale image with devices pixel ratio or to given size,
   /// to keep marker sizes same between platforms and devices.
   auto,
 
   /// Render marker to the map as without scaling, this can be used if the image
-  /// is already pre-scaled, or to increase performance with large marker amounts.
+  /// is already pre-scaled, or to increase performance with a large numbers of markers.
   noScaling,
 }
 
@@ -237,6 +237,10 @@ class BitmapDescriptor {
   /// Set `mipmaps` to false to load the exact dpi version of the image, `mipmap` is true by default.
   /// If `mipmaps` is set to false, optional `imagePixelRatio` can be given to
   /// override `devicePixelRatio` value from `ImageConfiguration`.
+  ///
+  /// Note: Image scaling with [ImageConfiguration.size] parameter does not maintain the aspect ratio.
+  /// If a proportional resize is required, ensure to provide a [ImageConfiguration.size] with the
+  /// correct aspect ratio.
   static Future<BitmapDescriptor> createFromAsset(
     ImageConfiguration configuration,
     String assetName, {
@@ -246,6 +250,9 @@ class BitmapDescriptor {
     double? imagePixelRatio,
     BitmapScaling bitmapScaling = BitmapScaling.auto,
   }) async {
+    assert(!mipmaps || imagePixelRatio == null,
+        'If `mipmaps` is true, then `imagePixelRatio` must be null.');
+
     final double devicePixelRatio =
         WidgetsBinding.instance.platformDispatcher.views.first.devicePixelRatio;
     final double? targetImagePixelRatio =
@@ -256,7 +263,7 @@ class BitmapDescriptor {
       return BitmapDescriptor._(<Object>[
         _asset,
         assetName,
-        _getBitMapScalingString(bitmapScaling),
+        _getBitmapScalingString(bitmapScaling),
         targetImagePixelRatio ?? devicePixelRatio,
         if (size != null)
           <Object>[
@@ -274,7 +281,7 @@ class BitmapDescriptor {
     return BitmapDescriptor._(<Object>[
       _asset,
       assetBundleImageKey.name,
-      _getBitMapScalingString(bitmapScaling),
+      _getBitmapScalingString(bitmapScaling),
       assetBundleImageKey.scale,
       if (size != null)
         <Object>[
@@ -286,19 +293,24 @@ class BitmapDescriptor {
 
   /// Creates a BitmapDescriptor using an array of bytes that must be encoded
   /// as PNG.
+  ///
   /// The optional [size] parameter represents the *logical size* of the
   /// bitmap, regardless of the actual resolution of the encoded PNG.
   /// This helps the platform to render High-DPI images at the correct size.
-  /// [ImagePixelRatio] value can be use to scale the image to
+  /// [imagePixelRatio] value can be use to scale the image to
   /// proper size across platforms.
+  ///
+  /// Note: Image scaling with [size] parameter does not maintain the aspect ratio.
+  /// If a proportional resize is required, ensure to provide a [size] with the
+  /// correct aspect ratio.
   static BitmapDescriptor createFromBytes(
     Uint8List byteData, {
     BitmapScaling bitmapScaling = BitmapScaling.auto,
     double? imagePixelRatio,
     Size? size,
   }) {
     assert(byteData.isNotEmpty,
-        'Cannot create BitmapDescriptor with empty byteData');
+        'Cannot create BitmapDescriptor with empty byteData.');
     assert(bitmapScaling != BitmapScaling.noScaling || imagePixelRatio == null,
         'If bitmapScaling is set to BitmapScaling.noScaling, scale parameter cannot be used.');
     assert(bitmapScaling != BitmapScaling.noScaling || size == null,
@@ -307,7 +319,7 @@ class BitmapDescriptor {
     return BitmapDescriptor._(<Object>[
       _bytes,
       byteData,
-      _getBitMapScalingString(bitmapScaling),
+      _getBitmapScalingString(bitmapScaling),
       imagePixelRatio ?? 1.0,
       if (size != null)
         <Object>[
@@ -317,7 +329,7 @@ class BitmapDescriptor {
     ]);
   }
 
-  static String _getBitMapScalingString(BitmapScaling bitmapScaling) {
+  static String _getBitmapScalingString(BitmapScaling bitmapScaling) {
     switch (bitmapScaling) {
       case BitmapScaling.auto:
         return bitmapAutoScaling;

packages/google_maps_flutter/google_maps_flutter_web/README.md

@@ -75,9 +75,9 @@ Only Android supports "[Lite Mode](https://developers.google.com/maps/documentat
 
 Google Maps for web uses `HtmlElementView` to render maps. When a `GoogleMap` is stacked below other widgets, [`package:pointer_interceptor`](https://www.pub.dev/packages/pointer_interceptor) must be used to capture mouse events on the Flutter overlays. See issue [#73830](https://github.com/flutter/flutter/issues/73830).
 
-## Custom marker icons
+### Custom marker icons
 
-In order to achieve the best possible performance when using custom marker images on the web platform, the `size` parameter should be used to scale the marker when using `BitmapDescriptor.createFromAsset` or `BitmapDescriptor.createFromBytes` methods.
+Images are not automatically scaled according to the imageAspectRatio value of the BitmapDescriptor in web, so the `size` parameter must be used to scale the marker when using the `BitmapDescriptor.createFromAsset` or `BitmapDescriptor.createFromBytes` methods.
 
 <?code-excerpt "readme_excerpts.dart (CreateFromAsset)"?>
 ```dart

packages/google_maps_flutter/google_maps_flutter_web/example/lib/main.dart

@@ -20,8 +20,6 @@ class MyApp extends StatefulWidget {
 class _MyAppState extends State<MyApp> {
   @override
   Widget build(BuildContext context) {
-    return const Directionality(
-        textDirection: TextDirection.ltr,
-        child: Text('Testing... Look at the console output for results!'));
+    return const Text('Testing... Look at the console output for results!');
   }
 }

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

@@ -277,41 +277,16 @@ Future<gmaps.Icon?> _gmIconFromBitmapDescriptor(
     }
   } else if (iconConfig[0] == 'asset') {
     assert(iconConfig.length >= 3);
-    // iconConfig[2] contains the DPIs of the screen, but that information is
-    // already encoded in the iconConfig[1]
-
     final String assetUrl =
         ui.webOnlyAssetManager.getAssetUrl(iconConfig[1]! as String);
     icon = gmaps.Icon()..url = assetUrl;
 
     switch (iconConfig[2]! as String) {
       case BitmapDescriptor.bitmapAutoScaling:
-        if (iconConfig.length == 4) {
-          final double scale = iconConfig[3]! as double;
-          // Google Maps Web SDK does not support the scaling of the marker with anything other than
-          // the size parameter, therefore the width and height of the image must be read from the image.
-          // To avoid this, it is best to provide the image size instead of scale when using the web platform.
-
-          final ByteData bytedata =
-              await ui.webOnlyAssetManager.load(iconConfig[1]! as String);
-          final Uint8List bytes = bytedata.buffer.asUint8List();
-          final img.Decoder? decoder = img.findDecoderForData(bytes);
-          final img.DecodeInfo? decodeInfo = decoder?.startDecode(bytes);
-
-          if (decodeInfo != null) {
-            final gmaps.Size size = gmaps.Size(
-              decodeInfo.width / scale,
-              decodeInfo.height / scale,
-            );
-            icon.size = size;
-            icon.scaledSize = size;
-          }
-        } else if (iconConfig.length == 5) {
-          final gmaps.Size? size = _gmSizeFromIconConfig(iconConfig, 4);
-          if (size != null) {
-            icon.size = size;
-            icon.scaledSize = size;
-          }
+        final gmaps.Size? size = _gmSizeFromIconConfig(iconConfig, 4);
+        if (size != null) {
+          icon.size = size;
+          icon.scaledSize = size;
         }
         break;
       case BitmapDescriptor.bitmapNoScaling:
@@ -325,29 +300,10 @@ Future<gmaps.Icon?> _gmIconFromBitmapDescriptor(
     icon = gmaps.Icon()..url = Url.createObjectUrlFromBlob(blob);
     switch (iconConfig[2]! as String) {
       case BitmapDescriptor.bitmapAutoScaling:
-        if (iconConfig.length == 4) {
-          final double scale = iconConfig[3]! as double;
-          // Google Maps Web SDK does not support the scaling of the marker with anything other than
-          // the size parameter, therefore the width and height of the image must be read from the image.
-          // To avoid this, it is best to provide the image size instead of scale when using the web platform.
-          final img.Decoder? decoder =
-              img.findDecoderForData(bytes as Uint8List);
-          final img.DecodeInfo? decodeInfo = decoder?.startDecode(bytes);
-
-          if (decodeInfo != null) {
-            final gmaps.Size size = gmaps.Size(
-              decodeInfo.width / scale,
-              decodeInfo.height / scale,
-            );
-            icon.size = size;
-            icon.scaledSize = size;
-          }
-        } else if (iconConfig.length == 5) {
-          final gmaps.Size? size = _gmSizeFromIconConfig(iconConfig, 4);
-          if (size != null) {
-            icon.size = size;
-            icon.scaledSize = size;
-          }
+        final gmaps.Size? size = _gmSizeFromIconConfig(iconConfig, 4);
+        if (size != null) {
+          icon.size = size;
+          icon.scaledSize = size;
         }
         break;
       case BitmapDescriptor.bitmapNoScaling: