sdk/com.sygic.sdk.route/Route

Route

open class Route : BaseNativeParcelable

Collection of maneuvers and roadElements connecting two or more waypoints. Waypoints may be thought of as the input to a route calculation whereas maneuvers are the results of calculating a route.

Functions

Link copied to clipboard
open fun describeContents(): Int
For documentation, see android.os.Parcelable.
Link copied to clipboard
@Nullable
open fun deserializeFromFullJSON(@NonNull json: String): Route
Deserialize route from json generated with serializeToFullJSON.
Link copied to clipboard
open fun destroy()
Link copied to clipboard
open fun equals(o: Any): Boolean
Link copied to clipboard
@NonNull
open fun getBoundingBox(): GeoBoundingBox
The smallest GeoBoundingBox that contains the entire route.
Link copied to clipboard
@NonNull
open fun getDestination(): Waypoint
Returns the destination waypoint of the route
Link copied to clipboard
@NonNull
open fun getManeuvers(): List<RouteManeuver>
Returns an array of directions for current route object from start.
Link copied to clipboard
Link copied to clipboard
@Nullable
open fun getPolylinesFromRouteSegments(routeSegments: List<RouteSegment>): List<GeoPolyline>
Returns list of GeoPolylines representing route segments
Link copied to clipboard
open fun getRouteElements(@NonNull listener: RouteElementsListener)

open fun getRouteElements(@NonNull listener: RouteElementsListener, @Nullable executor: Executor)
Returns a list of RouteElement objects for current route object from start.
Link copied to clipboard
@Nullable
open fun getRouteGeometry(): List<GeoCoordinates>
Returns list of coordinates representing route geometry
open fun getRouteGeometry(withAltitude: Boolean, @NonNull listener: GeometryListener)
open fun getRouteGeometry(withAltitude: Boolean, @NonNull listener: GeometryListener, @Nullable executor: Executor)
Returns geometry with altitude of route.
Link copied to clipboard
open fun getRouteId(): Int
Returns the unique id identifies the route.
Link copied to clipboard
@NonNull
open fun getRouteInfo(): RouteInfo
Returns basic route info.
Link copied to clipboard
@NonNull
open fun getRouteRequest(): RouteRequest
Returns options used for computing this route.
Link copied to clipboard
open fun getRouteWarnings(@NonNull listener: RouteWarningsListener)
open fun getRouteWarnings(@NonNull listener: RouteWarningsListener, @Nullable executor: Executor)
Returns a list of RouteWarning warnings, which occurred during route calculation.
Link copied to clipboard
@NonNull
open fun getStart(): Waypoint
Returns the starting waypoint of the route
Link copied to clipboard
@NonNull
open fun getTransitCountries(): List<String>
Returns list of countries route is passing by
Link copied to clipboard
open fun getTransitCountriesInfo(@NonNull listener: TransitCountriesInfoListener)
open fun getTransitCountriesInfo(@NonNull listener: TransitCountriesInfoListener, @Nullable executor: Executor)
Retrieves list of countries route is passing by with regions, if available
Link copied to clipboard
@NonNull
open fun getWaypoints(): List<Waypoint>
List of Waypoints on the route including starting point and destination.
Link copied to clipboard
open fun hashCode(): Int
Link copied to clipboard
open fun isValidParcelable(): Boolean
If object after recreate from parcel contains all of reference like original object method return true.
Link copied to clipboard
open fun serializeToBriefJSON(): String
Serialize the route to a JSON string.
Link copied to clipboard
open fun serializeToFullJSON(): String
Serialize the route to a JSON string.
Link copied to clipboard
open fun writeToParcel(dest: Parcel, flags: Int)
For documentation, see android.os.Parcelable.writeToParcel().

Properties

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard