Merge branch 'mapbox:main' into main

Author: tranhuongk

CHANGELOG.md

@@ -1,6 +1,8 @@
-### main
+### 2.2.0-rc.1
 
 * Expose `MapboxStyles.STANDARD_SATELLITE` style.
+* `MapDebugOptions` is superseded by `MapWidgetDebugOptions`, expanding existing debug options with the new `light`, `camera`, and `padding` debug options in addition to the new Android-specific options: `layers2DWireframe` and `layers3DWireframe`.
+* Bump Maps SDK to 11.6.0-rc.1
 
 ### 2.2.0-beta.1
 

README.md

@@ -1,6 +1,6 @@
 # Mapbox Maps SDK Flutter SDK
 
-The Mapbox Maps SDK Flutter SDK is an officially developed solution from Mapbox that enables use of our latest Maps SDK product (v11.6.0-beta.1). The SDK allows developers to embed highly customized maps using a Flutter widget on Android and iOS.
+The Mapbox Maps SDK Flutter SDK is an officially developed solution from Mapbox that enables use of our latest Maps SDK product (v11.6.0-rc.1). The SDK allows developers to embed highly-customized maps using a Flutter widget on Android and iOS.
 
 Web and desktop are not supported. 
 
@@ -54,7 +54,7 @@ The Maps Flutter SDK is compatible with applications:
 
 ### Configure credentials
 To run the Maps Flutter SDK you will need to configure the Mapbox Access Tokens. 
-Read more about access tokens and public/secret scopes at the platform [Android](https://docs.mapbox.com/android/maps/guides/install/#configure-credentials) or [iOS](https://docs.mapbox.com/ios/maps/guides/install/#configure-credentials) docs.
+Read more about access tokens and public/secret scopes in the platform [Android](https://docs.mapbox.com/android/maps/guides/install/#configure-credentials) or [iOS](https://docs.mapbox.com/ios/maps/guides/install/#step-4-configure-your-public-token) docs.
 
 #### Secret token
 To access platform SDKs you will need to create a secret access token with the `Downloads:Read` scope and then:
@@ -69,6 +69,8 @@ To access platform SDKs you will need to create a secret access token with the `
   password YOUR_SECRET_MAPBOX_ACCESS_TOKEN
 ```
 
+To learn more about configuring your secret tokens for iOS, please see step 3 of the [configure credentials section](https://docs.mapbox.com/ios/maps/guides/install/#step-3-configure-your-secret-token) of the iOS Installation Guide.
+
 #### Public token
 You can set the access token for Mapbox Maps Flutter SDK(as well as for every Mapbox SDK) via `MapboxOptions`:
 ```
@@ -129,7 +131,7 @@ Add the following permissions to the manifest:
 ```
 
 #### iOS
-Add the following to the `Runner/Info.plist` to explain why you need access to the location data:
+Add the following key/value pair to the `Runner/Info.plist`. In the value field, explain why you need access to location:
 
 ```
     <key>NSLocationWhenInUseUsageDescription</key>
@@ -148,9 +150,9 @@ void main() {
 ```
 
 #### MapWidget widget
-The `MapWidget` widget provides options to customize the map - you can set `MapOptions`, `CameraOptions`, `styleURL` etc.
+The `MapWidget` widget provides options to customize the map - you can set `MapOptions`, `CameraOptions`, `styleURL`, etc.
 
-It also allows or add listeners for various events - related to style loading, map rendering, map loading. 
+You can also add listeners for various events related to style loading, map rendering, map loading. 
 
 #### MapboxMap controller
 The `MapboxMap` controller instance is provided with `MapWidget.onMapCreated` callback.
@@ -188,16 +190,16 @@ class FullMapState extends State<FullMap> {
 ```
 
 ## User location
-Platform docs : [Android](https://docs.mapbox.com/android/maps/guides/user-location/), [iOS](https://docs.mapbox.com/ios/maps/guides/user-location/).
+To observe the user's location and show the location indicator on the map use `LocationComponentSettingsInterface` accessible via `MapboxMap.location`. 
 
-To observe the user's location and show the location indicator on the map use `LocationComponentSettingsInterface` accessible via `MapboxMap.location`.
+For more information, please see the User Location guides in our [Flutter](https://docs.mapbox.com/flutter/maps/guides/user-location), [Android](https://docs.mapbox.com/android/maps/guides/user-location/), and [iOS](https://docs.mapbox.com/ios/maps/guides/user-location/) documentation.
 
 You need to grant location permission prior to using location component (as explained [before](#configure-permissions)).
 
 ### Location puck
 To customize the appearance of the location puck call `MapboxMap.location.updateSettings` method.
 
-To use the 3D puck with model downloaded from Uri instead of the default 2D puck :
+To use the 3D puck with model downloaded from Uri instead of the default 2D puck:
 
 ```
   mapboxMap.location.updateSettings(LocationComponentSettings(
@@ -210,11 +212,11 @@ To use the 3D puck with model downloaded from Uri instead of the default 2D puck
 You can find more examples of customization in the sample [app](example/lib/location.dart).
 
 ## Markers and annotations
-Platform docs : [Android](https://docs.mapbox.com/android/maps/guides/annotations/), [iOS](https://docs.mapbox.com/ios/maps/guides/annotations/).
+Additional information is available in our [Flutter](https://docs.mapbox.com/flutter/maps/guides/markers-and-annotations/), [Android](https://docs.mapbox.com/android/maps/guides/annotations/), and [iOS](https://docs.mapbox.com/ios/maps/guides/annotations/) documentation.
 
 You have several options to add annotations on the map.
 
-1. Use the AnnotationManager APIs to create circle/point/polygon/polyline annotations. 
+1. Use the AnnotationManager APIs to create circle, point, polygon, and polyline annotations. 
 
 To create 5 point annotations using custom icon: 
 ```
@@ -235,21 +237,21 @@ You can find more examples of the AnnotationManagers usage in the sample app : [
 1. Use style layers. This will require writing more code but is more flexible and provides better performance for the large amount of annotations (e.g. hundreds and thousands of them). More about adding style layers in the [Map styles section](#map-styles).
 
 ## Map styles
-Platform docs : [Android](https://docs.mapbox.com/android/maps/guides/styles/), [iOS](https://docs.mapbox.com/ios/maps/guides/styles/).
+Additional information is available in our [Flutter](https://docs.mapbox.com/flutter/maps/guides/styles/), [Android](https://docs.mapbox.com/android/maps/guides/styles/), and [iOS](https://docs.mapbox.com/ios/maps/guides/styles/) documentation.
 
 The Mapbox Maps Flutter SDK allows full customization of the look of the map used in your application. 
 
 ### Set a style
-You can specify the initial style uri at `MapWidget.styleUri`, or load it at runtime using `MapboxMap.loadStyleURI` / `MapboxMap.loadStyleJson` : 
+You can specify the initial style uri at `MapWidget.styleUri`, or load it at runtime using `MapboxMap.loadStyleURI` / `MapboxMap.loadStyleJson`: 
 
 ```
-  mapboxMap.loadStyleURI(Styles.LIGHT);
+mapboxMap.loadStyleURI(Styles.LIGHT);
 ```
 
 ### Work with layers
-You can familiarize with the concept of sources, layers and their supported types in the platform documentation.
+You can familiarize with the concept of sources, layers and their supported types in the documentation for [Flutter](https://docs.mapbox.com/flutter/maps/guides/styles/work-with-layers), [iOS](https://docs.mapbox.com/ios/maps/guides/styles/work-with-layers/), and [Android](https://docs.mapbox.com/android/maps/guides/styles/work-with-layers/).
 
-To add, remove or change a source or a layer use the `MapboxMap.style` object. 
+To add, remove or change a source or a layer, use the `MapboxMap.style` object.
 
 To add a `GeoJsonSource` and a `LineLayer` using the source : 
 ```
@@ -267,19 +269,21 @@ To add a `GeoJsonSource` and a `LineLayer` using the source :
 
 ### Using expressions
 You can change the appearance of a layer based on properties in the layer's data source or zoom level.
-Refer to the [documentation](https://docs.mapbox.com/mapbox-gl-js/style-spec/expressions/) for the description of supported expressions.
+Refer to the [documentation](https://docs.mapbox.com/mapbox-gl-js/style-spec/expressions/) for the description of supported expressions. You can also learn more in the documentation for [Flutter](https://docs.mapbox.com/flutter/maps/guides/styles/style-layers#work-with-expressions), [iOS](https://docs.mapbox.com/ios/maps/guides/styles/style-layers/#work-with-expressions), and [Android](https://docs.mapbox.com/android/maps/guides/styles/style-layers/#work-with-expressions). 
+
 To apply an expression to interpolate gradient color to a line layer:
 ```
   mapboxMap.style.setStyleLayerProperty("layer", "line-gradient",
       '["interpolate",["linear"],["line-progress"],0.0,["rgb",6,1,255],0.5,["rgb",0,255,42],0.7,["rgb",255,252,0],1.0,["rgb",255,30,0]]');
 ```
 
 ## Camera and animations
-Platform docs : [Android](https://docs.mapbox.com/android/maps/guides/camera-and-animation/), [iOS](https://docs.mapbox.com/ios/maps/guides/camera-and-animation/). 
+Platform docs: [Android](https://docs.mapbox.com/android/maps/guides/camera-and-animation/), [iOS](https://docs.mapbox.com/ios/maps/guides/camera-and-animation/). 
+
 The camera is the user's viewpoint above the map. The Maps Flutter SDK provides you with options to set and adjust the camera position, listen for camera changes, get the camera position, and restrict the camera position to set bounds.
 
 ### Camera position
-You can set the starting camera position using `MapWidget.cameraOptions` :
+You can set the starting camera position using `MapWidget.cameraOptions`:
 
 ```
 MapWidget(
@@ -316,7 +320,7 @@ To start a `flyTo` animation to the specific camera options :
 You can find more examples of animations in the sample [app](example/lib/animation.dart).
 
 ## User interaction
-Platform docs : [Android](https://docs.mapbox.com/android/maps/guides/user-interaction/), [iOS](https://docs.mapbox.com/ios/maps/guides/user-interaction/).
+Platform docs: [Android](https://docs.mapbox.com/android/maps/guides/user-interaction/), [iOS](https://docs.mapbox.com/ios/maps/guides/user-interaction/).
 
 Users interacting with the map in your application can explore the map by performing standard gestures. 
 

android/build.gradle

@@ -78,7 +78,7 @@ if (file("$rootDir/gradle/ktlint.gradle").exists() && file("$rootDir/gradle/lint
 }
 
 dependencies {
-    implementation "com.mapbox.maps:android:11.6.0-beta.1"
+    implementation "com.mapbox.maps:android:11.6.0-rc.1"
 
     implementation "androidx.annotation:annotation:1.7.1"
     implementation "androidx.lifecycle:lifecycle-runtime-ktx:2.3.0"

android/src/main/kotlin/com/mapbox/maps/mapbox_maps/Extentions.kt

@@ -10,6 +10,7 @@ import com.mapbox.common.TileRegionError
 import com.mapbox.geojson.*
 import com.mapbox.maps.EdgeInsets
 import com.mapbox.maps.StylePackError
+import com.mapbox.maps.debugoptions.MapViewDebugOptions
 import com.mapbox.maps.extension.style.expressions.dsl.generated.min
 import com.mapbox.maps.extension.style.layers.properties.generated.ProjectionName
 import com.mapbox.maps.extension.style.light.LightPosition
@@ -26,6 +27,25 @@ import java.io.ByteArrayOutputStream
 
 // FLT to Android
 
+fun _MapWidgetDebugOptions.toMapViewDebugOptions(): MapViewDebugOptions {
+  return when (this) {
+    _MapWidgetDebugOptions.TILE_BORDERS -> MapViewDebugOptions.TILE_BORDERS
+    _MapWidgetDebugOptions.PARSE_STATUS -> MapViewDebugOptions.PARSE_STATUS
+    _MapWidgetDebugOptions.TIMESTAMPS -> MapViewDebugOptions.TIMESTAMPS
+    _MapWidgetDebugOptions.COLLISION -> MapViewDebugOptions.COLLISION
+    _MapWidgetDebugOptions.OVERDRAW -> MapViewDebugOptions.OVERDRAW
+    _MapWidgetDebugOptions.STENCIL_CLIP -> MapViewDebugOptions.STENCIL_CLIP
+    _MapWidgetDebugOptions.DEPTH_BUFFER -> MapViewDebugOptions.DEPTH_BUFFER
+    _MapWidgetDebugOptions.MODEL_BOUNDS -> MapViewDebugOptions.MODEL_BOUNDS
+    _MapWidgetDebugOptions.TERRAIN_WIREFRAME -> MapViewDebugOptions.TERRAIN_WIREFRAME
+    _MapWidgetDebugOptions.LAYERS2DWIREFRAME -> MapViewDebugOptions.LAYERS2_DWIREFRAME
+    _MapWidgetDebugOptions.LAYERS3DWIREFRAME -> MapViewDebugOptions.LAYERS3_DWIREFRAME
+    _MapWidgetDebugOptions.LIGHT -> MapViewDebugOptions.LIGHT
+    _MapWidgetDebugOptions.CAMERA -> MapViewDebugOptions.CAMERA
+    _MapWidgetDebugOptions.PADDING -> MapViewDebugOptions.PADDING
+  }
+}
+
 fun GlyphsRasterizationMode.toGlyphsRasterizationMode(): com.mapbox.maps.GlyphsRasterizationMode {
   return when (this) {
     GlyphsRasterizationMode.NO_GLYPHS_RASTERIZED_LOCALLY -> com.mapbox.maps.GlyphsRasterizationMode.NO_GLYPHS_RASTERIZED_LOCALLY
@@ -376,6 +396,26 @@ fun Number.toDevicePixels(context: Context): Float {
 
 // Android to FLT
 
+fun MapViewDebugOptions.toFLTDebugOptions(): _MapWidgetDebugOptions? {
+  return when (this) {
+    MapViewDebugOptions.TILE_BORDERS -> _MapWidgetDebugOptions.TILE_BORDERS
+    MapViewDebugOptions.PARSE_STATUS -> _MapWidgetDebugOptions.PARSE_STATUS
+    MapViewDebugOptions.TIMESTAMPS -> _MapWidgetDebugOptions.TIMESTAMPS
+    MapViewDebugOptions.COLLISION -> _MapWidgetDebugOptions.COLLISION
+    MapViewDebugOptions.OVERDRAW -> _MapWidgetDebugOptions.OVERDRAW
+    MapViewDebugOptions.STENCIL_CLIP -> _MapWidgetDebugOptions.STENCIL_CLIP
+    MapViewDebugOptions.DEPTH_BUFFER -> _MapWidgetDebugOptions.DEPTH_BUFFER
+    MapViewDebugOptions.MODEL_BOUNDS -> _MapWidgetDebugOptions.MODEL_BOUNDS
+    MapViewDebugOptions.TERRAIN_WIREFRAME -> _MapWidgetDebugOptions.TERRAIN_WIREFRAME
+    MapViewDebugOptions.LAYERS2_DWIREFRAME -> _MapWidgetDebugOptions.LAYERS2DWIREFRAME
+    MapViewDebugOptions.LAYERS3_DWIREFRAME -> _MapWidgetDebugOptions.LAYERS3DWIREFRAME
+    MapViewDebugOptions.LIGHT -> _MapWidgetDebugOptions.LIGHT
+    MapViewDebugOptions.CAMERA -> _MapWidgetDebugOptions.CAMERA
+    MapViewDebugOptions.PADDING -> _MapWidgetDebugOptions.PADDING
+    else -> null
+  }
+}
+
 fun com.mapbox.maps.CanonicalTileID.toFLTCanonicalTileID(): CanonicalTileID {
   return CanonicalTileID(z = z.toLong(), x = x.toLong(), y = y.toLong())
 }
@@ -571,12 +611,12 @@ fun com.mapbox.maps.StylePackLoadProgress.toFLTStylePackLoadProgress(): StylePac
   )
 }
 
-fun TilesetDescriptorOptions.toTilesetDescriptorOptions(): com.mapbox.maps.TilesetDescriptorOptions {
+fun TilesetDescriptorOptions.toTilesetDescriptorOptions(context: Context): com.mapbox.maps.TilesetDescriptorOptions {
   val builder = com.mapbox.maps.TilesetDescriptorOptions.Builder()
     .styleURI(styleURI)
     .minZoom(minZoom.toByte())
     .maxZoom(maxZoom.toByte())
-  pixelRatio?.let { builder.pixelRatio(it.toFloat()) }
+    .pixelRatio(pixelRatio?.toFloat() ?: context.resources.displayMetrics.density)
   tilesets?.let { builder.tilesets(it) }
   stylePackOptions?.let { builder.stylePackOptions(it.toStylePackLoadOptions()) }
   extraOptions?.let { builder.extraOptions(it.toValue()) }

android/src/main/kotlin/com/mapbox/maps/mapbox_maps/MapInterfaceController.kt

@@ -4,6 +4,7 @@ import android.content.Context
 import com.google.gson.Gson
 import com.mapbox.geojson.Feature
 import com.mapbox.geojson.Point
+import com.mapbox.maps.MapView
 import com.mapbox.maps.MapboxMap
 import com.mapbox.maps.TileCacheBudget
 import com.mapbox.maps.extension.observable.eventdata.MapLoadingErrorEventData
@@ -24,9 +25,14 @@ import com.mapbox.maps.mapbox_maps.pigeons.TileCacheBudgetInTiles
 import com.mapbox.maps.mapbox_maps.pigeons.TileCoverOptions
 import com.mapbox.maps.mapbox_maps.pigeons.ViewportMode
 import com.mapbox.maps.mapbox_maps.pigeons._MapInterface
+import com.mapbox.maps.mapbox_maps.pigeons._MapWidgetDebugOptionsBox
 import com.mapbox.maps.plugin.delegates.listeners.OnMapLoadErrorListener
 
-class MapInterfaceController(private val mapboxMap: MapboxMap, private val context: Context) : _MapInterface {
+class MapInterfaceController(
+  private val mapboxMap: MapboxMap,
+  private val mapView: MapView,
+  private val context: Context
+) : _MapInterface {
   override fun loadStyleURI(styleURI: String, callback: (Result<Unit>) -> Unit) {
     mapboxMap.loadStyleUri(
       styleURI,
@@ -111,6 +117,16 @@ class MapInterfaceController(private val mapboxMap: MapboxMap, private val conte
     return mapboxMap.getMapOptions().toFLTMapOptions(context)
   }
 
+  override fun getDebugOptions(): List<_MapWidgetDebugOptionsBox?> {
+    return mapView.debugOptions.mapNotNull { nativeOption ->
+      nativeOption.toFLTDebugOptions()?.let { _MapWidgetDebugOptionsBox(it) }
+    }
+  }
+
+  override fun setDebugOptions(debugOptions: List<_MapWidgetDebugOptionsBox>) {
+    mapView.debugOptions = debugOptions.map { it.option.toMapViewDebugOptions() }.toSet()
+  }
+
   override fun getDebug(): List<MapDebugOptions> {
     return mapboxMap.getDebug().map { it.toFLTMapDebugOptions() }.toMutableList()
   }

android/src/main/kotlin/com/mapbox/maps/mapbox_maps/MapboxMapController.kt

@@ -131,7 +131,7 @@ class MapboxMapController(
     styleController = StyleController(context, mapboxMap)
     cameraController = CameraController(mapboxMap, context)
     projectionController = MapProjectionController(mapboxMap)
-    mapInterfaceController = MapInterfaceController(mapboxMap, context)
+    mapInterfaceController = MapInterfaceController(mapboxMap, mapView, context)
     animationController = AnimationController(mapboxMap, context)
     annotationController = AnnotationController(mapView)
     locationComponentController = LocationComponentController(mapView, context)

android/src/main/kotlin/com/mapbox/maps/mapbox_maps/offline/OfflineMapInstanceManager.kt

@@ -2,6 +2,7 @@ package com.mapbox.maps.mapbox_maps.offline
 
 import android.content.Context
 import com.mapbox.common.TileStore
+import com.mapbox.maps.MapboxMapsOptions
 import com.mapbox.maps.mapbox_maps.ProxyBinaryMessenger
 import com.mapbox.maps.mapbox_maps.pigeons.*
 import io.flutter.plugin.common.BinaryMessenger
@@ -27,6 +28,7 @@ class OfflineMapInstanceManager(
   override fun setupTileStore(channelSuffix: String, filePath: String?) {
     val proxy = ProxyBinaryMessenger(messenger, channelSuffix)
     val tileStore = filePath?.let { TileStore.create(it) } ?: TileStore.create()
+    MapboxMapsOptions.tileStore = tileStore
     val tileStoreController = TileStoreController(context, messenger, tileStore)
     _TileStore.setUp(proxy, tileStoreController)
     proxies["tilestore/$channelSuffix"] = proxy
@@ -35,5 +37,6 @@ class OfflineMapInstanceManager(
   override fun tearDownTileStore(channelSuffix: String) {
     val proxy = proxies["tilestore/$channelSuffix"] ?: return
     _TileStore.setUp(proxy, null)
+    MapboxMapsOptions.tileStore = null
   }
 }