RouteInstructionObject

Objective-C


@interface RouteInstructionObject : NSObject

Swift

class RouteInstructionObject : NSObject

This class encapsulates route instruction information.

  • Initializes and returns a newly allocated object using the model data.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithModelData:(nonnull void *)data;

  • Returns the model data.

    Declaration

    Objective-C

    - (nonnull void *)getModelData;

  • Returns true if signpost information is available.

    Declaration

    Objective-C

    - (BOOL)hasSignpostInfo;

    Swift

    func hasSignpostInfo() -> Bool

  • Returns extended signpost details.

    Declaration

    Objective-C

    - (nullable SignpostDetailsObject *)getSignpostDetails;

    Swift

    func getSignpostDetails() -> SignpostDetailsObject?

  • Returns the textual description for the signpost information.

    Declaration

    Objective-C

    - (nonnull NSString *)getSignpostInstruction;

    Swift

    func getSignpostInstruction() -> String

  • Returns the distance to the next turn in meters, time in seconds.

    Declaration

    Objective-C

    - (nullable TimeDistanceObject *)getTimeDistanceToNextTurn;

    Swift

    func getTimeDistanceToNextTurn() -> TimeDistanceObject?

  • Returns the remaining travel distance in meters and remaining traveling time in seconds.

    Declaration

    Objective-C

    - (nullable TimeDistanceObject *)getRemainingTravelTimeDistance;

    Swift

    func getRemainingTravelTimeDistance() -> TimeDistanceObject?

  • Returns the remaining traveling time in seconds to the next way point.

    Declaration

    Objective-C

    - (nullable TimeDistanceObject *)getRemainingTravelTimeDistanceToNextWaypoint;

    Swift

    func getRemainingTravelTimeDistanceToNextWaypoint() -> TimeDistanceObject?

  • Returns the traveled distance in meters and the traveled time in seconds.

    Declaration

    Objective-C

    - (nullable TimeDistanceObject *)getTraveledTimeDistance;

    Swift

    func getTraveledTimeDistance() -> TimeDistanceObject?

  • Returns the ISO 3166-1 alpha-3 country code for the navigation instruction. @details Empty string means no country. See: http://en.wikipedia.org/wiki/ISO_3166-1 for the list of codes.

    Declaration

    Objective-C

    - (nonnull NSString *)getCountryCodeISO;

    Swift

    func getCountryCodeISO() -> String

  • Returns true if turn information is available.

    Declaration

    Objective-C

    - (BOOL)hasTurnInfo;

    Swift

    func hasTurnInfo() -> Bool

  • Returns the image for the turn.

    Declaration

    Objective-C

    - (nullable UIImage *)getTurnImage:(CGSize)size;

    Swift

    func getTurnImage(_ size: CGSize) -> UIImage?

    Parameters

    size

    The image size.

  • Returns the full details for the turn.

    Declaration

    Objective-C

    - (nullable TurnDetailsObject *)getTurnDetails;

    Swift

    func getTurnDetails() -> TurnDetailsObject?

  • Returns the textual description for the turn.

    Declaration

    Objective-C

    - (nonnull NSString *)getTurnInstruction;

    Swift

    func getTurnInstruction() -> String

  • Returns true if follow road information is available.

    Declaration

    Objective-C

    - (BOOL)hasFollowRoadInfo;

    Swift

    func hasFollowRoadInfo() -> Bool

  • Returns the textual description for the follow road information.

    Declaration

    Objective-C

    - (nonnull NSString *)getFollowRoadInstruction;

    Swift

    func getFollowRoadInstruction() -> String

  • Get if road information is available.

    Declaration

    Objective-C

    - (BOOL)hasRoadInfo;

    Swift

    func hasRoadInfo() -> Bool

  • Get road information. @details The road info list is in ascending priority order.

    Declaration

    Objective-C

    - (nonnull NSArray<RoadInfoObject *> *)getRoadInfo;

    Swift

    func getRoadInfo() -> [RoadInfoObject]

  • Get road info image.

    Declaration

    Objective-C

    - (nullable UIImage *)getRoadInfoImage:(CGSize)size;

    Swift

    func getRoadInfoImage(_ size: CGSize) -> UIImage?

    Parameters

    size

    The image size in pixels.

  • Get road info image.

    Declaration

    Objective-C

    - (nullable UIImage *)getRoadInfoImage:(CGSize)size
                                 scale:(CGFloat)scale
                                   ppi:(NSInteger)ppi;

    Swift

    func getRoadInfoImage(_ size: CGSize, scale: CGFloat, ppi: Int) -> UIImage?

    Parameters

    size

    The image size in pixels.
    scale

    The screen scale factor.
    ppi

    The screen pixel per inch.

  • Returns the coordinates for this route instruction.

    Declaration

    Objective-C

    - (nonnull CoordinatesObject *)getCoordinates;

    Swift

    func getCoordinates() -> CoordinatesObject

  • Returns true if the route instruction is a main road exit instruction.

    Declaration

    Objective-C

    - (BOOL)isExit;

    Swift

    func isExit() -> Bool

  • Returns the exit route instruction text. @details If the instruction is not an exit, returns empty string.

    Declaration

    Objective-C

    - (nonnull NSString *)getExitDetails;

    Swift

    func getExitDetails() -> String

  • Returns true if the route instruction is a ferry.

    Declaration

    Objective-C

    - (BOOL)isFerry;

    Swift

    func isFerry() -> Bool

  • Returns true if the route instruction is a toll road.

    Declaration

    Objective-C

    - (BOOL)isTollRoad;

    Swift

    func isTollRoad() -> Bool

  • Check if this instruction is of common type. @details Common type route instruction is part of a common type route segment, see RouteSegmentObject::isCommon.

    Declaration

    Objective-C

    - (BOOL)isCommon;

    Swift

    func isCommon() -> Bool

  • Check if this instruction is part of an EV route.

    Declaration

    Objective-C

    - (BOOL)isEV;

    Swift

    func isEV() -> Bool