SITIndication

Objective-C

@interface SITIndication : NSObject

Swift

class SITIndication : NSObject

Represents the instruction that a user should follow when on a SITRouteStep to continue the route.

Properties

  • The index of the step where the indication starts (positive integer).

    Declaration

    Objective-C

    @property (readonly, nonatomic) NSInteger originStepIndex;

    Swift

    var originStepIndex: Int { get }
  • The index of the step where the indication ends (positive integer).

    Declaration

    Objective-C

    @property (readonly, nonatomic) NSInteger destinationStepIndex;

    Swift

    var destinationStepIndex: Int { get }
  • Distance between origin and destination (in meters).

    Declaration

    Objective-C

    @property (readonly, nonatomic) float horizontalDistance;

    Swift

    var horizontalDistance: Float { get }
  • Number of levels between the origin and destination.

    Note

    value representing the number of levels to go upstairs (positive values) or downstairs (negative values).

    Declaration

    Objective-C

    @property (readonly, nonatomic) float verticalDistance;

    Swift

    var verticalDistance: Float { get }
  • Check if the user should change the level in order to arrive to destination.

    Declaration

    Objective-C

    @property (readonly, nonatomic) BOOL needLevelChange;

    Swift

    var needLevelChange: Bool { get }
  • Destination level of the step

    Declaration

    Objective-C

    @property (nonatomic) NSNumber *_Nullable nextLevel;

    Swift

    var nextLevel: NSNumber? { get set }
  • The angle between the previous destination and the line formed by the origin and destination of the current step (in radians).

    Declaration

    Objective-C

    @property (readonly, nonatomic) float orientationChange;

    Swift

    var orientationChange: Float { get }
  • The type of action the user should perform in order to arrive to the destination.

    Note

    one of kSITIndicationActions.

    Declaration

    Objective-C

    @property (readonly, nonatomic) kSITIndicationActions action;

    Swift

    var action: kSITIndicationActions { get }
  • The type of turn (if any) the user should perform in order to arrive to the destination.

    Note

    one of kSITIndicationOrientation.

    Declaration

    Objective-C

    @property (readonly, nonatomic) kSITIndicationOrientation orientation;

    Swift

    var orientation: kSITIndicationOrientation { get }

Methods

  • Human readable text. Language will be set based on the language selected by the user in the system’s preferences. Only english and spanish are supported, if an unknown locale is set, english will be used as default.

    Declaration

    Objective-C

    - (NSString *_Nonnull)humanReadableMessage;

    Swift

    func humanReadableMessage() -> String

    Return Value

    string that describes the indication in a more human friendly way

  • Human readable text in the language selected by the locale parameter. Only english and spanish are supported, if an unknown locale is passed, english will be used as default.

    Declaration

    Objective-C

    - (NSString *_Nonnull)humanReadableMessageWithLocale:(NSLocale *_Nonnull)locale;

    Swift

    func humanReadableMessage(with locale: Locale) -> String

    Return Value

    string that describes the indication in a more human friendly way

  • Creates an indication with calculating action.

    Declaration

    Objective-C

    + (SITIndication *_Nonnull)indicationWithCalculatingAction;

    Swift

    class func withCalculatingAction() -> SITIndication

    Return Value

    an indication

  • Creates an indication with end action.

    Declaration

    Objective-C

    + (SITIndication *_Nonnull)indicationWithEndAction;

    Swift

    class func withEndAction() -> SITIndication

    Return Value

    an indication