Package-level declarations
Types
Link copied to clipboard
class AndroidMapLibreNavigation(context: Context, val options: MapLibreNavigationOptions = MapLibreNavigationOptions(), locationEngine: LocationEngine = LocationEngineProvider.getBestLocationEngine(context), var cameraEngine: Camera = SimpleCamera(), var snapEngine: Snap = SnapToRoute(), var offRouteEngine: OffRoute = OffRouteDetector(), var fasterRouteEngine: FasterRoute = FasterRouteDetector(options), val routeUtils: RouteUtils = RouteUtils()) : MapLibreNavigation
A Android platform specific wrapper for MapLibreNavigation.
Link copied to clipboard
class IOSMapLibreNavigation(options: MapLibreNavigationOptions = MapLibreNavigationOptions(), locationEngine: LocationEngine = AppleLocationEngine(), cameraEngine: Camera = SimpleCamera(), snapEngine: Snap = SnapToRoute(), offRouteEngine: OffRoute = OffRouteDetector(), fasterRouteEngine: FasterRoute = FasterRouteDetector(options), routeUtils: RouteUtils = RouteUtils()) : MapLibreNavigation
A iOS platform specific wrapper for MapLibreNavigation.
Link copied to clipboard
open class MapLibreNavigation @JvmOverloads constructor(val options: MapLibreNavigationOptions = MapLibreNavigationOptions(), locationEngine: LocationEngine, var cameraEngine: Camera = SimpleCamera(), var snapEngine: Snap = SnapToRoute(), var offRouteEngine: OffRoute = OffRouteDetector(), var fasterRouteEngine: FasterRoute = FasterRouteDetector(options), val routeUtils: RouteUtils = RouteUtils())
A MapLibreNavigation class for interacting with and customizing a navigation session.
Link copied to clipboard
data class MapLibreNavigationOptions(val maxTurnCompletionOffset: Double = Defaults.MAX_TURN_COMPLETION_OFFSET, val maneuverZoneRadius: Double = Defaults.MANEUVER_ZONE_RADIUS, val deadReckoningTimeInterval: Double = Defaults.DEAD_RECKONING_TIME_INTERVAL, val maxManipulatedCourseAngle: Double = Defaults.MAX_MANIPULATED_COURSE_ANGLE, val userLocationSnapDistance: Double = Defaults.USER_LOCATION_SNAPPING_DISTANCE, val secondsBeforeReroute: Int = Defaults.SECONDS_BEFORE_REROUTE, val defaultMilestonesEnabled: Boolean = Defaults.DEFAULT_MILESTONES_ENABLED, val snapToRoute: Boolean = Defaults.SNAP_TO_ROUTE, val enableOffRouteDetection: Boolean = Defaults.ENABLE_OFF_ROUTE_DETECTION, val enableFasterRouteDetection: Boolean = Defaults.ENABLE_FASTER_ROUTE_DETECTION, val manuallyEndNavigationUponCompletion: Boolean = Defaults.MANUALLY_END_NAVIGATION_UPON_COMPLETION, val metersRemainingTillArrival: Double = Defaults.METERS_REMAINING_TILL_ARRIVAL, val offRouteMinimumDistanceMetersAfterReroute: Double = Defaults.OFF_ROUTE_MINIMUM_DISTANCE_METERS_AFTER_REROUTE, val offRouteThresholdRadiusMeters: Double = Defaults.OFF_ROUTE_THRESHOLD_RADIUS_METERS, val offRouteMinimumDistanceMetersBeforeWrongDirection: Double = Defaults.OFF_ROUTE_MINIMUM_DISTANCE_METERS_BEFORE_WRONG_DIRECTION, val offRouteMinimumDistanceMetersBeforeRightDirection: Double = Defaults.OFF_ROUTE_MINIMUM_DISTANCE_METERS_BEFORE_RIGHT_DIRECTION, val isDebugLoggingEnabled: Boolean = Defaults.IS_DEBUG_LOGGING_ENABLED, val roundingIncrement: MapLibreNavigationOptions.RoundingIncrement = Defaults.roundingIncrement, val timeFormatType: MapLibreNavigationOptions.TimeFormat = TimeFormat.NONE_SPECIFIED, val locationAcceptableAccuracyInMetersThreshold: Int = Defaults.LOCATION_ACCEPTABLE_ACCURACY_IN_METERS_THRESHOLD, val fasterRouteCheckIntervalSeconds: Int = Defaults.FASTER_ROUTE_CHECK_INTERVAL_SECONDS)
Immutable and can't be changed after passing into MapLibreNavigation.
Link copied to clipboard
object NavigationConstants
Navigation constants
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
open class NavigationFasterRouteListener(eventDispatcher: NavigationEventDispatcher, fasterRouteEngine: FasterRoute) : RouteListener
Link copied to clipboard
object NavigationHelper
This contains several single purpose methods that help out when a new location update occurs and calculations need to be performed on it.
Link copied to clipboard
Link copied to clipboard
data class NavigationLocationUpdate(val location: Location, val mapLibreNavigation: MapLibreNavigation)
Link copied to clipboard