Add remainingWaypoints Convenience Accessor to TripState

stadiamaps · Jan 30, 2025 · 8a29a1e · 8a29a1e
1 parent be820af
commit 8a29a1e
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/android/core/src/main/java/com/stadiamaps/ferrostar/core/extensions/TripStateExtensions.kt b/android/core/src/main/java/com/stadiamaps/ferrostar/core/extensions/TripStateExtensions.kt
@@ -72,3 +72,15 @@ fun TripState.remainingSteps() =
       is TripState.Complete,
       TripState.Idle -> null
     }
+
+/**
+ * Get the remaining waypoints (starting at the *next* waypoint "goal") in the current trip.
+ *
+ * @return The list of remaining waypoints (if any).
+ */
+fun TripState.remainingWaypoints() =
+    when (this) {
+      is TripState.Navigating -> this.remainingWaypoints
+      is TripState.Complete,
+      TripState.Idle -> null
+    }