SITIndication
@interface SITIndication : NSObject
Represents the instruction that a user should follow when on a SITRouteStep to continue the route.
-
The index of the step where the indication starts (positive integer).
Declaration
Objective-C
@property (readonly, nonatomic) NSInteger originStepIndex;
-
The index of the step where the indication ends (positive integer).
Declaration
Objective-C
@property (readonly, nonatomic) NSInteger destinationStepIndex;
-
Distance between origin and destination (in meters).
Declaration
Objective-C
@property (readonly, nonatomic) float horizontalDistance;
-
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;
-
Check if the user should change the level in order to arrive to destination.
Declaration
Objective-C
@property (readonly, nonatomic) BOOL needLevelChange;
-
Destination level of the step
Declaration
Objective-C
@property (assign, readwrite, nonatomic) NSNumber *_Nullable nextLevel;
-
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;
-
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;
-
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;
-
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;
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;
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;
Return Value
an indication
-
Creates an indication with end action.
Declaration
Objective-C
+ (SITIndication *_Nonnull)indicationWithEndAction;
Return Value
an indication