feat: add user location (#68)

- [x] release jni builder objects (e.g. LocationEngineRequest_Builder) - [x] solution for web - [x] working android integration - [x] example app
josxha · Oct 6, 2024 · 4d0c6db · 4d0c6db
1 parent 9745aba
commit 4d0c6db
Show file tree

Hide file tree

Showing 21 changed files with 2,289 additions and 338 deletions.
diff --git a/android/src/main/kotlin/com/github/josxha/maplibre/MapLibrePlugin.kt b/android/src/main/kotlin/com/github/josxha/maplibre/MapLibrePlugin.kt
@@ -22,6 +22,7 @@ class MapLibrePlugin : FlutterPlugin, ActivityAware {
     private lateinit var flutterAssets: FlutterPlugin.FlutterAssets
 
     override fun onAttachedToEngine(binding: FlutterPlugin.FlutterPluginBinding) {
+        MapLibreRegistry.context = binding.applicationContext;
         flutterAssets = binding.flutterAssets
         binding
             .platformViewRegistry

diff --git a/android/src/main/kotlin/com/github/josxha/maplibre/MapLibreRegistry.kt b/android/src/main/kotlin/com/github/josxha/maplibre/MapLibreRegistry.kt
@@ -1,9 +1,13 @@
 package com.github.josxha.maplibre
 
+import android.annotation.SuppressLint
+import android.app.Activity
+import android.content.Context
 import androidx.annotation.Keep
 import org.maplibre.android.maps.MapLibreMap
 
 @Keep
+@SuppressLint("StaticFieldLeak")
 object MapLibreRegistry {
     private val mapRegistry = HashMap<Int, MapLibreMap>()
 
@@ -14,4 +18,10 @@ object MapLibreRegistry {
     fun addMap(viewId: Int, map: MapLibreMap) {
         mapRegistry[viewId] = map
     }
+
+    // TODO: Storing the Activity in a static field is a potential memory leak.
+    public var activity: Activity? = null;
+
+    // TODO: Storing the Context in a static field is a potential memory leak.
+    public var context: Context? = null;
 }
diff --git a/example/lib/main.dart b/example/lib/main.dart
@@ -21,6 +21,7 @@ import 'package:maplibre_example/menu_page.dart';
 import 'package:maplibre_example/parameters_page.dart';
 import 'package:maplibre_example/styled_map_page.dart';
 import 'package:maplibre_example/two_maps_page.dart';
+import 'package:maplibre_example/user_location_page.dart';
 import 'package:maplibre_example/web_controls_page.dart';
 
 void main() {
@@ -47,6 +48,7 @@ class MyApp extends StatelessWidget {
         GesturesPage.location: (context) => const GesturesPage(),
         EventsPage.location: (context) => const EventsPage(),
         StyledMapPage.location: (context) => const StyledMapPage(),
+        UserLocationPage.location: (context) => const UserLocationPage(),
         LayersSymbolPage.location: (context) => const LayersSymbolPage(),
         LayersCirclePage.location: (context) => const LayersCirclePage(),
         LayersHeatmapPage.location: (context) => const LayersHeatmapPage(),

diff --git a/example/lib/menu_page.dart b/example/lib/menu_page.dart
@@ -20,6 +20,7 @@ import 'package:maplibre_example/layers_symbol_page.dart';
 import 'package:maplibre_example/parameters_page.dart';
 import 'package:maplibre_example/styled_map_page.dart';
 import 'package:maplibre_example/two_maps_page.dart';
+import 'package:maplibre_example/user_location_page.dart';
 import 'package:maplibre_example/web_controls_page.dart';
 
 class MenuPage extends StatelessWidget {
@@ -79,6 +80,12 @@ class MenuPage extends StatelessWidget {
                 iconData: Icons.animation,
                 location: AnimationPage.location,
               ),
+              if (!kIsWeb)
+                ItemCard(
+                  label: 'User Location',
+                  iconData: Icons.gps_fixed,
+                  location: UserLocationPage.location,
+                ),
             ],
           ),
           const SliverToBoxAdapter(child: SectionTitle('Annotations')),

diff --git a/example/lib/user_location_page.dart b/example/lib/user_location_page.dart
@@ -0,0 +1,76 @@
+import 'package:flutter/material.dart';
+import 'package:maplibre/maplibre.dart';
+import 'package:maplibre_example/styled_map_page.dart';
+import 'package:permission_handler/permission_handler.dart';
+
+@immutable
+class UserLocationPage extends StatefulWidget {
+  const UserLocationPage({super.key});
+
+  static const location = '/user-location';
+
+  @override
+  State<UserLocationPage> createState() => _UserLocationPageState();
+}
+
+class _UserLocationPageState extends State<UserLocationPage> {
+  late final MapController _controller;
+
+  @override
+  Widget build(BuildContext context) {
+    return Scaffold(
+      appBar: AppBar(title: const Text('User Location')),
+      body: Column(
+        children: [
+          Padding(
+            padding: const EdgeInsets.all(8),
+            child: Wrap(
+              spacing: 8,
+              alignment: WrapAlignment.center,
+              children: [
+                OutlinedButton(
+                  onPressed: () async {
+                    final status = await Permission.locationWhenInUse.request();
+                    debugPrint(status.toString());
+                  },
+                  child: const Text(
+                    'Get permission',
+                    textAlign: TextAlign.center,
+                  ),
+                ),
+                OutlinedButton(
+                  onPressed: () async {
+                    await _controller.enableLocation();
+                  },
+                  child: const Text(
+                    'Enable location',
+                    textAlign: TextAlign.center,
+                  ),
+                ),
+                OutlinedButton(
+                  onPressed: () async {
+                    await _controller.trackLocation();
+                  },
+                  child: const Text(
+                    'Track location',
+                    textAlign: TextAlign.center,
+                  ),
+                ),
+              ],
+            ),
+          ),
+          Expanded(
+            child: MapLibreMap(
+              options: MapOptions(
+                zoom: 1,
+                center: Position(0, 0),
+                style: StyledMapPage.styleUrl,
+              ),
+              onMapCreated: (controller) => _controller = controller,
+            ),
+          ),
+        ],
+      ),
+    );
+  }
+}
diff --git a/example/pubspec.yaml b/example/pubspec.yaml
@@ -16,6 +16,7 @@ dependencies:
   http: ^1.2.2
   maplibre:
     path: ../
+  permission_handler: ^11.3.1
 
 dev_dependencies:
   flutter_test:

diff --git a/example/windows/flutter/generated_plugin_registrant.cc b/example/windows/flutter/generated_plugin_registrant.cc
@@ -7,8 +7,11 @@
 #include "generated_plugin_registrant.h"
 
 #include <maplibre/maplibre_plugin_c_api.h>
+#include <permission_handler_windows/permission_handler_windows_plugin.h>
 
 void RegisterPlugins(flutter::PluginRegistry* registry) {
   MaplibrePluginCApiRegisterWithRegistrar(
       registry->GetRegistrarForPlugin("MaplibrePluginCApi"));
+  PermissionHandlerWindowsPluginRegisterWithRegistrar(
+      registry->GetRegistrarForPlugin("PermissionHandlerWindowsPlugin"));
 }
diff --git a/example/windows/flutter/generated_plugins.cmake b/example/windows/flutter/generated_plugins.cmake
@@ -4,6 +4,7 @@
 
 list(APPEND FLUTTER_PLUGIN_LIST
   maplibre
+  permission_handler_windows
 )
 
 list(APPEND FLUTTER_FFI_PLUGIN_LIST

diff --git a/jnigen.yml b/jnigen.yml
@@ -24,8 +24,8 @@ source_path:
   - 'android/src/main'
 classes:
 # https://github.com/maplibre/maplibre-native/tree/main/platform/android/MapLibreAndroid/src/main/java/org/maplibre/android
-  - 'android.app.Activity'
   - 'android.graphics.PointF'
+  - 'android.location.Location'
   - 'com.github.josxha.maplibre.MapLibreRegistry'
   - 'org.maplibre.android.attribution'
   - 'org.maplibre.android.camera'