Add possiblity to change the marker icon depending on the location accurency

Author: Xennis

CHANGELOG.md

@@ -1,3 +1,8 @@
+## Dev
+
+* Add possiblity to change marker icon depending on the location accuracy.
+* BREAKING CHANGE: All options return the type `LatLngData` instead of `LatLng`.
+
 ## 0.6.0
 
 * Update flutter_compass to allow usage of geomagnetic rotation sensor as fallback on Android.

README.md

@@ -13,7 +13,7 @@ A [flutter_map](https://pub.dev/packages/flutter_map) plugin to request and disp
 Status
 
 * [x] The location button can be changed dependening on the location services status. For example also Google Maps shows a different icon if the location service is off.
-* [ ] The marker icon can be changed depending on the location accuracy.
+* [x] The marker icon can be changed depending on the location accuracy.
 * [x] It's possible to show the information (e.g. in form of a snackbar) to the user that the user location is outside of the map bounds.
 * [x] The location heading is also shown for devices without an gyroscope. We [patched flutter_compass](https://github.com/hemanthrajv/flutter_compass/pull/38) for that.
 

example/lib/pages/custom.dart

@@ -1,6 +1,5 @@
 import 'package:flutter/material.dart';
 import 'package:flutter_map/flutter_map.dart';
-import 'package:latlong/latlong.dart';
 import 'package:flutter_map_location/flutter_map_location.dart';
 
 import '../widgets/drawer.dart';
@@ -40,14 +39,14 @@ class _CustomPageState extends State<CustomPage> {
               MarkerLayerOptions(markers: userLocationMarkers),
               LocationOptions(
                 markers: userLocationMarkers,
-                onLocationUpdate: (LatLng loc) {
-                  print('Location updated: $loc');
+                onLocationUpdate: (LatLngData ld) {
+                  print('Location updated: ${ld?.location}');
                 },
-                onLocationRequested: (LatLng loc) {
-                  if (loc == null) {
+                onLocationRequested: (LatLngData ld) {
+                  if (ld == null || ld.location == null) {
                     return;
                   }
-                  mapController?.move(loc, 16.0);
+                  mapController?.move(ld.location, 16.0);
                 },
                 buttonBuilder: (BuildContext context,
                     ValueNotifier<LocationServiceStatus> status,
@@ -66,10 +65,10 @@ class _CustomPageState extends State<CustomPage> {
                     ),
                   );
                 },
-                markerBuilder: (BuildContext context, LatLng point,
+                markerBuilder: (BuildContext context, LatLngData ld,
                     ValueNotifier<double> heading) {
                   return Marker(
-                    point: point,
+                    point: ld.location,
                     builder: (_) => Container(
                       child: Column(
                         children: <Widget>[

example/lib/pages/default.dart

@@ -1,6 +1,5 @@
 import 'package:flutter/material.dart';
 import 'package:flutter_map/flutter_map.dart';
-import 'package:latlong/latlong.dart';
 import 'package:flutter_map_location/flutter_map_location.dart';
 
 import '../widgets/drawer.dart';
@@ -44,14 +43,14 @@ class _DefaultPageState extends State<DefaultPage> {
               // USAGE NOTE 4: Add the options for the plugin
               LocationOptions(
                 markers: userLocationMarkers,
-                onLocationUpdate: (LatLng loc) {
-                  print('Location updated: $loc');
+                onLocationUpdate: (LatLngData ld) {
+                  print('Location updated: ${ld?.location}');
                 },
-                onLocationRequested: (LatLng loc) {
-                  if (loc == null) {
+                onLocationRequested: (LatLngData ld) {
+                  if (ld == null || ld.location == null) {
                     return;
                   }
-                  mapController?.move(loc, 16.0);
+                  mapController?.move(ld.location, 16.0);
                 },
                 buttonBuilder: (BuildContext context,
                     ValueNotifier<LocationServiceStatus> status,

lib/flutter_map_location.dart

@@ -4,3 +4,4 @@ export 'src/location_layer.dart';
 export 'src/location_marker.dart';
 export 'src/location_options.dart';
 export 'src/location_plugin.dart';
+export 'src/types.dart';

lib/src/location_layer.dart

@@ -4,16 +4,17 @@ import 'package:flutter/material.dart';
 import 'package:flutter/widgets.dart';
 import 'package:flutter_compass/flutter_compass.dart';
 import 'package:flutter_map/plugin_api.dart';
+import 'package:flutter_map_location/src/types.dart';
 import 'package:location/location.dart';
 import 'package:latlong/latlong.dart';
 
 import 'location_marker.dart';
 import 'location_options.dart';
 
 LocationMarkerBuilder _defaultMarkerBuilder =
-    (BuildContext context, LatLng point, ValueNotifier<double> heading) {
+    (BuildContext context, LatLngData ld, ValueNotifier<double> heading) {
   return Marker(
-    point: point,
+    point: ld.location,
     builder: (_) => LocationMarker(heading: heading),
     height: 60.0,
     width: 60.0,
@@ -38,7 +39,8 @@ class _LocationLayerState extends State<LocationLayer>
   final Location _location = Location();
   final ValueNotifier<LocationServiceStatus> _serviceStatus =
       ValueNotifier<LocationServiceStatus>(null);
-  final ValueNotifier<LatLng> _lastLocation = ValueNotifier<LatLng>(null);
+  final ValueNotifier<LatLngData> _lastLocation =
+      ValueNotifier<LatLngData>(null);
   final ValueNotifier<double> _heading = ValueNotifier<double>(null);
 
   StreamSubscription<LocationData> _onLocationChangedSub;
@@ -54,12 +56,12 @@ class _LocationLayerState extends State<LocationLayer>
     _initOnLocationUpdateSubscription()
         .then((LocationServiceStatus status) => _serviceStatus.value = status);
     _lastLocation.addListener(() {
-      final LatLng loc = _lastLocation.value;
+      final LatLngData loc = _lastLocation.value;
       widget.options.onLocationUpdate?.call(loc);
       if (widget.options.markers.isNotEmpty) {
         widget.options.markers.removeLast();
       }
-      if (loc == null) {
+      if (loc == null || loc.location == null) {
         return;
       }
       widget.options.markers.add(widget.options.markerBuilder != null
@@ -157,9 +159,9 @@ class _LocationLayerState extends State<LocationLayer>
   }
 }
 
-LatLng _locationDataToLatLng(LocationData ld) {
+LatLngData _locationDataToLatLng(LocationData ld) {
   if (ld.latitude == null || ld.longitude == null) {
     return null;
   }
-  return LatLng(ld.latitude, ld.longitude);
+  return LatLngData(LatLng(ld.latitude, ld.longitude), ld.accuracy);
 }

lib/src/location_options.dart

@@ -1,8 +1,7 @@
 import 'package:flutter/widgets.dart';
 import 'package:flutter_map/flutter_map.dart';
 import 'package:flutter_map/plugin_api.dart';
-
-import 'package:latlong/latlong.dart';
+import 'package:flutter_map_location/src/types.dart';
 
 enum LocationServiceStatus {
   disabled,
@@ -16,7 +15,7 @@ typedef LocationButtonBuilder = Widget Function(BuildContext context,
     ValueNotifier<LocationServiceStatus>, Function onPressed);
 
 typedef LocationMarkerBuilder = Marker Function(
-    BuildContext context, LatLng point, ValueNotifier<double> heading);
+    BuildContext context, LatLngData ld, ValueNotifier<double> heading);
 
 class LocationOptions extends LayerOptions {
   LocationOptions(
@@ -29,8 +28,8 @@ class LocationOptions extends LayerOptions {
       : assert(markers != null, buttonBuilder != null),
         super();
 
-  final void Function(LatLng) onLocationUpdate;
-  final void Function(LatLng) onLocationRequested;
+  final void Function(LatLngData) onLocationUpdate;
+  final void Function(LatLngData) onLocationRequested;
   final LocationButtonBuilder buttonBuilder;
   final LocationMarkerBuilder markerBuilder;
   final int updateIntervalMs;

lib/src/types.dart

@@ -0,0 +1,10 @@
+import 'package:latlong/latlong.dart';
+
+class LatLngData {
+  const LatLngData(this.location, this.accuracy);
+
+  final LatLng location;
+
+  /// Estimated horizontal accuracy, radial, in meters.
+  final double accuracy;
+}

test/app_test.dart

@@ -1,8 +1,8 @@
 import 'package:flutter/material.dart';
 import 'package:flutter_map_location/flutter_map_location.dart';
+import 'package:flutter_map_location/src/types.dart';
 import 'package:flutter_test/flutter_test.dart';
 import 'package:flutter_map/flutter_map.dart';
-import 'package:latlong/latlong.dart';
 
 void main() {
   testWidgets('Render app', (WidgetTester tester) async {
@@ -35,8 +35,8 @@ class _TestApp extends StatelessWidget {
               MarkerLayerOptions(markers: userLocationMarkers),
               LocationOptions(
                 markers: userLocationMarkers,
-                onLocationUpdate: (LatLng loc) {},
-                onLocationRequested: (LatLng loc) {},
+                onLocationUpdate: (LatLngData ld) {},
+                onLocationRequested: (LatLngData ld) {},
                 buttonBuilder: (BuildContext context,
                     ValueNotifier<LocationServiceStatus> status,
                     Function onPressed) {