Skip to content

newbie #752

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jenilcodes25 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

newbie #752

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
129 changes: 127 additions & 2 deletions common/ferrostar/src/navigation_controller/models.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,101 @@ impl NavState {
}
}

/// Creates a navigation state indicating the trip is paused (stopped location updates, retaining navigation context).
pub fn paused(navigating_state: Self) -> Self {
let NavState {
trip_state,
step_advance_condition,
} = navigating_state;

// We use `let ... else { return ... }` to safely destructure only when the state is Navigating.
let TripState::Navigating {
current_step_geometry_index,
user_location,
snapped_user_location,
remaining_steps,
remaining_waypoints,
progress,
summary,
deviation,
visual_instruction,
spoken_instruction,
annotation_json,
} = trip_state
else {
// If it wasn't navigating (e.g., Idle or Complete), just return the state as-is
return NavState {
trip_state,
step_advance_condition,
};
};

Self {
trip_state: TripState::Paused {
current_step_geometry_index,
user_location,
snapped_user_location,
remaining_steps,
remaining_waypoints,
progress,
summary,
deviation,
visual_instruction,
spoken_instruction,
annotation_json,
},
step_advance_condition,
}
}

/// Creates a navigation state indicating a previously paused trip has been resumed.
///
/// If the provided state is not `Paused`, it is returned unchanged.
pub fn resumed(paused_state: Self) -> Self {
let NavState {
trip_state,
step_advance_condition,
} = paused_state;

let TripState::Paused {
current_step_geometry_index,
user_location,
snapped_user_location,
remaining_steps,
remaining_waypoints,
progress,
summary,
deviation,
visual_instruction,
spoken_instruction,
annotation_json,
} = trip_state
else {
// Not paused: return original state.
return NavState {
trip_state,
step_advance_condition,
};
};

Self {
trip_state: TripState::Navigating {
current_step_geometry_index,
user_location,
snapped_user_location,
remaining_steps,
remaining_waypoints,
progress,
summary,
deviation,
visual_instruction,
spoken_instruction,
annotation_json,
},
step_advance_condition,
}
}

#[inline]
pub fn trip_state(&self) -> TripState {
self.trip_state.clone()
Expand Down Expand Up @@ -176,7 +271,24 @@ impl TripSummary {
pub enum TripState {
/// The navigation controller is idle and there is no active trip.
Idle { user_location: Option<UserLocation> },

/// The navigation controller is paused: navigation context is retained,
/// but location updates are stopped.
#[cfg_attr(feature = "wasm-bindgen", serde(rename_all = "camelCase"))]
Paused {
current_step_geometry_index: Option<u64>,
user_location: UserLocation,
snapped_user_location: UserLocation,
remaining_steps: Vec<RouteStep>,
remaining_waypoints: Vec<Waypoint>,
progress: TripProgress,
summary: TripSummary,
deviation: RouteDeviation,
visual_instruction: Option<VisualInstruction>,
spoken_instruction: Option<SpokenInstruction>,
annotation_json: Option<String>,
},

/// The navigation controller is actively navigating a trip.
Navigating {
/// The index of the closest coordinate to the user's snapped location.
Expand Down Expand Up @@ -230,6 +342,7 @@ pub enum TripState {
/// This is represented as a json formatted byte array to allow for flexible encoding of custom annotations.
annotation_json: Option<String>,
},

/// The navigation controller has reached the end of the trip.
Complete {
user_location: UserLocation,
Expand All @@ -242,7 +355,8 @@ pub enum TripState {
impl TripState {
pub(crate) fn user_location(&self) -> Option<UserLocation> {
match self {
TripState::Navigating { user_location, .. } => Some(*user_location),
TripState::Navigating { user_location, .. }
| TripState::Paused { user_location, .. } => Some(*user_location),
_ => None,
}
}
Expand All @@ -252,6 +366,10 @@ impl TripState {
TripState::Navigating {
snapped_user_location,
..
}
| TripState::Paused {
snapped_user_location,
..
} => Some(*snapped_user_location),
_ => None,
}
Expand All @@ -261,6 +379,9 @@ impl TripState {
match self {
TripState::Navigating {
remaining_steps, ..
}
| TripState::Paused {
remaining_steps, ..
} => remaining_steps.first().cloned(),
_ => None,
}
Expand All @@ -274,14 +395,18 @@ impl TripState {
match self {
TripState::Navigating {
remaining_steps, ..
}
| TripState::Paused {
remaining_steps, ..
} => remaining_steps.get(index).cloned(),
_ => None,
}
}

pub(crate) fn deviation(&self) -> Option<RouteDeviation> {
match self {
TripState::Navigating { deviation, .. } => Some(*deviation),
TripState::Navigating { deviation, .. }
| TripState::Paused { deviation, .. } => Some(*deviation),
_ => None,
}
}
Expand Down