- 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
- areConditionsOutdated
- wayPoints
Warning
This feature is available in the Full MapKit SDK version
MMKDrivingRoute
@interface 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
- (void)addConditionsListenerWithConditionsListener: |
- (void)removeConditionsListenerWithConditionsListener: |
- (NSUInteger)sectionIndexWithSegmentIndex:(NSUInteger)segmentIndex; |
- (nonnull MMKDrivingRouteMetadata *)metadataAtWithPosition: |
- (void)requestConditionsUpdate; |
Properties
@property (nonatomic, readonly, nonnull) NSString *routeId; |
@property (nonatomic, readonly, nonnull) MMKDrivingRouteMetadata *metadata; |
@property (nonatomic, readonly, nonnull) NSArray<MMKDrivingSection *> *sections; |
@property (nonatomic, readonly, nonnull) MMKPolyline *geometry; |
@property (nonatomic, readonly, nonnull) NSArray<MMKJamSegment *> *jamSegments; |
@property (nonatomic, readonly, nonnull) NSArray<MMKDrivingEvent *> *events; |
@property (nonatomic, readonly, nonnull) NSArray<NSNumber *> *speedLimits; |
@property (nonatomic, readonly, nonnull) |
@property (nonatomic, readonly, nonnull) |
@property (nonatomic, readonly, nonnull) |
@property (nonatomic, readonly, nonnull) |
@property (nonatomic, readonly, nonnull) |
@property (nonatomic, readonly, nonnull) |
@property (nonatomic, readonly, nonnull) |
@property (nonatomic, readonly, nonnull) |
@property (nonatomic, readonly, nonnull) |
@property (nonatomic, readonly, nonnull) |
@property (nonatomic, readonly, nonnull) |
@property (nonatomic, readonly, nonnull) |
@property (nonatomic, readonly, nonnull) |
@property (nonatomic, readonly, nonnull) NSArray<MMKDrivingFerry *> *ferries; |
@property (nonatomic, readonly, nonnull) NSArray<MMKDrivingHighway *> *highways; |
@property (nonatomic, readonly, nonnull) NSArray<MMKDrivingTunnel *> *tunnels; |
@property (nonatomic, readonly, nonnull) |
@property (nonatomic, readonly, nonnull) |
@property (nonatomic, readonly, nonnull) |
@property (nonatomic, readonly, nullable) NSNumber *annotationLanguage; |
@property (nonatomic, readonly, nullable) |
@property (nonatomic, assign, unsafe_unretained, readwrite, nonnull) |
@property (nonatomic, readonly, nonnull) MMKRoutePosition *routePosition; |
@property (nonatomic, assign, unsafe_unretained, readwrite) NSUInteger legIndex; |
@property (nonatomic, readonly, getter=isAreConditionsOutdated) |
@property (nonatomic, readonly, nonnull) |
Instance methods
addConditionsListenerWithConditionsListener:
- (void)addConditionsListenerWithConditionsListener: |
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.
removeConditionsListenerWithConditionsListener:
- (void)removeConditionsListenerWithConditionsListener: |
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.
sectionIndexWithSegmentIndex:
- (NSUInteger)sectionIndexWithSegmentIndex:(NSUInteger)segmentIndex; |
Section index.
metadataAtWithPosition:
- (nonnull MMKDrivingRouteMetadata *)metadataAtWithPosition: |
Metadata location.
requestConditionsUpdate
- (void)requestConditionsUpdate; |
Undocumented
Properties
routeId
@property (nonatomic, readonly, nonnull) NSString *routeId; |
The ID of the route.
metadata
@property (nonatomic, readonly, nonnull) MMKDrivingRouteMetadata *metadata; |
The route metadata.
sections
@property (nonatomic, readonly, nonnull) NSArray<MMKDrivingSection *> *sections; |
Manoeuvre-to-Manoeuvre route sections.
geometry
@property (nonatomic, readonly, nonnull) MMKPolyline *geometry; |
Route geometry.
jamSegments
@property (nonatomic, readonly, nonnull) NSArray<MMKJamSegment *> *jamSegments; |
Traffic conditions on the given route.
events
@property (nonatomic, readonly, nonnull) NSArray<MMKDrivingEvent *> *events; |
Events on the given route.
speedLimits
@property (nonatomic, readonly, nonnull) NSArray<NSNumber *> *speedLimits; |
Speed limits for segments in the geometry.
vehicleOptions
@property (nonatomic, readonly, nonnull) |
Vehicle options.
laneSigns
@property (nonatomic, readonly, nonnull) |
Lane signs.
directionSigns
@property (nonatomic, readonly, nonnull) |
Direction signs.
restrictedEntries
@property (nonatomic, readonly, nonnull) |
Route restricted entries.
trafficLights
@property (nonatomic, readonly, nonnull) |
Route traffic lights.
restrictedTurns
@property (nonatomic, readonly, nonnull) |
Route points with time-dependent restrictions.
railwayCrossings
@property (nonatomic, readonly, nonnull) |
Railway crossings
pedestrianCrossings
@property (nonatomic, readonly, nonnull) |
Pedestrian crossings
speedBumps
@property (nonatomic, readonly, nonnull) |
Speed bumps
checkpoints
@property (nonatomic, readonly, nonnull) |
Checkpoints
ruggedRoads
@property (nonatomic, readonly, nonnull) |
Route roads.
tollRoads
@property (nonatomic, readonly, nonnull) |
Undocumented
fordCrossings
@property (nonatomic, readonly, nonnull) |
Undocumented
ferries
@property (nonatomic, readonly, nonnull) NSArray<MMKDrivingFerry *> *ferries; |
Undocumented
highways
@property (nonatomic, readonly, nonnull) NSArray<MMKDrivingHighway *> *highways; |
Undocumented
tunnels
@property (nonatomic, readonly, nonnull) NSArray<MMKDrivingTunnel *> *tunnels; |
Undocumented
zoneCrossings
@property (nonatomic, readonly, nonnull) |
Undocumented
roadVehicleRestrictions
@property (nonatomic, readonly, nonnull) |
Route vehicle restrictions.
manoeuvreVehicleRestrictions
@property (nonatomic, readonly, nonnull) |
Undocumented
annotationLanguage
@property (nonatomic, readonly, nullable) NSNumber *annotationLanguage; |
Language of string annotations (for example street names) in this route object.
Optional property, can be nil.
requestPoints
@property (nonatomic, readonly, nullable) |
Request points that were specified in the router request that this route originated from.
Optional property, can be nil.
position
@property (nonatomic, assign, unsafe_unretained, readwrite, nonnull) |
The reached position on the given route. The 'RouteMetadata::weight' field contains data for the part of the route beyond this position.
routePosition
@property (nonatomic, readonly, nonnull) MMKRoutePosition *routePosition; |
The reached position on the given route. The 'RouteMetadata::weight' field contains data for the part of the route beyond this position.
legIndex
@property (nonatomic, assign, unsafe_unretained, readwrite) NSUInteger legIndex; |
A leg is a section of the route between two consecutive waypoints.
areConditionsOutdated
@property (nonatomic, readonly, getter=isAreConditionsOutdated) |
Indicates whether driving conditions (jamSegments and events) have become outdated when we are not able to fetch updates for some predefined time.
wayPoints
@property (nonatomic, readonly, nonnull) |
Polyline positions of waypoints including start and finish point.