NavigationInstructionObject

Objective-C


@interface NavigationInstructionObject : NSObject

Swift

class NavigationInstructionObject : NSObject

This class encapsulates navigation 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 the 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 signpost image.

    Declaration

    Objective-C

    - (nullable UIImage *)getSignpostImage:(CGSize)size
                                border:(NSInteger)border
                          roundCorners:(BOOL)round
                                  rows:(NSInteger)rows;

    Swift

    func getSignpostImage(_ size: CGSize, border: Int, roundCorners round: Bool, rows: Int) -> UIImage?

    Parameters

    size

    The image size in pixels.
    border

    The border size in pixels.
    roundCorners

    Set true for rounded corners.
    rows

    The maximum rows of details in the signpost.

  • Returns the signpost image.

    Declaration

    Objective-C

    - (nullable UIImage *)getSignpostImage:(CGSize)size
                                 scale:(CGFloat)scale
                                   ppi:(NSInteger)ppi
                                border:(NSInteger)border
                          roundCorners:(BOOL)round
                                  rows:(NSInteger)rows;

    Swift

    func getSignpostImage(_ size: CGSize, scale: CGFloat, ppi: Int, border: Int, roundCorners round: Bool, rows: Int) -> UIImage?

    Parameters

    size

    The image size in pixels.
    scale

    The screen scale factor.
    ppi

    The screen pixel per inch.
    border

    The border size in pixels.
    roundCorners

    Set true for rounded corners.
    rows

    The maximum rows of details in the signpost.

  • 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 and the remaining travel distance in meters 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 navigation/simulation status.

    Declaration

    Objective-C

    - (NavigationStatus)getNavigationStatus;

    Swift

    func getNavigationStatus() -> NavigationStatus

  • Returns the ISO 3166-1 alpha-3 country code for the current navigation instruction. @details Empty string means no country.

    Declaration

    Objective-C

    - (nonnull NSString *)getCurrentCountryCodeISO;

    Swift

    func getCurrentCountryCodeISO() -> String

  • Returns the maximum speed limit on the current street in meters per second.

    Declaration

    Objective-C

    - (double)getCurrentStreetSpeedLimit;

    Swift

    func getCurrentStreetSpeedLimit() -> Double

    Return Value

    0 if maximum speed limit is not available.

  • Returns the current street name.

    Declaration

    Objective-C

    - (nonnull NSString *)getCurrentStreetName;

    Swift

    func getCurrentStreetName() -> String

  • Returns the current road information.

    Declaration

    Objective-C

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

    Swift

    func getCurrentRoadInformation() -> [RoadInfoObject]

  • Returns true if current road info is available.

    Declaration

    Objective-C

    - (BOOL)hasCurrentRoadInfo;

    Swift

    func hasCurrentRoadInfo() -> Bool

  • Returns the current road code image.

    Declaration

    Objective-C

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

    Swift

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

    Parameters

    size

    The image size in pixels.

  • Returns the current road code image(s).

    Declaration

    Objective-C

    - (nullable UIImage *)getCurrentRoadCodeImage:(CGSize)size limit:(int)limit;

    Swift

    func getCurrentRoadCodeImage(_ size: CGSize, limit: Int32) -> UIImage?

    Parameters

    size

    The image size in pixels.
    limit

    The limit number of images. Use 0 to get all the available images.

  • Returns the current road code image.

    Declaration

    Objective-C

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

    Swift

    func getCurrentRoadCodeImage(_ 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 current road code image(s).

    Declaration

    Objective-C

    - (nullable UIImage *)getCurrentRoadCodeImage:(CGSize)size
                                        scale:(CGFloat)scale
                                          ppi:(NSInteger)ppi
                                        limit:(int)limit;

    Swift

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

    Parameters

    size

    The image size in pixels.
    scale

    The screen scale factor.
    ppi

    The screen pixel per inch.
    limit

    The limit number of images. Use 0 to get all the available images.

  • Returns the ISO 3166-1 alpha-3 country code for the next navigation instruction. @details Empty string means no country.

    Declaration

    Objective-C

    - (nonnull NSString *)getNextCountryCodeISO;

    Swift

    func getNextCountryCodeISO() -> String

  • Returns the next street name.

    Declaration

    Objective-C

    - (nonnull NSString *)getNextStreetName;

    Swift

    func getNextStreetName() -> String

  • Returns the next road information.

    Declaration

    Objective-C

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

    Swift

    func getNextRoadInformation() -> [RoadInfoObject]

  • Returns true if next road info is available.

    Declaration

    Objective-C

    - (BOOL)hasNextRoadInfo;

    Swift

    func hasNextRoadInfo() -> Bool

  • Returns the next road code image.

    Declaration

    Objective-C

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

    Swift

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

    Parameters

    size

    The image size.

  • Returns the next road code image(s).

    Declaration

    Objective-C

    - (nullable UIImage *)getNextRoadCodeImage:(CGSize)size limit:(int)limit;

    Swift

    func getNextRoadCodeImage(_ size: CGSize, limit: Int32) -> UIImage?

    Parameters

    size

    The image size.
    limit

    The limit number of images. Use -1 to get all the available images.

  • Returns the next road code image.

    Declaration

    Objective-C

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

    Swift

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

    Parameters

    height

    The image height in pixels.
    scale

    The screen scale factor.
    ppi

    The screen pixel per inch.

  • Returns the next road code image(s).

    Declaration

    Objective-C

    - (nullable UIImage *)getNextRoadCodeImage:(CGSize)size
                                     scale:(CGFloat)scale
                                       ppi:(NSInteger)ppi
                                     limit:(int)limit;

    Swift

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

    Parameters

    height

    The image height in pixels.
    scale

    The screen scale factor.
    ppi

    The screen pixel per inch.
    limit

    The limit number of images. Use -1 to get all the available images.

  • Returns true if next turn information is available.

    Declaration

    Objective-C

    - (BOOL)hasNextTurnInfo;

    Swift

    func hasNextTurnInfo() -> Bool

  • Returns the schematic image of the next turn.

    Declaration

    Objective-C

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

    Swift

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

    Parameters

    size

    The size of the image.

  • Returns the schematic image of the next turn.

    Declaration

    Objective-C

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

    Swift

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

    Parameters

    size

    The size of the image in pixels.
    scale

    The screen scale factor.
    ppi

    The screen pixel per inch.

  • Returns the schematic image of the next turn.

    Declaration

    Objective-C

    - (nullable UIImage *)getNextTurnImage:(CGSize)size
                      colorActiveInner:(nonnull UIColor *)colorActiveIn
                      colorActiveOuter:(nonnull UIColor *)colorActiveOut
                    colorInactiveInner:(nonnull UIColor *)colorInactiveIn
                    colorInactiveOuter:(nonnull UIColor *)colorInactiveOut;

    Swift

    func getNextTurnImage(_ size: CGSize, colorActiveInner colorActiveIn: UIColor, colorActiveOuter colorActiveOut: UIColor, colorInactiveInner colorInactiveIn: UIColor, colorInactiveOuter colorInactiveOut: UIColor) -> UIImage?

    Parameters

    size

    The size in pixels.
    colorActiveIn

    The inner active color.
    colorActiveOut

    The outer active color.
    colorInactiveIn

    The inner inactive color.
    colorInactiveOut

    The outer inactive color.

  • Returns the schematic image of the next turn.

    Declaration

    Objective-C

    - (nullable UIImage *)getNextTurnImage:(CGSize)size
                                 scale:(CGFloat)scale
                                   ppi:(NSInteger)ppi
                      colorActiveInner:(nonnull UIColor *)colorActiveIn
                      colorActiveOuter:(nonnull UIColor *)colorActiveOut
                    colorInactiveInner:(nonnull UIColor *)colorInactiveIn
                    colorInactiveOuter:(nonnull UIColor *)colorInactiveOut;

    Swift

    func getNextTurnImage(_ size: CGSize, scale: CGFloat, ppi: Int, colorActiveInner colorActiveIn: UIColor, colorActiveOuter colorActiveOut: UIColor, colorInactiveInner colorInactiveIn: UIColor, colorInactiveOuter colorInactiveOut: UIColor) -> UIImage?

    Parameters

    size

    The size in pixels.
    scale

    The screen scale factor.
    ppi

    The screen pixel per inch.
    colorActiveIn

    The inner active color.
    colorActiveOut

    The outer active color.
    colorInactiveIn

    The inner inactive color.
    colorInactiveOut

    The outer inactive color.

  • Returns the full details for the next turn.

    Declaration

    Objective-C

    - (nullable TurnDetailsObject *)getNextTurnDetails;

    Swift

    func getNextTurnDetails() -> TurnDetailsObject?

  • Returns the textual description for the next turn.

    Declaration

    Objective-C

    - (nonnull NSString *)getNextTurnInstruction;

    Swift

    func getNextTurnInstruction() -> String

  • Returns true if next next turn information is available.

    Declaration

    Objective-C

    - (BOOL)hasNextNextTurnInfo;

    Swift

    func hasNextNextTurnInfo() -> Bool

  • Returns the textual description for the next next turn.

    Declaration

    Objective-C

    - (nonnull NSString *)getNextNextStreetName;

    Swift

    func getNextNextStreetName() -> String

  • Returns true if next next road info is available.

    Declaration

    Objective-C

    - (BOOL)hasNextNextRoadInfo;

    Swift

    func hasNextNextRoadInfo() -> Bool

  • Returns the next next road code image.

    Declaration

    Objective-C

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

    Swift

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

    Parameters

    size

    The image size.

  • Returns the next next road code image(s).

    Declaration

    Objective-C

    - (nullable UIImage *)getNextNextRoadCodeImage:(CGSize)size limit:(int)limit;

    Swift

    func getNextNextRoadCodeImage(_ size: CGSize, limit: Int32) -> UIImage?

    Parameters

    limit

    The limit number of images. Use 0 to get all the available images.

  • Returns the next next road code image.

    Declaration

    Objective-C

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

    Swift

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

    Parameters

    height

    The image height in pixels.
    scale

    The screen scale factor.
    ppi

    The screen pixel per inch.

  • Returns the next next road code image(s).

    Declaration

    Objective-C

    - (nullable UIImage *)getNextNextRoadCodeImage:(CGSize)size
                                         scale:(CGFloat)scale
                                           ppi:(NSInteger)ppi
                                         limit:(int)limit;

    Swift

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

    Parameters

    height

    The image height in pixels.
    scale

    The screen scale factor.
    ppi

    The screen pixel per inch.
    limit

    The limit number of images. Use 0 to get all the available images.

  • Returns the next next road information.

    Declaration

    Objective-C

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

    Swift

    func getNextNextRoadInformation() -> [RoadInfoObject]

  • Returns the schematic image of the next next turn.

    Declaration

    Objective-C

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

    Swift

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

    Parameters

    size

    The size of the image.

  • Returns the schematic image of the next next turn.

    Declaration

    Objective-C

    - (nullable UIImage *)getNextNextTurnImage:(CGSize)size
                          colorActiveInner:(nonnull UIColor *)colorActiveIn
                          colorActiveOuter:(nonnull UIColor *)colorActiveOut
                        colorInactiveInner:(nonnull UIColor *)colorInactiveIn
                        colorInactiveOuter:(nonnull UIColor *)colorInactiveOut;

    Swift

    func getNextNextTurnImage(_ size: CGSize, colorActiveInner colorActiveIn: UIColor, colorActiveOuter colorActiveOut: UIColor, colorInactiveInner colorInactiveIn: UIColor, colorInactiveOuter colorInactiveOut: UIColor) -> UIImage?

    Parameters

    size

    The size in pixels.
    colorActiveIn

    The inner active color.
    colorActiveOut

    The outer active color.
    colorInactiveIn

    The inner inactive color.
    colorInactiveOut

    The outer inactive color.

  • Returns the schematic image of the next next turn.

    Declaration

    Objective-C

    - (nullable UIImage *)getNextNextTurnImage:(CGSize)size
                                     scale:(CGFloat)scale
                                       ppi:(NSInteger)ppi
                          colorActiveInner:(nonnull UIColor *)colorActiveIn
                          colorActiveOuter:(nonnull UIColor *)colorActiveOut
                        colorInactiveInner:(nonnull UIColor *)colorInactiveIn
                        colorInactiveOuter:(nonnull UIColor *)colorInactiveOut;

    Swift

    func getNextNextTurnImage(_ size: CGSize, scale: CGFloat, ppi: Int, colorActiveInner colorActiveIn: UIColor, colorActiveOuter colorActiveOut: UIColor, colorInactiveInner colorInactiveIn: UIColor, colorInactiveOuter colorInactiveOut: UIColor) -> UIImage?

    Parameters

    size

    The size in pixels.
    scale

    The screen scale.
    ppi

    The screen pixel per inch.
    colorActiveIn

    The inner active color.
    colorActiveOut

    The outer active color.
    colorInactiveIn

    The inner inactive color.
    colorInactiveOut

    The outer inactive color.

  • Returns the textual description for the next next turn.

    Declaration

    Objective-C

    - (nonnull NSString *)getNextNextTurnInstruction;

    Swift

    func getNextNextTurnInstruction() -> String

  • Returns the full details for the next-next turn.

    Declaration

    Objective-C

    - (nullable TurnDetailsObject *)getNextNextTurnDetails;

    Swift

    func getNextNextTurnDetails() -> TurnDetailsObject?

  • Returns the full details for the next-next turn.

    Declaration

    Objective-C

    - (nullable TimeDistanceObject *)getTimeDistanceToNextNextTurn;

    Swift

    func getTimeDistanceToNextNextTurn() -> TimeDistanceObject?

  • Returns true if lane information is available.

    Declaration

    Objective-C

    - (BOOL)hasLaneInfo;

    Swift

    func hasLaneInfo() -> Bool

  • Returns the image representation of current lane configuration.

    Declaration

    Objective-C

    - (nullable UIImage *)getLaneImage:(CGSize)size
                   backgroundColor:(nonnull UIColor *)backgroundColor
                       activeColor:(nonnull UIColor *)activeColor
                     inactiveColor:(nonnull UIColor *)inactiveColor;

    Swift

    func getLaneImage(_ size: CGSize, backgroundColor: UIColor, activeColor: UIColor, inactiveColor: UIColor) -> UIImage?

    Parameters

    size

    The size in pixels.
    backgroundColor

    The background color.
    activeColor

    The active color.
    inactiveColor

    The inactive color.

  • Returns the image representation of current lane configuration.

    Declaration

    Objective-C

    - (nullable UIImage *)getLaneImage:(CGSize)size
                             scale:(CGFloat)scale
                               ppi:(NSInteger)ppi
                   backgroundColor:(nonnull UIColor *)backgroundColor
                       activeColor:(nonnull UIColor *)activeColor
                     inactiveColor:(nonnull UIColor *)inactiveColor;

    Swift

    func getLaneImage(_ size: CGSize, scale: CGFloat, ppi: Int, backgroundColor: UIColor, activeColor: UIColor, inactiveColor: UIColor) -> UIImage?

    Parameters

    size

    The size in pixels.
    scale

    The screen scale factor.
    ppi

    The screen pixel per inch.
    backgroundColor

    The background color.
    activeColor

    The active color.
    inactiveColor

    The inactive color.

  • Returns the current position.

    Declaration

    Objective-C

    - (nullable PositionObject *)getCurrentPosition;

    Swift

    func getCurrentPosition() -> PositionObject?

  • Returns the index of the current route segment.

    Declaration

    Objective-C

    - (int)getSegmentIndex;

    Swift

    func getSegmentIndex() -> Int32

  • Returns the index of the current route instruction on the current route.

    Declaration

    Objective-C

    - (int)getInstructionIndex;

    Swift

    func getInstructionIndex() -> Int32

  • Get the next route instruction on the route.

    Declaration

    Objective-C

    - (nullable RouteInstructionObject *)getNextInstruction;

    Swift

    func getNextInstruction() -> RouteInstructionObject?

  • Get the next-next route instruction on the route.

    Declaration

    Objective-C

    - (nullable RouteInstructionObject *)getNextNextInstruction;

    Swift

    func getNextNextInstruction() -> RouteInstructionObject?

  • Returns the drive side flag of the current traveled road.

    Declaration

    Objective-C

    - (DriveSideType)getDriveSide;

    Swift

    func getDriveSide() -> DriveSideType

  • Get battery current SoC. @details SoC is in the interval from 0.f ( empty battery ) to 1.f ( fully charged ) @details This will provide the estimated battery SoC for navigation on routes calculated with MotorVehicleProfile fuel electric.

    Declaration

    Objective-C

    - (float)getBatterySoC;

    Swift

    func getBatterySoC() -> Float

  • Export navigation instruction.

    Declaration

    Objective-C

    - (nullable NSData *)exportAs:(PathFileFormat)format
               withCompresion:(BOOL)compressed;

    Swift

    func export(as format: PathFileFormat, withCompresion compressed: Bool) -> Data?

    Parameters

    format

    Data format, see PathFileFormat.
    compressed

    Compression flag. @details Only PathFileFormatPackedGeometry is available at this time.

  • Returns the textual description for the next turn formatted.

    Declaration

    Objective-C

    - (nonnull NSString *)getNextTurnInstructionFormatted;

    Swift

    func getNextTurnInstructionFormatted() -> String

  • Returns the total distance description for the next turn formatted.

    Declaration

    Objective-C

    - (nonnull NSString *)getDistanceToNextTurnFormatted;

    Swift

    func getDistanceToNextTurnFormatted() -> String

  • Returns the total distance unit description for the next turn formatted.

    Declaration

    Objective-C

    - (nonnull NSString *)getDistanceToNextTurnUnitFormatted;

    Swift

    func getDistanceToNextTurnUnitFormatted() -> String

  • Returns the textual description for the next next turn formatted.

    Declaration

    Objective-C

    - (nonnull NSString *)getNextNextTurnInstructionFormatted;

    Swift

    func getNextNextTurnInstructionFormatted() -> String

  • Returns the total distance description for the next next turn formatted.

    Declaration

    Objective-C

    - (nonnull NSString *)getDistanceToNextNextTurnFormatted;

    Swift

    func getDistanceToNextNextTurnFormatted() -> String

  • Returns the total distance unit description for the next next turn formatted.

    Declaration

    Objective-C

    - (nonnull NSString *)getDistanceToNextNextTurnUnitFormatted;

    Swift

    func getDistanceToNextNextTurnUnitFormatted() -> String

  • Returns the maximum speed limit on the current street formatted.

    Declaration

    Objective-C

    - (nonnull NSString *)getCurrentStreetSpeedLimitFormatted;

    Swift

    func getCurrentStreetSpeedLimitFormatted() -> String