Navigate Route

In this guide you will learn how to compute a route between a departure point and a destination point, render the route on an interactive map, and then navigate along the route.

Setup

First, get an API key token, see the Getting Started guide.

Prerequisites

It is required that you complete the Environment Setup - Flutter Examples guide before starting this guide.

Run the example

Start a terminal/command prompt and go to the navigate_route directory, within the flutter examples directory

Build and run the example:

Build and run

Note - the gem_kit directory containing the Maps SDK for Flutter should be in the plugins directory of the example, e.g. navigate_route/plugins/gem_kit - see the environment setup guide above.

Download project dependencies:

flutter upgrade

run the following terminal commands in the project directory, where the pubspec.yaml file is located:

flutter clean

flutter pub get

Run the example:

Web browser

flutter run

If such a question appears, select the chrome browser; in the above example, press 2.

Android

First, verify that the ANDROID_SDK_ROOT environment variable is set to the root path of your android SDK.

In android/app/src/main/AndroidManifest.xml add the location permissions required for actual navigation, below the top <manifest xmlns:android line, as shown:

<uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />

<uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" />

<uses-permission android:name="android.permission.ACCESS_BACKGROUND_LOCATION" />

In android/build.gradle add the maven {} block as shown, within the allprojects {} block, for both debug and release builds, without the line numbers, those are for reference:

allprojects {
    repositories {
        google()
        mavenCentral()
        maven {
           url "${rootDir}/../plugins/gem_kit/android/build"
        }
    }
}

in android/app/build.gradle within the android {} block, in the defaultConfig {} block, the android SDK version minSdkVersion must be set as shown below.

Additionally, for release builds, in android/app/build.gradle, within the android {} block, add the buildTypes {} block as shown:

android {
    defaultConfig {
        applicationId "com.magiclane.gem_kit.examples.navigate_route"
        minSdkVersion 21
        targetSdkVersion flutter.targetSdkVersion
        versionCode flutterVersionCode.toInteger()
        versionName flutterVersionName
    }
    buildTypes {
        release {
            // TODO: Add your own signing config for the release build.
            // Signing with the debug keys for now, so `flutter run --release` works.
            minifyEnabled false
            shrinkResources false
            signingConfig signingConfigs.debug
        }
    }
}

Then build the apk:

flutter build apk --debug

or

flutter build apk --release

the apk file is located in the build/app/outputs/apk/debug or build/app/outputs/apk/release subdirectory, for debug or release build respectively, within the current project directory, which is navigate_route in this case.

The apk file name is app-release.apk or app-debug.apk

You can copy the apk to an android device using adb, for example:

adb push app-release.apk sdcard

And then click on the apk in the file browser on the device to install and run it.

iOS

In the ios/Podfile configuration text file, at the top, set the minimum ios platform to 13 like this:

platform :ios, '13.0'

Also in the ios/Podfile configuration text file, add the location permissions required for actual navigation, at the end of the file, as shown:

post_install do |installer|
  installer.pods_project.targets.each do |target|
    flutter_additional_ios_build_settings(target)

    target.build_configurations.each do |config|
      config.build_settings['GCC_PREPROCESSOR_DEFINITIONS'] ||= [
        '$(inherited)',
        ## dart: [PermissionGroup.location, PermissionGroup.locationAlways, PermissionGroup.locationWhenInUse]
         'PERMISSION_LOCATION=1',
      ]
    end
  end
end

In the ios/Runner/Info.plist configuration text file, add the following lines inside the <dict> </dict> block:

<key>NSLocationWhenInUseUsageDescription</key>

<string>Location is needed for map localization and navigation</string>

Run pod install in the [ios folder] ./ios/

Then go back to the repository root folder and type flutter build ios to build a Runner.app.

Type flutter run to build and run on an attached device.

You can open the <path/to>/ios/Runner.xcworkspace project in Xcode and execute and debug from there.

How it works

In the navigate_route project directory, there is a text file named pubspec.yaml which contains project configuration and dependencies. The most important lines from this file are shown here:

name: navigate_route
version: 1.0.0+1

environment:
  sdk: '>=3.0.5 <4.0.0'

dependencies:
  flutter:
    sdk: flutter
  gem_kit:
    path: plugins/gem_kit

  cupertino_icons: ^1.0.2
  intl: ^0.18.1
  permission_handler: ^10.4.2

# The following section is specific to Flutter packages.
flutter:
  uses-material-design: true

The project must have a name and version. The dependencies list the Flutter SDK, and the gem_kit, Maps for Flutter SDK.

The source code is in navigate_route/lib/main.dart

import 'package:navigate_route/bottom_navigation_panel.dart';
import 'package:navigate_route/instruction_model.dart';
import 'package:navigate_route/position_model.dart';
import 'package:navigate_route/top_navigation_panel.dart';
import 'package:navigate_route/utility.dart';

import 'package:gem_kit/gem_kit_basic.dart';
import 'package:gem_kit/gem_kit_map_controller.dart';
import 'package:gem_kit/gem_kit_position.dart';
import 'package:gem_kit/api/gem_mapviewpreferences.dart' as gem;
import 'package:gem_kit/api/gem_navigationservice.dart';
import 'package:gem_kit/api/gem_coordinates.dart';
import 'package:gem_kit/api/gem_landmark.dart';
import 'package:gem_kit/api/gem_routingpreferences.dart';
import 'package:gem_kit/api/gem_sdksettings.dart';
import 'package:gem_kit/api/gem_routingservice.dart' as gem;
import 'package:gem_kit/widget/gem_kit_map.dart';

import 'dart:async';
import 'package:flutter/material.dart';
import 'package:flutter/foundation.dart';
import 'package:permission_handler/permission_handler.dart';

void main() {
  runApp(const MyApp());
}

class MyApp extends StatelessWidget {
  const MyApp({super.key});

  // This widget is the root of your application.
  @override
  Widget build(BuildContext context) {
    return const MaterialApp(
      debugShowCheckedModeBanner: false,
      title: 'Navigate route',
      home: MyHomePage(),
    );
  }
}

class MyHomePage extends StatefulWidget {
  const MyHomePage({super.key});

  @override
  State<MyHomePage> createState() => _MyHomePageState();
}

The dart material package is imported, as well as the gem_kit packages for the map controller, which enables user input such as pan and zoom, the map package which draws the map, the routingservice which computes a route, the landmark and coordinates packages for geolocation, the navigationservice package which carries out both simulated and actual navigation, and the settings and map preferences packages.

Note that, in addition to the gem_kit packages imported for simulation, navigation also requires the position package.

The map is in a widget which is the root of the application.

class _MyHomePageState extends State<MyHomePage> {
  late GemMapController mapController;
  late SdkSettings _sdkSettings;
  late gem.RoutingService _routingService;
  late NavigationService _navigationService;
  late PositionService _positionService;
  late InstructionModel currentInstruction;
  PermissionStatus locationPermissionStatus = PermissionStatus.denied;

  List<Coordinates> mywaypoints = [];
  List<gem.Route> shownRoutes = [];

  bool haveRoutes = false;
  bool isNavigating = false;
  PositionModel currentPosition = PositionModel(
   latitude: 48.859935072481264,
   longitude: 2.294484386370221,
   altitude: 0,
   speed: 0);

  @override
  void initState() {
    super.initState();
  }

  Future<void> onMapCreated(GemMapController controller) async {
    _mapController = controller;
    SdkSettings.create(_mapController.mapId).then((value) {
      _sdkSettings = value;
      _sdkSettings.setAppAuthorization("YOUR_API_KEY_TOKEN");
    });

    _routingService = await gem.RoutingService.create(_mapController.mapId);
    _navigationService = await NavigationService.create(controller.mapId);
    _positionService = await PositionService.create(_mapController.mapId);
  }

The map is initialized with the map controller and the settings. In addition to the RoutingService and NavigationService, also required for simulation, actual navigation also requires a PositionService to be instantiated. The current position is initialized in Paris until a GPS position is obtained from the device, which requires user permission first.

Setting the API key

The string "YOUR_API_KEY_TOKEN" should be replaced with your actual API key token string.

A tap on the arrow button at the top right causes a set of routes to be computed and rendered on the map.

// Method for asking for location permission
_askForLocation() async {
  if (kIsWeb) {
    await _positionService.setLiveDataSource();
    await _positionService.addPositionListener((pos) {
      currentPosition = PositionModel(
          latitude: pos.coordinates.latitude,
          longitude: pos.coordinates.longitude,
          altitude: pos.coordinates.altitude,
          speed: pos.speed);
    });
    setState(() {
      locationPermissionStatus = PermissionStatus.granted;
    });
  } else {
    if (locationPermissionStatus == PermissionStatus.granted) {
      return;
    }
    locationPermissionStatus = await Permission.locationWhenInUse.request();

    if (locationPermissionStatus == PermissionStatus.granted) {
      await _mapController.startFollowingPosition();
      await _positionService.addPositionListener((pos) {
        currentPosition = PositionModel(
            latitude: pos.coordinates.latitude,
            longitude: pos.coordinates.longitude,
            altitude: pos.coordinates.altitude,
            speed: pos.speed);
      });
      setState(() {});
    }
  }
}

This is the method to ask location permission from the user, as actual navigation requires a live GPS position from the device GPS sensor.

// Method for calling calculate route and displaying the results
_onPressed(BuildContext context) async {
 mywaypoints.add(Coordinates(
     latitude: currentPosition.latitude,
     longitude: currentPosition.longitude));
 mywaypoints.add(Coordinates(
     latitude: 44.42453081911026, longitude: 26.101618214626367));

   // Create a landmark list
   final landmarkWaypoints =
      await gem.LandmarkList.create(_mapController.mapId);

   // Create landmarks from coordinates and add them to the list
   for (final wp in mywaypoints) {
      var landmark = await Landmark.create(_mapController.mapId);
      await landmark.setCoordinates(
         Coordinates(latitude: wp.latitude, longitude: wp.longitude));
      landmarkWaypoints.push_back(landmark);
   }
   final routePreferences = RoutePreferences();

   var result = await _routingService.calculateRoute(
      landmarkWaypoints, routePreferences, (err, routes) async {
      if (err != GemError.success || routes == null) {
         return;
      } else {
         // Get the controller's preferences
         final mapViewPreferences = await _mapController.preferences();
         // Get the routes from the preferences
         final routesMap = await mapViewPreferences.routes();
         //Get the number of routes
         final routesSize = await routes.size();

         for (int i = 0; i < routesSize; i++) {
            final route = await routes.at(i);
            shownRoutes.add(route);
            final timeDistance = await route.getTimeDistance();

            final totalDistance = convertDistance(
               timeDistance.unrestrictedDistanceM +
               timeDistance.restrictedDistanceM);

            final totalTime = convertDuration(
               timeDistance.unrestrictedTimeS + timeDistance.restrictedTimeS);
               // Add labels to the routes
               await routesMap.add(route, i == 0,
               label: '$totalDistance \n $totalTime');
         }
         // Select the first route as the main one
         final mainRoute = await routes.at(0);
         await _mapController.centerOnRoute(mainRoute);
      }
   });
   setState(() {
      haveRoutes = true;
   });
   return result;
}

This is the custom method to compute a route by calling: _routingService.calculateRoute(), rendering the resulting set of routes on the map, then choosing the route at index 0 (the first one), setting it as the mainRoute and then centering the main route so it fits in the viewport: _mapController.centerOnRoute()

// Method for creating the simulation
_navigateOnRoute(
   {required gem.Route route,
   required Function(InstructionModel) onInstructionUpdated}) async {
 await _navigationService.startNavigation(route, (type, instruction) async {
   if (type != NavigationEventType.navigationInstructionUpdate ||
       instruction == null) {
     setState(() {
       isNavigating = false;
       _removeRoutes(shownRoutes);
     });
     return;
   }
   isNavigating = true;
   final ins = await InstructionModel.fromGemInstruction(instruction);
   onInstructionUpdated(ins);
   instruction.dispose();
 });
}

// Method for starting the simulation and following the position
_startNavigation(gem.Route route) async {
 await _navigateOnRoute(
     route: route,
     onInstructionUpdated: (instruction) {
       currentInstruction = instruction;
       setState(() {});
     });
 _mapController.startFollowingPosition(
     animation:
         gem.GemAnimation(duration: 200, type: gem.EAnimation.AnimationLinear));
}

Actual navigation along the route is started by await _navigationService.startNavigation() as compared to navigation simulation along the route, which would have been started by await _navigationService.startSimulation() and the camera is set to follow the current position indicator arrow using _mapController.startFollowingPosition()

A tap on the green arrow button at the top causes the navigation to start, and the camera to follow the position indicator.

_removeRoutes(List<gem.Route> routes) async {
  final prefs = await _mapController.preferences();
  final routesMap = await prefs.routes();

  for (final route in routes) {
    routesMap.remove(route);
  }
  shownRoutes.clear();
  setState(() {
    haveRoutes = false;
    isNavigating = false;
  });
}

Function to remove the computed routes rendered on the map.

// Method to stop the simulation and remove the displayed routes
_stopNavigation(List<gem.Route> routes) async {
  await _navigationService.cancelNavigation();
  _removeRoutes(routes);
}

Function implementing the red stop navigation button.

@override
Widget build(BuildContext context) {
 return Scaffold(
   appBar: AppBar(
     title: const Text("Navigate route"),
     backgroundColor: Colors.deepPurple[900],
     actions: [
       GestureDetector(
         onTap: () => _startNavigation(shownRoutes[0]),
         child: Icon(Icons.play_arrow,
             size: 40,
             color: haveRoutes
                 ? isNavigating
                     ? Colors.grey
                     : Colors.green
                 : Colors.grey),
       ),
       GestureDetector(
         onTap: () => _stopNavigation(shownRoutes),
         child: Icon(Icons.stop,
             size: 40, color: haveRoutes ? Colors.red : Colors.grey),
       ),
       GestureDetector(
         onTap: () => haveRoutes ? null : _onPressed(waypoints, context),
         child: Icon(
           Icons.directions,
           size: 40,
           color: haveRoutes ? Colors.grey : Colors.white,
         ),
       )
     ],
   ),

The green play button, the red stop button and the button to compute the routes.

  body: Stack(children: [
     GemMap(
       onMapCreated: onMapCreated,
     ),
     if (isNavigating)
       Positioned(
         top: 40,
         left: 10,
         child: NavigationInstructionPanel(
           instruction: currentInstruction,
         ),
       ),
     if (isNavigating)
       Positioned(
         bottom: 30,
         left: 0,
         child: NavigationBottomPanel(
           remainingDistance: currentInstruction.remainingDistance,
           eta: currentInstruction.eta,
           remainingDuration: currentInstruction.remainingDuration,
         ),
       ),

The top navigation panel, showing next turn icons and instructions, and the bottom navigation panel. These panels are shown when navigation, including simulated navigation, is active.

     if (isNavigating)
       Positioned(
         top: MediaQuery.of(context).size.height * 0.26,
         left: MediaQuery.of(context).size.width / 2 - 65,
         child: GestureDetector(
           onTap: () => _mapController.startFollowingPosition(),
           child: InkWell(
             child: Container(
               height: 50,
               padding: const EdgeInsets.symmetric(horizontal: 10),
               decoration: BoxDecoration(
                 color: Colors.white,
                 borderRadius: const BorderRadius.all(Radius.circular(20)),
                 boxShadow: [
                   BoxShadow(
                     color: Colors.grey.withOpacity(0.5),
                     spreadRadius: 5,
                     blurRadius: 7,
                     offset: const Offset(0, 3),
                   ),
                 ],
               ),
               child: Row(
                 mainAxisAlignment: MainAxisAlignment.spaceBetween,
                 children: [
                   Icon(
                     Icons.navigation,
                     color: Theme.of(context).colorScheme.primary,
                   ),
                   const Text(
                     'Recenter',
                     style: TextStyle(
                         color: Colors.black,
                         fontSize: 16,
                         fontWeight: FontWeight.w600),
                   )
                 ],
               ),
             ),
           ),
         ),
       ),
   ]),

If a pan occurs during navigation, the camera no longer follows the simulated position indicator, which can even move off the screen.

A tap on the re-center button causes the camera to resume following the simulated position:

onTap: () => _mapController.startFollowingPosition()

   resizeToAvoidBottomInset: false,
   floatingActionButtonLocation:
       isNavigating ? null : FloatingActionButtonLocation.endFloat,
   floatingActionButton: isNavigating
       ? null
       : locationPermissionStatus != PermissionStatus.granted
           ? FloatingActionButton(
               backgroundColor: Colors.white,
               onPressed: () => _askForLocation(),
               child: const Icon(Icons.location_off, color: Colors.red),
             )
           : FloatingActionButton(
               backgroundColor: Colors.white,
               onPressed: () => _mapController.startFollowingPosition(),
               child: const Icon(
                 Icons.location_on,
                 color: Colors.green,
               ),
             ),
 );
}

This is the floating position access permission request button in the lower right of the viewport. If location/position is not available because user permission has not yet been obtained, the button icon is red; otherwise it is green to indicate that position data from the device sensor is available.