MMKGuidance

Warning

This feature is available in the NaviKit SDK version.

@interface MMKGuidance : NSObject

Summary

Instance methods

- (void)switchToRouteWithRoute:(nonnull MMKDrivingRoute *)route;
Start guidance with given alternative

- (void)addListenerWithGuidanceListener:
    (nonnull id<MMKGuidanceListener>)guidanceListener;
The class does not retain the object in the 'guidanceListener' parameter

- (void)removeListenerWithGuidanceListener:
    (nonnull id<MMKGuidanceListener>)guidanceListener;

Properties

@property (nonatomic, assign, unsafe_unretained, readwrite,
          getter=isEnableAlternatives) BOOL enableAlternatives;
Enables/Disables alternatives suggestion while guiding

@property (nonatomic, assign, unsafe_unretained, readwrite,
          getter=isEnableReroutes) BOOL enableReroutes;
Enables/Disables rerouting

@property (nonatomic, readonly, nonnull) MMKNavigationWindshield *windshield;

@property (nonatomic, readonly, nonnull) MMKAnnotator *annotator;

@property (nonatomic, readonly, nullable) MMKDrivingRoute *currentRoute;
Optional property, can be nil

@property (nonatomic, readonly, nonnull)
    NSArray<MMKNavigationAlternative *> *alternatives;
Vector with all alternatives ahead

@property (nonatomic, readonly, nullable)
    MMKNavigationAlternative *fastestAlternative;
Optional property, can be nil

@property (nonatomic, readonly, nullable) MMKLocation *location;
Optional property, can be nil

@property (nonatomic, readonly, nullable) NSNumber *locationClass;
Optional property, can be nil

@property (nonatomic, readonly, nullable) NSString *roadName;
Optional property, can be nil

@property (nonatomic, readonly) MMKRouteStatus routeStatus;

@property (nonatomic, readonly, nonnull) MMKSpeedLimitsPolicy *speedLimitsPolicy;
In case region is not yet available, SpeedingPolicy::region is empty and default speeding config is used

@property (nonatomic, assign, unsafe_unretained, readwrite)
    double speedLimitTolerance;

@property (nonatomic, readonly, nullable) MMKLocalizedValue *speedLimit;
Speed limit of the current road

@property (nonatomic, readonly) MMKSpeedLimitStatus speedLimitStatus;

@property (nonatomic, readonly, getter=isValid) BOOL valid;
Tells if this object is valid or no

Instance methods

switchToRouteWithRoute:

- (void)switchToRouteWithRoute:(nonnull MMKDrivingRoute *)route;

Start guidance with given alternative. It only accepts routes obtained from this Guidance.routes field.


addListenerWithGuidanceListener:

- (void)addListenerWithGuidanceListener:
    (nonnull id<MMKGuidanceListener>)guidanceListener;

The class does not retain the object in the 'guidanceListener' parameter. It is your responsibility to maintain a strong reference to the target object while it is attached to a class.


removeListenerWithGuidanceListener:

- (void)removeListenerWithGuidanceListener:
    (nonnull id<MMKGuidanceListener>)guidanceListener;

Properties

enableAlternatives

@property (nonatomic, assign, unsafe_unretained, readwrite,
          getter=isEnableAlternatives) BOOL enableAlternatives;

Enables/Disables alternatives suggestion while guiding. Enabled by default.


enableReroutes

@property (nonatomic, assign, unsafe_unretained, readwrite,
          getter=isEnableReroutes) BOOL enableReroutes;

Enables/Disables rerouting. Enabled by default.


windshield

@property (nonatomic, readonly, nonnull) MMKNavigationWindshield *windshield;

annotator

@property (nonatomic, readonly, nonnull) MMKAnnotator *annotator;

currentRoute

@property (nonatomic, readonly, nullable) MMKDrivingRoute *currentRoute;

Optional property, can be nil.


alternatives

@property (nonatomic, readonly, nonnull)
    NSArray<MMKNavigationAlternative *> *alternatives;

Vector with all alternatives ahead. Sorted by distance.


fastestAlternative

@property (nonatomic, readonly, nullable)
    MMKNavigationAlternative *fastestAlternative;

Optional property, can be nil.


location

@property (nonatomic, readonly, nullable) MMKLocation *location;

Optional property, can be nil.


locationClass

@property (nonatomic, readonly, nullable) NSNumber *locationClass;

Optional property, can be nil.


roadName

@property (nonatomic, readonly, nullable) NSString *roadName;

Optional property, can be nil.


routeStatus

@property (nonatomic, readonly) MMKRouteStatus routeStatus;

speedLimitsPolicy

@property (nonatomic, readonly, nonnull) MMKSpeedLimitsPolicy *speedLimitsPolicy;

In case region is not yet available, SpeedingPolicy::region is empty and default speeding config is used.


speedLimitTolerance

@property (nonatomic, assign, unsafe_unretained, readwrite)
    double speedLimitTolerance;

speedLimit

@property (nonatomic, readonly, nullable) MMKLocalizedValue *speedLimit;

Speed limit of the current road.

Optional property, can be nil.


speedLimitStatus

@property (nonatomic, readonly) MMKSpeedLimitStatus speedLimitStatus;

valid

@property (nonatomic, readonly, getter=isValid) BOOL valid;

Tells if this object is valid or no. Any method called on an invalid object will throw an exception. The object becomes invalid only on UI thread, and only when its implementation depends on objects already destroyed by now. Please refer to general docs about the interface for details on its invalidation.


Previous
MMKGeometry
Next
MMKHistoricalPanorama