MMKDrivingRoute
- Summary
- Instance methods
- Properties
- routeId
- metadata
- sections
- geometry
- jamSegments
- events
- speedLimits
- vehicleOptions
- laneSigns
- directionSigns
- restrictedEntries
- trafficLights
- restrictedTurns
- railwayCrossings
- pedestrianCrossings
- speedBumps
- checkpoints
- ruggedRoads
- tollRoads
- fordCrossings
- ferries
- highways
- tunnels
- zoneCrossings
- roadVehicleRestrictions
- manoeuvreVehicleRestrictions
- annotationLanguage
- requestPoints
- position
- routePosition
- legIndex
- isAreConditionsOutdated
- wayPoints
Warning
This feature is available in the Full MapKit SDK version
|
class MMKDrivingRoute : NSObject |
Driving route. A route consists of multiple sections. Each section has a corresponding annotation that describes the action at the beginning of the section.
Summary
Instance methods
|
func addConditionsListener(with conditionsListener: any MMKDrivingConditionsListener) |
|
func removeConditionsListener(with conditionsListener: any MMKDrivingConditionsListener) |
|
func sectionIndex(withSegmentIndex segmentIndex: UInt) -> UInt |
|
func metadataAt(with position: MMKPolylinePosition) -> MMKDrivingRouteMetadata |
|
func requestConditionsUpdate() |
Properties
|
var routeId: String { get } |
|
var metadata: MMKDrivingRouteMetadata { get } |
|
var sections: [MMKDrivingSection] { get } |
|
var geometry: MMKPolyline { get } |
|
var jamSegments: [MMKJamSegment] { get } |
|
var events: [MMKDrivingEvent] { get } |
|
var speedLimits: [NSNumber] { get } |
|
var vehicleOptions: MMKDrivingVehicleOptions { get } |
|
var laneSigns: [MMKDrivingLaneSign] { get } |
|
var directionSigns: [MMKDrivingDirectionSign] { get } |
|
var restrictedEntries: [MMKDrivingRestrictedEntry] { get } |
|
var trafficLights: [MMKDrivingTrafficLight] { get } |
|
var restrictedTurns: [MMKDrivingRestrictedTurn] { get } |
|
var railwayCrossings: [MMKDrivingRailwayCrossing] { get } |
|
var pedestrianCrossings: [MMKDrivingPedestrianCrossing] { get } |
|
var speedBumps: [MMKDrivingSpeedBump] { get } |
|
var checkpoints: [MMKDrivingCheckpoint] { get } |
|
var ruggedRoads: [MMKDrivingRuggedRoad] { get } |
|
var tollRoads: [MMKDrivingTollRoad] { get } |
|
var fordCrossings: [MMKDrivingFordCrossing] { get } |
|
var ferries: [MMKDrivingFerry] { get } |
|
var highways: [MMKDrivingHighway] { get } |
|
var tunnels: [MMKDrivingTunnel] { get } |
|
var zoneCrossings: [MMKDrivingZoneCrossing] { get } |
|
var roadVehicleRestrictions: [MMKDrivingRoadVehicleRestriction] { get } |
|
var manoeuvreVehicleRestrictions: [MMKDrivingManoeuvreVehicleRestriction] { get } |
|
var annotationLanguage: NSNumber? { get } |
|
var requestPoints: [MMKRequestPoint]? { get } |
|
var position: MMKPolylinePosition { get set } |
|
var routePosition: MMKRoutePosition { get } |
|
var legIndex: UInt { get set } |
|
var isAreConditionsOutdated: Bool { get } |
|
var wayPoints: [MMKPolylinePosition] { get } |
Instance methods
addConditionsListener(with:)
|
func addConditionsListener(with conditionsListener: any MMKDrivingConditionsListener) |
Adds a listener for route condition changes.
The class does not retain the object in the 'conditionsListener' parameter. It is your responsibility to maintain a strong reference to the target object while it is attached to a class.
removeConditionsListener(with:)
|
func removeConditionsListener(with conditionsListener: any MMKDrivingConditionsListener) |
Removes the listener for route condition changes.
The class does not retain the object in the 'conditionsListener' parameter. It is your responsibility to maintain a strong reference to the target object while it is attached to a class.
sectionIndex(withSegmentIndex:)
|
func sectionIndex(withSegmentIndex segmentIndex: UInt) -> UInt |
Section index.
metadataAt(with:)
|
func metadataAt(with position: MMKPolylinePosition) -> MMKDrivingRouteMetadata |
Metadata location.
requestConditionsUpdate()
|
func requestConditionsUpdate() |
Properties
routeId
|
var routeId: String { get } |
The ID of the route.
metadata
|
var metadata: MMKDrivingRouteMetadata { get } |
The route metadata.
sections
|
var sections: [MMKDrivingSection] { get } |
Manoeuvre-to-Manoeuvre route sections.
geometry
|
var geometry: MMKPolyline { get } |
Route geometry.
jamSegments
|
var jamSegments: [MMKJamSegment] { get } |
Traffic conditions on the given route.
events
|
var events: [MMKDrivingEvent] { get } |
Events on the given route.
speedLimits
|
var speedLimits: [NSNumber] { get } |
Speed limits for segments in the geometry.
vehicleOptions
|
var vehicleOptions: MMKDrivingVehicleOptions { get } |
Vehicle options.
laneSigns
|
var laneSigns: [MMKDrivingLaneSign] { get } |
Lane signs.
directionSigns
|
var directionSigns: [MMKDrivingDirectionSign] { get } |
Direction signs.
restrictedEntries
|
var restrictedEntries: [MMKDrivingRestrictedEntry] { get } |
Route restricted entries.
trafficLights
|
var trafficLights: [MMKDrivingTrafficLight] { get } |
Route traffic lights.
restrictedTurns
|
var restrictedTurns: [MMKDrivingRestrictedTurn] { get } |
Route points with time-dependent restrictions.
railwayCrossings
|
var railwayCrossings: [MMKDrivingRailwayCrossing] { get } |
Railway crossings
pedestrianCrossings
|
var pedestrianCrossings: [MMKDrivingPedestrianCrossing] { get } |
Pedestrian crossings
speedBumps
|
var speedBumps: [MMKDrivingSpeedBump] { get } |
Speed bumps
checkpoints
|
var checkpoints: [MMKDrivingCheckpoint] { get } |
Checkpoints
ruggedRoads
|
var ruggedRoads: [MMKDrivingRuggedRoad] { get } |
Route roads.
tollRoads
|
var tollRoads: [MMKDrivingTollRoad] { get } |
fordCrossings
|
var fordCrossings: [MMKDrivingFordCrossing] { get } |
ferries
|
var ferries: [MMKDrivingFerry] { get } |
highways
|
var highways: [MMKDrivingHighway] { get } |
tunnels
|
var tunnels: [MMKDrivingTunnel] { get } |
zoneCrossings
|
var zoneCrossings: [MMKDrivingZoneCrossing] { get } |
roadVehicleRestrictions
|
var roadVehicleRestrictions: [MMKDrivingRoadVehicleRestriction] { get } |
Route vehicle restrictions.
manoeuvreVehicleRestrictions
|
var manoeuvreVehicleRestrictions: [MMKDrivingManoeuvreVehicleRestriction] { get } |
annotationLanguage
|
var annotationLanguage: NSNumber? { get } |
Language of string annotations (for example street names) in this route object.
Optional property, can be nil.
requestPoints
|
var requestPoints: [MMKRequestPoint]? { get } |
Request points that were specified in the router request that this route originated from.
Optional property, can be nil.
position
|
var position: MMKPolylinePosition { get set } |
The reached position on the given route. The 'RouteMetadata::weight' field contains data for the part of the route beyond this position.
routePosition
|
var routePosition: MMKRoutePosition { get } |
The reached position on the given route. The 'RouteMetadata::weight' field contains data for the part of the route beyond this position.
legIndex
|
var legIndex: UInt { get set } |
A leg is a section of the route between two consecutive waypoints.
isAreConditionsOutdated
|
var isAreConditionsOutdated: Bool { get } |
Indicates whether driving conditions (jamSegments and events) have become outdated when we are not able to fetch updates for some predefined time.
wayPoints
|
var wayPoints: [MMKPolylinePosition] { get } |
Polyline positions of waypoints including start and finish point.