Android route overview (#345)

* Initial checkpoint commit on Android route overview

* Apply automatic changes

* Minor clean-up; version updates

* Cleanup: by delegation

* State -> raw value

* Move isNavigating into state so we don't have to pass a full viewmodel everywhere and can get more granular recompositions

* Make onMapReadyCallback optional rather than a capturing default closure

* Auto-adjust most insets

* Support horizontal padding

* Snapshots; hide mute button and move recenter to bottom leading corner

* Refactor; the layering makes sense now!

* Undo experimental change

* Minor tweaks; update macOS CI to Sonoma

* Switch to iOS 18 simulator for snapshots; update nanopixel-perfect snapshots

* Ditch the view model swapping!

* Apply automatic changes

* Remove old comments

* Fix imports

* Allow stopping demo VM location updates

* Move view model to AppModule to better reflect a typical DI use case

* Apply automatic changes

* Hide zoom controls as well when showing the recenter button

* Update snapshots

* Freshen docs

* Release prep: bump version

---------

Co-authored-by: ianthetechie <ianthetechie@users.noreply.github.com>

.github/workflows/cargo-publish.yml

@@ -9,7 +9,7 @@ env:
 
 jobs:
   publish_crate:
-    runs-on: macos-14
+    runs-on: macos-15
     steps:
       - uses: actions/checkout@v4
       - name: Cargo Publish

.github/workflows/gradle-publish.yml

@@ -9,7 +9,7 @@ on:
 jobs:
   build:
 
-    runs-on: macos-13
+    runs-on: ubuntu-latest
     permissions:
       contents: read
       packages: read

.github/workflows/ios-release.yml

@@ -6,7 +6,7 @@ on:
 
 jobs:
   ios-release:
-    runs-on: macos-14
+    runs-on: macos-15
 
     permissions:
       contents: write

.github/workflows/ios.yml

@@ -8,7 +8,7 @@ on:
 
 jobs:
   format-lint:
-    runs-on: macos-14
+    runs-on: macos-15
     concurrency:
       group: ${{ github.workflow }}-${{ github.ref }}-ios-swiftformat
       cancel-in-progress: true
@@ -24,7 +24,7 @@ jobs:
       run: swiftformat . --lint
 
   build-ferrostar:
-    runs-on: macos-14
+    runs-on: macos-15
     permissions:
       contents: write  # To auto-commit Package.swift and binding changes
 
@@ -68,7 +68,7 @@ jobs:
         retention-days: 5
 
   build-demo:
-    runs-on: macos-14
+    runs-on: macos-15
     concurrency:
       group: ${{ github.workflow }}-${{ github.ref }}-ios-build-demo
       cancel-in-progress: true
@@ -119,7 +119,7 @@ jobs:
         retention-days: 5
 
   test:
-    runs-on: macos-14
+    runs-on: macos-15
     concurrency:
       group: ${{ github.workflow }}-${{ github.ref }}-ios-test
       cancel-in-progress: true
@@ -131,7 +131,7 @@ jobs:
         ]
         destination: [
           # TODO: Add more destinations
-          'platform=iOS Simulator,name=iPhone 15,OS=17.2'
+          'platform=iOS Simulator,name=iPhone 16 Pro,OS=18.1'
         ]
 
     steps:

.github/workflows/npm-publish.yml

@@ -10,7 +10,7 @@ env:
 
 jobs:
   build:
-    runs-on: macos-13
+    runs-on: macos-15
 
     steps:
       - name: Checkout code

.github/workflows/rust.yml

@@ -12,7 +12,7 @@ env:
 
 jobs:
   msrv:
-    runs-on: macos-14
+    runs-on: macos-15
     concurrency:
       group: ${{ github.workflow }}-${{ github.ref }}-rust-msrv
       cancel-in-progress: true
@@ -27,7 +27,7 @@ jobs:
         working-directory: common
 
   semver-checks:
-    runs-on: macos-14
+    runs-on: macos-15
     concurrency:
       group: ${{ github.workflow }}-${{ github.ref }}-rust-semver
       cancel-in-progress: true
@@ -41,7 +41,7 @@ jobs:
           feature-group: default-features
 
   rustfmt:
-    runs-on: macos-14
+    runs-on: macos-15
     concurrency:
       group: ${{ github.workflow }}-${{ github.ref }}-rust-rustfmt
       cancel-in-progress: true
@@ -53,7 +53,7 @@ jobs:
         working-directory: common
 
   build:
-    runs-on: macos-14
+    runs-on: macos-15
     concurrency:
       group: ${{ github.workflow }}-${{ github.ref }}-rust-build
       cancel-in-progress: true

.github/workflows/typos.yml

@@ -6,7 +6,7 @@ on:
 
 jobs:
   typos:
-    runs-on: macos-14
+    runs-on: macos-15
     concurrency:
       group: ${{ github.workflow }}-${{ github.ref }}-ios-swiftformat
       cancel-in-progress: true

.github/workflows/wasm-js.yml

@@ -12,7 +12,7 @@ env:
 
 jobs:
   build:
-    runs-on: macos-14
+    runs-on: macos-15
     concurrency:
       group: ${{ github.workflow }}-${{ github.ref }}-wasm-build
       cancel-in-progress: true

Package.swift

@@ -16,7 +16,7 @@ if useLocalFramework {
         path: "./common/target/ios/libferrostar-rs.xcframework"
     )
 } else {
-    let releaseTag = "0.20.1"
+    let releaseTag = "0.21.0"
     let releaseChecksum = "a5d8ecc5b4d4b77e2e9fd237b3c6ffd62772606a996a0e34f0fc7ecadc19fb9c"
     binaryTarget = .binaryTarget(
         name: "FerrostarCoreRS",

android/build.gradle

@@ -17,5 +17,5 @@ ext {
 
 allprojects {
     group = "com.stadiamaps.ferrostar"
-    version = "0.20.1"
+    version = "0.21.0"
 }

android/composeui/build.gradle

@@ -12,7 +12,7 @@ plugins {
 
 android {
     namespace 'com.stadiamaps.ferrostar.composeui'
-    compileSdk 34
+    compileSdk 35
 
     defaultConfig {
         minSdk 25

android/composeui/src/main/java/com/stadiamaps/ferrostar/composeui/config/VisualNavigationViewConfig.kt

@@ -0,0 +1,40 @@
+package com.stadiamaps.ferrostar.composeui.config
+
+import androidx.compose.ui.unit.DpSize
+import androidx.compose.ui.unit.dp
+
+sealed class CameraControlState {
+  data object Hidden : CameraControlState()
+
+  data class ShowRecenter(val updateCamera: () -> Unit) : CameraControlState()
+
+  data class ShowRouteOverview(val updateCamera: () -> Unit) : CameraControlState()
+}
+
+data class VisualNavigationViewConfig(
+    var showMute: Boolean = false,
+    var showZoom: Boolean = false,
+    var buttonSize: DpSize = DpSize(56.dp, 56.dp)
+) {
+  companion object {
+    fun Default() = VisualNavigationViewConfig(showMute = true, showZoom = true)
+  }
+}
+
+/** Enables the mute button in the navigation view. */
+fun VisualNavigationViewConfig.useMuteButton(): VisualNavigationViewConfig {
+  showMute = true
+  return this
+}
+
+/** Enables the zoom button in the navigation view. */
+fun VisualNavigationViewConfig.useZoomButton(): VisualNavigationViewConfig {
+  showZoom = true
+  return this
+}
+
+/** Changes the size of navigation buttons. */
+fun VisualNavigationViewConfig.buttonSize(size: DpSize): VisualNavigationViewConfig {
+  buttonSize = size
+  return this
+}

android/composeui/src/main/java/com/stadiamaps/ferrostar/composeui/views/InstructionsView.kt

@@ -56,6 +56,7 @@ import uniffi.ferrostar.VisualInstructionContent
 fun InstructionsView(
     instructions: VisualInstruction,
     distanceToNextManeuver: Double?,
+    modifier: Modifier = Modifier,
     distanceFormatter: DistanceFormatter = LocalizedDistanceFormatter(),
     theme: InstructionRowTheme = DefaultInstructionRowTheme,
     remainingSteps: List<RouteStep>? = null,
@@ -69,7 +70,8 @@ fun InstructionsView(
 
   Box(
       modifier =
-          Modifier.fillMaxWidth()
+          modifier
+              .fillMaxWidth()
               .heightIn(max = screenHeight)
               .animateContentSize(animationSpec = spring(stiffness = Spring.StiffnessHigh))
               .background(theme.backgroundColor, RoundedCornerShape(10.dp))

android/composeui/src/main/java/com/stadiamaps/ferrostar/composeui/views/controls/NavigationUIButton.kt

@@ -2,9 +2,8 @@ package com.stadiamaps.ferrostar.composeui.views.controls
 
 import androidx.compose.foundation.background
 import androidx.compose.foundation.layout.Box
-import androidx.compose.foundation.layout.height
 import androidx.compose.foundation.layout.padding
-import androidx.compose.foundation.layout.width
+import androidx.compose.foundation.layout.size
 import androidx.compose.foundation.shape.CircleShape
 import androidx.compose.material.icons.Icons
 import androidx.compose.material.icons.filled.Close
@@ -18,6 +17,7 @@ import androidx.compose.ui.draw.shadow
 import androidx.compose.ui.graphics.Color
 import androidx.compose.ui.res.stringResource
 import androidx.compose.ui.tooling.preview.Preview
+import androidx.compose.ui.unit.DpSize
 import androidx.compose.ui.unit.dp
 import com.stadiamaps.ferrostar.composeui.R
 
@@ -32,13 +32,14 @@ import com.stadiamaps.ferrostar.composeui.R
 @Composable
 fun NavigationUIButton(
     onClick: () -> Unit,
+    buttonSize: DpSize,
     containerColor: Color = FloatingActionButtonDefaults.containerColor,
     contentColor: Color = contentColorFor(containerColor),
     content: @Composable () -> Unit
 ) {
   FloatingActionButton(
       onClick,
-      modifier = Modifier.width(56.dp).height(56.dp).shadow(6.dp, shape = CircleShape),
+      modifier = Modifier.size(buttonSize).shadow(6.dp, shape = CircleShape),
       shape = CircleShape,
       containerColor,
       contentColor) {
@@ -50,7 +51,7 @@ fun NavigationUIButton(
 @Composable
 fun NavigationUIButtonPreview() {
   Box(Modifier.background(Color.LightGray).padding(16.dp)) {
-    NavigationUIButton({}) {
+    NavigationUIButton({}, DpSize(56.dp, 56.dp)) {
       Icon(Icons.Filled.Close, contentDescription = stringResource(id = R.string.end_navigation))
     }
   }

android/composeui/src/main/java/com/stadiamaps/ferrostar/composeui/views/controls/NavigationUIZoomButton.kt

@@ -5,6 +5,7 @@ import androidx.compose.foundation.layout.Box
 import androidx.compose.foundation.layout.Column
 import androidx.compose.foundation.layout.height
 import androidx.compose.foundation.layout.padding
+import androidx.compose.foundation.layout.size
 import androidx.compose.foundation.layout.width
 import androidx.compose.foundation.shape.RoundedCornerShape
 import androidx.compose.material.icons.Icons
@@ -22,11 +23,13 @@ import androidx.compose.ui.draw.shadow
 import androidx.compose.ui.graphics.Color
 import androidx.compose.ui.res.stringResource
 import androidx.compose.ui.tooling.preview.Preview
+import androidx.compose.ui.unit.DpSize
 import androidx.compose.ui.unit.dp
 import com.stadiamaps.ferrostar.composeui.R
 
 @Composable
 fun NavigationUIZoomButton(
+    buttonSize: DpSize,
     onClickZoomIn: () -> Unit,
     onClickZoomOut: () -> Unit,
     containerColor: Color = FloatingActionButtonDefaults.containerColor,
@@ -38,7 +41,7 @@ fun NavigationUIZoomButton(
   Column(modifier = Modifier.shadow(6.dp, shape = RoundedCornerShape(50))) {
     FloatingActionButton(
         onClick = onClickZoomIn,
-        modifier = Modifier.height(56.dp).width(56.dp),
+        modifier = Modifier.size(buttonSize),
         shape = RoundedCornerShape(topStartPercent = 50, topEndPercent = 50),
         containerColor = containerColor,
         contentColor = contentColor,
@@ -48,13 +51,13 @@ fun NavigationUIZoomButton(
               contentDescription = stringResource(id = R.string.zoom_in))
         }
 
-    Box(modifier = Modifier.height(1.dp).width(56.dp)) {
+    Box(modifier = Modifier.height(1.dp).width(buttonSize.width)) {
       HorizontalDivider(color = MaterialTheme.colorScheme.surfaceVariant)
     }
 
     FloatingActionButton(
         onClick = onClickZoomOut,
-        modifier = Modifier.height(56.dp).width(56.dp),
+        modifier = Modifier.size(buttonSize),
         shape = RoundedCornerShape(bottomStartPercent = 50, bottomEndPercent = 50),
         containerColor = containerColor,
         contentColor = contentColor,
@@ -69,5 +72,8 @@ fun NavigationUIZoomButton(
 @Preview
 @Composable
 fun NavigationUIZoomButtonPreview() {
-  Box(Modifier.background(Color.LightGray).padding(16.dp)) { NavigationUIZoomButton({}, {}) }
+  Box(Modifier.background(Color.LightGray).padding(16.dp)) {
+    NavigationUIZoomButton(
+        buttonSize = DpSize(56.dp, 56.dp), onClickZoomIn = {}, onClickZoomOut = {})
+  }
 }