Route topic

Inspect and manage navigable routes for mapping and turn-by-turn navigation. This module provides route models, segment and instruction objects, terrain and elevation helpers, and persistent bookmarks so apps can calculate routes, present turn‑by‑turn guidance, analyze terrain, and store/recall saved routes for later use.

• RouteBase: Abstract surface shared by concrete route implementations. Use this to access common route analysis helpers such as sampling coordinates, exporting route data, and querying geometry or metrics across route types.
• Route: Represents a computed navigable route produced by the routing engine. Use this class as the primary route model when presenting geometry, metrics and metadata to users; it aggregates segments, instructions, waypoints and traffic information needed for rendering and navigation.
• RouteSegment: A contiguous portion of a route between two waypoints. Segments contain geometry, time/distance metrics and an ordered list of instructions used for UI displays and analysis.
• RouteInstruction: A single maneuver or guidance step inside a segment. Instructions carry localized text, signpost and turn imagery, and time/distance metadata for building instruction lists and map centering.
• OTRoute: Over‑track route variant backed by a detailed track. Use this when you need precise path representation rather than only routes calculated based on waypoints.
• PTRoute: Public‑transport specific route representation exposing transit metadata like fares, frequency and ticket information.
• PTRouteSegment: Public‑transport segment type with transit-specific metadata such as platform, agency and schedule cues for presenting trip details.
• PTRouteInstruction: Instruction variant for public transport segments carrying platform and schedule details.
• RouteTerrainProfile: Terrain and elevation model for a route. Provides elevation samples, climb and steep sections, surface and road‑type sections to support elevation-aware rendering and measurements.
• TimeDistanceCoordinate: Timestamped coordinate with associated distance from an origin.
• RouteBookmarks: Persistent collection for saved routes (bookmarks). Use this to store, import, export and manage named route entries for reuse by users.
• RouteListener: Event listener for route-related runtime events. Attach to a route to receive asynchronous notifications about traffic updates and route diagnostics.
• SignpostDetails: Structured signpost rendering and semantic details returned by instructions; contains color hints, rendered imagery and a list of semantic signpost items.
• SignpostItem: A semantic element of a signpost such as text fragments, pictograms or shields; used by signpost rendering and accessibility features.

Route components form a clear workflow: compute routes with the routing service, inspect Route instances for segments and instructions, sample coordinates or terrain when needed, and attach listeners or persist favorites using the bookmarks API. Together these pieces provide the data and events required for map rendering, turn‑by‑turn navigation and transit-aware experiences.

Learn more about routes: https://developer.magiclane.com/docs/flutter/guides/core/routes