SITNavigationProgress Class Reference

Inherits from NSObject
Declared in SITNavigationProgress.h

Overview

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

  currentStepIndex

Unique identifier of the step inside a route.

@property (nonatomic) NSInteger currentStepIndex

Declared In

SITNavigationProgress.h

  distanceToEndStep

Distance from from point to end of step.

@property (nonatomic) float distanceToEndStep

Declared In

SITNavigationProgress.h

  timeToEndStep

Time from from point to end of route.

@property (nonatomic) float timeToEndStep

Declared In

SITNavigationProgress.h

  distanceToGoal

Distance from from point to end of route.

@property (nonatomic) float distanceToGoal

Declared In

SITNavigationProgress.h

  timeToGoal

Time estimation from from point to end of step.

@property (nonatomic) float timeToGoal

Declared In

SITNavigationProgress.h

  closestPointToRoute

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

@property (nonatomic, strong) DEPRECATED_MSG_ATTRIBUTE ( "Use closestLocationInRoute.position instead" ) SITPoint *closestPointToRoute

Declared In

SITNavigationProgress.h

  closestLocationInRoute

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

@property (nonatomic, strong) SITLocation *closestLocationInRoute

Declared In

SITNavigationProgress.h

  currentIndication

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

@property (nonatomic, strong) SITIndication *currentIndication

Declared In

SITNavigationProgress.h

  nextIndication

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

@property (nonatomic, strong) SITIndication *nextIndication

Declared In

SITNavigationProgress.h

  distanceToClosestPointInRoute

Distance in meters to the closest point in route

@property (nonatomic) float distanceToClosestPointInRoute

Declared In

SITNavigationProgress.h

  routeStep

Current route step

@property (nonatomic, strong) SITRouteStep *routeStep

Declared In

SITNavigationProgress.h

  points

List of ordered points of the route.

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

Declared In

SITNavigationProgress.h

– segments

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.

- (nonnull NSArray<SITRouteSegment*> *)segments

Return Value

Return list of ordered points split by floor.

Declared In

SITNavigationProgress.h