SITNavigationProgress

Objective-C

@interface SITNavigationProgress : NSObject <SITMapperProtocol>

Swift

class SITNavigationProgress : NSObject, SITMapperProtocol

It provides information of the progress of a user while following a route.

Properties

  • Unique identifier of the step inside a route.

    Declaration

    Objective-C

    @property (nonatomic) NSInteger currentStepIndex;

    Swift

    var currentStepIndex: Int { get set }

  • Distance from from point to end of step.

    Declaration

    Objective-C

    @property (nonatomic) float distanceToEndStep;

    Swift

    var distanceToEndStep: Float { get set }

  • Time from from point to end of route.

    Declaration

    Objective-C

    @property (nonatomic) float timeToEndStep;

    Swift

    var timeToEndStep: Float { get set }

  • Distance from from point to end of route.

    Declaration

    Objective-C

    @property (nonatomic) float distanceToGoal;

    Swift

    var distanceToGoal: Float { get set }

  • Time estimation from from point to end of step.

    Declaration

    Objective-C

    @property (nonatomic) float timeToGoal;

    Swift

    var timeToGoal: Float { get set }

  • Closest location inside the route closer to the user’s location.

    Declaration

    Objective-C

    @property (nonatomic, strong) SITLocation *_Nonnull closestLocationInRoute;

    Swift

    var closestLocationInRoute: SITLocation { get set }

  • The indication a user should follow in order to arrive the destination following a route.

    Declaration

    Objective-C

    @property (nonatomic, strong) SITIndication *_Nonnull currentIndication;

    Swift

    var currentIndication: SITIndication { get set }

  • The next indication a user should follow in order to arrive the destination following a route.

    Declaration

    Objective-C

    @property (nonatomic, strong) SITIndication *_Nonnull nextIndication;

    Swift

    var nextIndication: SITIndication { get set }

  • Distance in meters to the closest point in route

    Declaration

    Objective-C

    @property (nonatomic) float distanceToClosestPointInRoute;

    Swift

    var distanceToClosestPointInRoute: Float { get set }

  • Current route step

    Declaration

    Objective-C

    @property (nonatomic, strong) SITRouteStep *_Nonnull routeStep;

    Swift

    var routeStep: SITRouteStep { get set }

  • List of ordered points of the route.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSArray<SITPoint *> *_Nonnull points;

    Swift

    var points: [SITPoint] { get set }

Methods

  • Return list of ordered points split by floor, each list contains points from one floor, but can have multiple lists of the same floor. Use this method to display segments in a map, each list should be a polyline. For example, if there is no path to go to the other side of the same floor and you need to go up one floor and then go down again to the original floor, this method will return one segment on the current floor, one segment on the upper floor and one more segment in the current floor. Drawing example: if you want to draw all the points of a floor, you should draw a polyline for each list that contains the floor you want to show.

    Declaration

    Objective-C

    - (NSArray<SITRouteSegment *> *_Nonnull)segments;

    Swift

    func segments() -> [SITRouteSegment]

    Return Value

    Return list of ordered points split by floor.

Deprecated

  • Deprecated

    Use closestLocationInRoute.position instead

    Closest point inside the route closer to the user’s location.

    Declaration

    Objective-C

    @property (nonatomic, strong) SITPoint *_Nullable closestPointToRoute;

    Swift

    var closestPointToRoute: SITPoint? { get set }