Mfw Map Example

Mfw Map Example

This example demonstrates the plugins usage for connecting a map (MfwMap) to an application, building and displaying routes (MfwOfflineRouting) by points and geocoding (MfwOfflineGeocoding) based on data.

MFW Example

This example demonstrates the plugins usage for connecting a map (MfwMap) to an application, building and displaying routes (MfwOfflineRouting) by points and geocoding (MfwOfflineGeocoding) based on data.

  • MfwMap - responsible for displaying the map and objects on this map.
  • MfwOfflineRouting - provides an ability to obtain data for building a route on the map, taking into account the type of the transport and other settings.
  • MfwOfflineGeocoding - provides an ability to obtain data about an object using its address or coordinates.

Build status:

  1. example - pipeline status
  2. dev - pipeline status

Terms of Use and Participation

The source code of the project is provided under the license, which allows its use in third-party applications.

The contributor agreement documents the rights granted by contributors of the Open Mobile Platform.

Information about the contributors is specified in the AUTHORS file.

Code of conduct is a current set of rules of the Open Mobile Platform which informs you how we expect the members of the community will interact while contributing and communicating.

Project Structure

The project has a standard structure of an application based on C++ and QML for Aurora OS.

  • features directory contains descriptions of the functionality.
  • icons directory contains application icons for different screen resolutions.
  • plugins directory contains used plugins.
  • qml directory contains the QML source code and the UI resources.
  • rpm directory contains the rpm-package build settings.
  • src directory contains the C++ source code.
  • translations directory contains the UI translation files.

Compatibility

The project is compatible with all the supported versions of the Aurora OS.

Getting started

Setting up symbolic links on Windows

To correctly clone the project on Windows, you need to set up symbolic links.

Enable "Developer Mode" on Windows to allow using mklink:

  1. Go to Start - Settings - Privacy & security.
  2. Select "For Developers" on the left.
  3. Enable "Developer Mode"
  4. Restart your computer

Configure git: git config --global core.symlinks true

Cloning the MdwExample projects with all submodules:

git clone --recurse-submodules https://gitlab.com/omprussia/examples-extra/MfwMap.git

or

git clone https://gitlab.com/omprussia/examples-extra/MfwMap.git
cd MfwMapExample
git submodule update --init --recursive

Connecting plugins

  • MfwMap: plugin connection, according to instructions MfwMap.
  • MfwOfflineRouting: plugin connection, according to instructions MfwOfflineRouting.
  • MfwOfflineGeocoding: plugin connection, according to instructions MfwOfflineGeocoding.

Connecting maps with non-trivial schemes for MapLibre

To connect maps using schemes other than http://, https:// and mapbox://, you need to specify apiBaseUrl - the address of the map receiving service. To connect VK maps not from the demo service, you need to fill out an application on the website https://maps.vk.com/ru/welcome/, to get an API key for access to the main service.

Screenshots

Example menu Map Routing Geocoding

This document in Russian / Перевод этого документа на русский язык