Enhanced DeviceLocationProvider, GPS logging and playback (#811)

* [wip] log location to file

* use persistentDataPath for location log file

* log location info. update scene

* writing log file seems to work on Android and iOS

* string.format fix

* Change location provider folder/scene name

* make player transparent

* LocationProviderScene: Screen.sleepTimeout = SleepTimeout.NeverSleep;

* cleanup after merge

* add DeviceOrientationMaterial

* fix v1.4.2 merge quest using wrong LocationProvider scene and LogLocationProviderData.cs

* fix typo in DeviceLocationProvider.cs

* disable native Android location plugin for testing purposes

* implement proper LocationLogFile Reader and Writer

* implement LocationLogWriter

* testing: force default location provider for Android

* for baran :-)

* set scene back to defaults

* fine tune parameters

* make sure Android native location plugin does not run when deactivated

* reattach loggingtoggle

* just a little bit of eyecandy for the text panel

* FOR DEBUGGING: MockLocationInfo and MockLocationProvider to feed locations logs through `DeviceLocationProvider`.

* [wip] work on UserHeading calculation

* work on UserHeading and DeviceOrientation

* Smoothing algorithms

* make heading and orientation material more transparent

* update changelog and documentation

* add code comments

* fix "MonoBehaviours can only be added using AddComponent()" and don't run DeviceLocationProvder CoRoutine when not selected as default location provider

* location provider scene: change EditorProvider back to log file provider

* Revert to original materials

Author: Wilhelm Berg

documentation/docs/05-changelog.md

@@ -5,8 +5,12 @@
 - Added a **Feature Replacement Modifer** that allows replacement of a vector feature at a given Latitude,Longitude with a supplied prefab. Enables replacing a procedurally generated building at a given Latitude,Longitude with a custom 3D model.
 - Texturing Style dropdown now allows users to select from prepackaged texture styles or custom, which allows for user-defined texturing.
 - Mesh and GameObject modifiers can now be created and added to AbstractMap via `Add New` buttons.
+- Example scene `LocationProvder` can be used to log GPS traces. See documentation on how to copy logs from devices.
+- GPS traces can be played back in the Editor with `EditorLocationProviderLocationLog`.
+- `UserHeading` and `DeviceOrientation` values can be smoothed via different smoothing algorithms.
 ##### Improvements
 - Improvements to UV mapping for side walls of extruded polygons when using atlas textures. Enables better handling of leftover areas when creating columns.
+- DeviceLocationProvider should work on devices. Tested with iPhone 7/8/X, Google Pixel 2, Samsung S8, Samsung Galaxy Note 8, OnePlus 3
 ##### Bug Fixes
 - Fix issue with UvModifier which caused wrong roof uv positions calculations.
 - Fix issue with data fetcher to handle failed connections properly, which caused IndexOutOfRangeException during tile loading/unloading.

documentation/docs/access-gps-logs.md

@@ -0,0 +1,39 @@
+# Accessing GPS log files
+
+`LocationProvider` scene has the option to write location data into files.
+Follow these steps download the logs from your device.
+
+## Android
+
+Log files can be accessed directly via Explorer after plugging in the device.
+
+**Note:** If files don't show up disconnect/connect your device. Sometimes even a reboot seems to be required as folders/files only get synced on first connection.
+
+**Alternative:** use a file manager (eg [Solid Explorer Classic](https://play.google.com/store/apps/details?id=pl.solidexplorer)) on your device and copy files to eg `<storage>/Download` that should trigger a refresh.
+
+
+Location:
+
+```
+/<your-device>/<storage>/Android/data/<bundle-identifier>/files/
+```
+
+![log file location on Android](images/access-gps-logs/android-logfile-location.png)
+
+## iOS
+
+Open the exported project in `XCode` and add `Application supports iTunes file sharing : YES` key to `Info.plist` file:
+
+![edit info.plist](images/access-gps-logs/info.plist.png)
+
+Build to the device, run, log and connect device to your computer.
+
+Select the device in `iTunes`:
+
+![select device in itunes](images/access-gps-logs/itunes-select-device.png)
+
+1. Click on `File Sharing`
+2. Select `Bundle Identifier` eg `MBX-SDK` from the `Apps` list
+3. Access log files
+
+![get log files in itunes](images/access-gps-logs/itunes-file-sharing.png)

documentation/docs/images/access-gps-logs/android-logfile-location.png

@@ -11,4 +11,7 @@
   href: windowsstore-uwp-hololens.md
 
 - name: HoloLens Development
-  href: hololens-development.md 
+  href: hololens-development.md
+
+- name: Access GPS logs
+  href: access-gps-logs.md

documentation/docs/images/access-gps-logs/info.plist.png

@@ -4,7 +4,8 @@
 // </copyright>
 //-----------------------------------------------------------------------
 
-namespace Mapbox.Utils {
+namespace Mapbox.Utils
+{
 	using System;
 	using System.Collections.Generic;
 	using System.Text;
@@ -13,7 +14,8 @@ namespace Mapbox.Utils {
 	/// <summary>
 	/// A set of Unix Timestamp utils.
 	/// </summary>
-	public static class UnixTimestampUtils {
+	public static class UnixTimestampUtils
+	{
 
 		// http://gigi.nullneuron.net/gigilabs/converting-tofrom-unix-timestamp-in-c/
 
@@ -22,7 +24,8 @@ public static class UnixTimestampUtils {
 		/// </summary>
 		/// <param name="date"></param>
 		/// <returns></returns>
-		public static double To(DateTime date) {
+		public static double To(DateTime date)
+		{
 			//return date.ToLocalTime().Subtract(new DateTime(1970, 1, 1, 0, 0, 0, DateTimeKind.Utc)).TotalSeconds;
 			return date.Subtract(new DateTime(1970, 1, 1, 0, 0, 0, DateTimeKind.Utc)).TotalSeconds;
 		}

documentation/docs/images/access-gps-logs/itunes-file-sharing.png

@@ -38,7 +38,7 @@ RenderSettings:
   m_ReflectionIntensity: 1
   m_CustomReflection: {fileID: 0}
   m_Sun: {fileID: 0}
-  m_IndirectSpecularColor: {r: 0.4465785, g: 0.49641252, b: 0.574817, a: 1}
+  m_IndirectSpecularColor: {r: 0.44657826, g: 0.49641263, b: 0.57481676, a: 1}
 --- !u!157 &3
 LightmapSettings:
   m_ObjectHideFlags: 0
@@ -298,6 +298,11 @@ Prefab:
       propertyPath: m_RootOrder
       value: 2
       objectReference: {fileID: 0}
+    - target: {fileID: 114472907270853152, guid: 35ce2bb4caba9434db5e656796b632b1,
+        type: 2}
+      propertyPath: _editorDebuggingOnly._locationLogFile
+      value: 
+      objectReference: {fileID: 4900000, guid: 5e6bb7224cef35c4788a4817b1c9778d, type: 3}
     m_RemovedComponents: []
   m_ParentPrefab: {fileID: 100100000, guid: 35ce2bb4caba9434db5e656796b632b1, type: 2}
   m_IsPrefabParent: 0

documentation/docs/images/access-gps-logs/itunes-select-device.png

@@ -6,15 +6,15 @@ Material:
   m_ObjectHideFlags: 0
   m_PrefabParentObject: {fileID: 0}
   m_PrefabInternal: {fileID: 0}
-  m_Name: HeadingMat
+  m_Name: DeviceOrientationMat
   m_Shader: {fileID: 46, guid: 0000000000000000f000000000000000, type: 0}
-  m_ShaderKeywords: _ALPHATEST_ON
+  m_ShaderKeywords: _ALPHAPREMULTIPLY_ON
   m_LightmapFlags: 4
   m_EnableInstancingVariants: 0
   m_DoubleSidedGI: 0
-  m_CustomRenderQueue: 2450
+  m_CustomRenderQueue: 3000
   stringTagMap:
-    RenderType: TransparentCutout
+    RenderType: Transparent
   disabledShaderPasses: []
   m_SavedProperties:
     serializedVersion: 3
@@ -59,19 +59,19 @@ Material:
     - _BumpScale: 1
     - _Cutoff: 0.5
     - _DetailNormalMapScale: 1
-    - _DstBlend: 0
+    - _DstBlend: 10
     - _GlossMapScale: 1
     - _Glossiness: 0.5
     - _GlossyReflections: 1
     - _Metallic: 0
-    - _Mode: 1
+    - _Mode: 3
     - _OcclusionStrength: 1
     - _Parallax: 0.02
     - _SmoothnessTextureChannel: 0
     - _SpecularHighlights: 1
     - _SrcBlend: 1
     - _UVSec: 0
-    - _ZWrite: 1
+    - _ZWrite: 0
     m_Colors:
-    - _Color: {r: 0.11724138, g: 1, b: 0, a: 1}
+    - _Color: {r: 1, g: 0, b: 0, a: 0.391}
     - _EmissionColor: {r: 0, g: 0, b: 0, a: 1}