search

maplibre / maplibre-navigation-android

Maplibre Navigation SDK for Android
MIT License
86 stars 44 forks source link

Question about route progress updates #79

Open beto-alves opened 1 year ago

beto-alves commented 1 year ago

Is there a way to force instructions to jump into determined route lag and step based on the current user's location? In our current project, we have a fixed route situation, like a delivery route from a warehouse to the factory for example. And for some scenarios, the user might be alongside and off route. The problem is when the user goes in the route and start the trip, we are not receiving the updates in the instruction view, I already debugged the NavigationRouteProcessor, NavigationHelper and OffRouteDetector. In this case the NavigationIndices are not receiving any updates in the NavigationRouteProcessor.

In this case, Is there any approach to solve the instructions update?

boldtrn commented 12 months ago

You can set the leg and step index from the OffRouteDetector using the methods in the OffRouteCallback which is registered there.

beto-alves commented 12 months ago

Hi @boldtrn thanks for your answer!

I have researched the usage of the OffRouteCallback you mentioned in the OffRouteDetector. I found the onShouldIncreaseIndex() method but couldn't find any use of the onShouldUpdateToIndex() method, which I believe would be suitable in this context.

I also investigated the OffRouteCallback and discovered that it can only be utilized within the OffRouteDetector. Unfortunately, it's not possible to use it with a custom off-route engine because the setOffRouteDetectorCallback method in NavigationHelper has a type check, limiting its compatibility to the OffRouteDetector.

So, I see two potential solutions: either modify the OffRouteDetector to accommodate this case or expose the setOffRouteCallback method, which is currently exclusive to the OffRouteDetector, to the OffRoute abstract class. This would enable the use of the callback with a custom off-route engine, which I believe is the optimal way to address this issue.

What are your thoughts on this? Do you think it's feasible to expose these methods? If yes, I'd be glad to create a pull request and contribute to this improvement.

boldtrn commented 12 months ago

has a type check, limiting its compatibility to the OffRouteDetector

I think you can extend the OffRouteDetector and this will work.

modify the OffRouteDetector to accommodate this case or expose the setOffRouteCallback method

I think this is something we could add, this would make the code easier as well. Feel free to open a PR for this.

beto-alves commented 12 months ago

Yes, extending the OffRouteDetector should also work. I will work on this and submit a pull request to expose the methods. Thank you for your support!

boldtrn commented 12 months ago

Just to clarify, I think it would make sense to add setOffRouteDetectorCallback method to the abstract class OffRoute. I am not sure we should expose the method onShouldIncreaseIndex publicly, as this is kind of a corner case of OffrouteDetection.

beto-alves commented 12 months ago

Yes, that's the approach I would take. Adding setOffRouteDetectorCallback to OffRoute makes more sense than altering the visibility of onShouldIncreaseIndex.