Support strong typed geometry (#528)

* strong typed Turf geometry support for annotations API

Author: maios

CHANGELOG.md

@@ -44,7 +44,7 @@ snapshotter.setCamera(CameraOptions(center: Point(...)));
 
 final snapshotImage = await snapshotter.start()
 ```
-##### Map wiget snapshotting
+##### Map widget snapshotting
 
 Create snapshots of the map displayed in the `MapWidget` with `MapboxMap.snapshot()`. This new feature allows you to capture a static image of the current map view.
 
@@ -60,6 +60,10 @@ Please note that the `snapshot()` method works best if the Mapbox Map is fully l
 
 #### ⚠️ Breaking changes
 
+##### Leveraging [Turf](https://pub.dev/packages/turf)'s geometries as a replacement for Map<String, Any?>
+
+You now have the convenience of directly initializing annotations with Turf's geometries, eliminating the need for converting geometry to JSON.
+
 ##### Geographical position represented by `Point`s
 
 Geographical positions denoted by `Map<String?, Object?>?` are migrated to [`Point`](https://pub.dev/documentation/turf/latest/turf/Point-class.html) type from [turf](https://pub.dev/packages/turf) package.
@@ -102,7 +106,56 @@ onTapListener: { (context)
     ...
 }
 ```
+##### Creating an annotation with a given geometry
+*Before:*
+```dart
+PointAnnotationOptions(
+  geometry: Point(
+    coordinates: Position(0.381457, 6.687337)
+  ).toJson()
+)
+PolygonAnnotationOptions(
+  geometry: Polygon(coordinates: [
+    [
+      Position(-3.363937, -10.733102),
+      Position(1.754703, -19.716317),
+      Position(-15.747196, -21.085074),
+      Position(-3.363937, -10.733102)
+    ]
+  ]).toJson()
+)
+PolylineAnnotationOptions(
+  geometry: LineString(coordinates: [
+    Position(1.0, 2.0), 
+    Position(10.0, 20.0)
+  ]).toJson()
+)
+```
 
+*After:*
+```dart
+PointAnnotationOptions(
+  geometry: Point(
+    coordinates: Position(0.381457, 6.687337)
+  )
+)
+PolygonAnnotationOptions(
+  geometry: Polygon(coordinates: [
+    [
+      Position(-3.363937, -10.733102),
+      Position(1.754703, -19.716317),
+      Position(-15.747196, -21.085074),
+      Position(-3.363937, -10.733102)
+    ]
+  ])
+)
+PolylineAnnotationOptions(
+  geometry: LineString(coordinates: [
+    Position(1.0, 2.0), 
+    Position(10.0, 20.0)
+  ])
+)
+```
 
 * Fix camera center not applied from map init options.
 * [iOS] Free up resources upon map widget disposal. This should help to reduce the amount of used memory when previously shown map widget is removed from the widget tree.

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

@@ -284,36 +284,6 @@ fun Map<String?, Any?>.toPoint(): Point {
   return Point.fromLngLat(longitude, latitude, boundingBox)
 }
 
-fun Map<String?, Any?>.toPoints(): List<Point> {
-  return (this["coordinates"] as List<List<Double>>).map {
-    Point.fromLngLat(it.first(), it.last())
-  }
-}
-
-fun Map<String?, Any?>.toPointsList(): List<List<Point>> {
-  return (this["coordinates"] as List<List<List<Double>>>).map {
-    it.map {
-      Point.fromLngLat(it.first(), it.last())
-    }
-  }
-}
-
-fun Map<String?, Any?>.toLineString(): LineString {
-  return LineString.fromLngLats(
-    (this["coordinates"] as List<List<Double>>).map {
-      Point.fromLngLat(it.first(), it.last())
-    }
-  )
-}
-
-fun Map<String?, Any?>.toPolygon(): Polygon {
-  return Polygon.fromLngLats(
-    (this["coordinates"] as List<List<List<Double>>>).map {
-      it.map { Point.fromLngLat(it.first(), it.last()) }
-    }
-  )
-}
-
 fun CoordinateBounds.toCoordinateBounds() =
   com.mapbox.maps.CoordinateBounds(southwest, northeast, infiniteBounds)
 
@@ -489,33 +459,6 @@ fun com.mapbox.maps.Size.toFLTSize(context: Context): Size {
   return Size(width.toLogicalPixels(context), height.toLogicalPixels(context))
 }
 
-fun Point.toMap(): Map<String?, Any> {
-  val map = mutableMapOf<String?, Any>()
-  map["coordinates"] = coordinates()
-  bbox()?.let {
-    map["bbox"] = mapOf(Pair("southwest", it.southwest()), Pair("northeast", it.northeast()))
-  }
-  return map
-}
-
-fun Polygon.toMap(): Map<String?, Any> {
-  val map = mutableMapOf<String?, Any>()
-  map["coordinates"] = coordinates().map { it.map { it.coordinates() } }
-  bbox()?.let {
-    map["bbox"] = mapOf(Pair("southwest", it.southwest()), Pair("northeast", it.northeast()))
-  }
-  return map
-}
-
-fun LineString.toMap(): Map<String?, Any> {
-  val map = mutableMapOf<String?, Any>()
-  map["coordinates"] = coordinates().map { it.coordinates() }
-  bbox()?.let {
-    map["bbox"] = mapOf(Pair("southwest", it.southwest()), Pair("northeast", it.northeast()))
-  }
-  return map
-}
-
 fun com.mapbox.maps.ScreenCoordinate.toFLTScreenCoordinate(context: Context): ScreenCoordinate {
   return ScreenCoordinate(x.toLogicalPixels(context), y.toLogicalPixels(context))
 }

android/src/main/kotlin/com/mapbox/maps/mapbox_maps/annotation/CircleAnnotationController.kt

@@ -2,8 +2,6 @@
 package com.mapbox.maps.mapbox_maps.annotation
 
 import com.mapbox.maps.mapbox_maps.pigeons.*
-import com.mapbox.maps.mapbox_maps.toMap
-import com.mapbox.maps.mapbox_maps.toPoint
 import com.mapbox.maps.plugin.annotation.generated.CircleAnnotationManager
 import toCirclePitchAlignment
 import toCirclePitchScale
@@ -124,7 +122,7 @@ class CircleAnnotationController(private val delegate: ControllerDelegate) : _Ci
   private fun updateAnnotation(annotation: CircleAnnotation): com.mapbox.maps.plugin.annotation.generated.CircleAnnotation {
     val originalAnnotation = annotationMap[annotation.id]!!
     annotation.geometry?.let {
-      originalAnnotation.geometry = it.toPoint()
+      originalAnnotation.geometry = it
     }
     annotation.circleSortKey?.let {
       originalAnnotation.circleSortKey = it
@@ -267,7 +265,7 @@ class CircleAnnotationController(private val delegate: ControllerDelegate) : _Ci
 fun com.mapbox.maps.plugin.annotation.generated.CircleAnnotation.toFLTCircleAnnotation(): CircleAnnotation {
   return CircleAnnotation(
     id = id,
-    geometry = geometry.toMap(),
+    geometry = geometry,
     circleSortKey = circleSortKey,
     circleBlur = circleBlur,
     // colorInt is 32 bit and may be bigger than MAX_INT, so transfer to UInt firstly and then to Long.
@@ -284,7 +282,7 @@ fun com.mapbox.maps.plugin.annotation.generated.CircleAnnotation.toFLTCircleAnno
 fun CircleAnnotationOptions.toCircleAnnotationOptions(): com.mapbox.maps.plugin.annotation.generated.CircleAnnotationOptions {
   val options = com.mapbox.maps.plugin.annotation.generated.CircleAnnotationOptions()
   this.geometry?.let {
-    options.withPoint(it.toPoint())
+    options.withPoint(it)
   }
   this.circleSortKey?.let {
     options.withCircleSortKey(it)

android/src/main/kotlin/com/mapbox/maps/mapbox_maps/annotation/PointAnnotationController.kt

@@ -4,8 +4,6 @@ package com.mapbox.maps.mapbox_maps.annotation
 import android.graphics.Bitmap
 import android.graphics.BitmapFactory
 import com.mapbox.maps.mapbox_maps.pigeons.*
-import com.mapbox.maps.mapbox_maps.toMap
-import com.mapbox.maps.mapbox_maps.toPoint
 import com.mapbox.maps.plugin.annotation.generated.PointAnnotationManager
 import toFLTIconAnchor
 import toFLTIconPitchAlignment
@@ -147,7 +145,7 @@ class PointAnnotationController(private val delegate: ControllerDelegate) : _Poi
   private fun updateAnnotation(annotation: PointAnnotation): com.mapbox.maps.plugin.annotation.generated.PointAnnotation {
     val originalAnnotation = annotationMap[annotation.id]!!
     annotation.geometry?.let {
-      originalAnnotation.geometry = it.toPoint()
+      originalAnnotation.geometry = it
     }
     annotation.image?.let {
       originalAnnotation.iconImageBitmap = (BitmapFactory.decodeByteArray(it, 0, it.size))
@@ -827,7 +825,7 @@ class PointAnnotationController(private val delegate: ControllerDelegate) : _Poi
 fun com.mapbox.maps.plugin.annotation.generated.PointAnnotation.toFLTPointAnnotation(): PointAnnotation {
   return PointAnnotation(
     id = id,
-    geometry = geometry.toMap(),
+    geometry = geometry,
     image = iconImageBitmap?.let {
       ByteArrayOutputStream().also { stream ->
         it.compress(Bitmap.CompressFormat.PNG, 100, stream)
@@ -875,7 +873,7 @@ fun com.mapbox.maps.plugin.annotation.generated.PointAnnotation.toFLTPointAnnota
 fun PointAnnotationOptions.toPointAnnotationOptions(): com.mapbox.maps.plugin.annotation.generated.PointAnnotationOptions {
   val options = com.mapbox.maps.plugin.annotation.generated.PointAnnotationOptions()
   this.geometry?.let {
-    options.withPoint(it.toPoint())
+    options.withPoint(it)
   }
   this.image?.let {
     options.withIconImage(BitmapFactory.decodeByteArray(it, 0, it.size))

android/src/main/kotlin/com/mapbox/maps/mapbox_maps/annotation/PolygonAnnotationController.kt

@@ -2,9 +2,6 @@
 package com.mapbox.maps.mapbox_maps.annotation
 
 import com.mapbox.maps.mapbox_maps.pigeons.*
-import com.mapbox.maps.mapbox_maps.toMap
-import com.mapbox.maps.mapbox_maps.toPointsList
-import com.mapbox.maps.mapbox_maps.toPolygon
 import com.mapbox.maps.plugin.annotation.generated.PolygonAnnotationManager
 import toFLTFillTranslateAnchor
 import toFillTranslateAnchor
@@ -121,7 +118,7 @@ class PolygonAnnotationController(private val delegate: ControllerDelegate) : _P
   private fun updateAnnotation(annotation: PolygonAnnotation): com.mapbox.maps.plugin.annotation.generated.PolygonAnnotation {
     val originalAnnotation = annotationMap[annotation.id]!!
     annotation.geometry?.let {
-      originalAnnotation.geometry = it.toPolygon()
+      originalAnnotation.geometry = it
     }
     annotation.fillSortKey?.let {
       originalAnnotation.fillSortKey = it
@@ -233,7 +230,7 @@ class PolygonAnnotationController(private val delegate: ControllerDelegate) : _P
 fun com.mapbox.maps.plugin.annotation.generated.PolygonAnnotation.toFLTPolygonAnnotation(): PolygonAnnotation {
   return PolygonAnnotation(
     id = id,
-    geometry = geometry.toMap(),
+    geometry = geometry,
     fillSortKey = fillSortKey,
     // colorInt is 32 bit and may be bigger than MAX_INT, so transfer to UInt firstly and then to Long.
     fillColor = fillColorInt?.toUInt()?.toLong(),
@@ -247,7 +244,7 @@ fun com.mapbox.maps.plugin.annotation.generated.PolygonAnnotation.toFLTPolygonAn
 fun PolygonAnnotationOptions.toPolygonAnnotationOptions(): com.mapbox.maps.plugin.annotation.generated.PolygonAnnotationOptions {
   val options = com.mapbox.maps.plugin.annotation.generated.PolygonAnnotationOptions()
   this.geometry?.let {
-    options.withPoints(it.toPointsList())
+    options.withGeometry(it)
   }
   this.fillSortKey?.let {
     options.withFillSortKey(it)

android/src/main/kotlin/com/mapbox/maps/mapbox_maps/annotation/PolylineAnnotationController.kt

@@ -2,9 +2,6 @@
 package com.mapbox.maps.mapbox_maps.annotation
 
 import com.mapbox.maps.mapbox_maps.pigeons.*
-import com.mapbox.maps.mapbox_maps.toLineString
-import com.mapbox.maps.mapbox_maps.toMap
-import com.mapbox.maps.mapbox_maps.toPoints
 import com.mapbox.maps.plugin.annotation.generated.PolylineAnnotationManager
 import toFLTLineCap
 import toFLTLineJoin
@@ -125,7 +122,7 @@ class PolylineAnnotationController(private val delegate: ControllerDelegate) : _
   private fun updateAnnotation(annotation: PolylineAnnotation): com.mapbox.maps.plugin.annotation.generated.PolylineAnnotation {
     val originalAnnotation = annotationMap[annotation.id]!!
     annotation.geometry?.let {
-      originalAnnotation.geometry = it.toLineString()
+      originalAnnotation.geometry = it
     }
     annotation.lineJoin?.let {
       originalAnnotation.lineJoin = it.toLineJoin()
@@ -365,7 +362,7 @@ class PolylineAnnotationController(private val delegate: ControllerDelegate) : _
 fun com.mapbox.maps.plugin.annotation.generated.PolylineAnnotation.toFLTPolylineAnnotation(): PolylineAnnotation {
   return PolylineAnnotation(
     id = id,
-    geometry = geometry.toMap(),
+    geometry = geometry,
     lineJoin = lineJoin?.toFLTLineJoin(),
     lineSortKey = lineSortKey,
     lineBlur = lineBlur,
@@ -385,7 +382,7 @@ fun com.mapbox.maps.plugin.annotation.generated.PolylineAnnotation.toFLTPolyline
 fun PolylineAnnotationOptions.toPolylineAnnotationOptions(): com.mapbox.maps.plugin.annotation.generated.PolylineAnnotationOptions {
   val options = com.mapbox.maps.plugin.annotation.generated.PolylineAnnotationOptions()
   this.geometry?.let {
-    options.withPoints(it.toPoints())
+    options.withGeometry(it)
   }
   this.lineJoin?.let {
     options.withLineJoin(it.toLineJoin())

android/src/main/kotlin/com/mapbox/maps/mapbox_maps/mapping/turf/TurfAdapters.kt

@@ -1,6 +1,6 @@
 package com.mapbox.maps.mapbox_maps.mapping.turf
 
-import com.mapbox.geojson.Point
+import com.mapbox.geojson.*
 
 fun Point.toList(): List<Any?> {
   return listOf(mapOf("coordinates" to coordinates()))
@@ -14,4 +14,38 @@ object PointDecoder {
 
     return Point.fromLngLat(coordinates[0], coordinates[1])
   }
+}
+
+fun LineString.toList(): List<Any?> {
+  return listOf(mapOf("coordinates" to coordinates().map { it.coordinates() }))
+}
+
+object LineStringDecoder {
+  @Suppress("UNCHECKED_CAST")
+  fun fromList(list: List<Any?>): LineString {
+    val rawData = list.first() as Map<String, Any>
+
+    return LineString.fromLngLats(
+      (rawData["coordinates"] as List<List<Double>>).map {
+        Point.fromLngLat(it.first(), it.last())
+      }
+    )
+  }
+}
+
+fun Polygon.toList(): List<Any?> {
+  return listOf(mapOf("coordinates" to coordinates().map { it.map { it.coordinates() } }))
+}
+
+object PolygonDecoder {
+  @Suppress("UNCHECKED_CAST")
+  fun fromList(list: List<Any?>): Polygon {
+    val rawData = list.first() as Map<String, Any>
+
+    return Polygon.fromLngLats(
+      (rawData["coordinates"] as List<List<List<Double>>>).map {
+        it.map { Point.fromLngLat(it.first(), it.last()) }
+      }
+    )
+  }
 }