SYRouteProgress Class Reference

Exposes additional information about current route. More...

#import <SYNavigationRouteProgress.h>

Inheritance diagram for SYRouteProgress:

Collaboration diagram for SYRouteProgress:

Instance Methods
(NSTimeInterval timeToEnd)	- __deprecated_msg
	Time in seconds to the end of current route. Calculated without traffic delays and speed profiles. More...
(NSTimeInterval timeToEndWithSpeedProfiles)	- __deprecated_msg
	Time in seconds to the end of current route. Calculated with speed profiles, without traffic delays. More...
(NSTimeInterval timeToEndWithSpeedProfileAndTraffic)	- __deprecated_msg
	Time in seconds to the end of current route. Calculated with speed profiles and traffic delays. More...

Properties
SYDistance	distanceFromStart
	Distance in meters from route start to the current position. Note: it is reset to zero in case route is recomputed. More...
SYDistance	distanceToEnd
	Distance in meters to the end of current route. More...
NSArray< SYWaypointDuration * > *	waypointDurationsFromNow
	Time to waypoints from current position. More...
CGFloat	routeProgress
	Progress on current navigation route. (from 0.0 to 1.0) More...
SYTransportMode	transportMode
	Transport mode. More...
SYGeoBoundingBox *	toEndBoundingBox
	Geographic bounding box of route polyline from current position to end position. More...

Detailed Description

Exposes additional information about current route.

Method Documentation

__deprecated_msg [1/3]

- (NSTimeInterval timeToEnd) __deprecated_msg

("use finish waypoint from waypointTimes instead.")

Time in seconds to the end of current route. Calculated without traffic delays and speed profiles.

__deprecated_msg [2/3]

- (NSTimeInterval timeToEndWithSpeedProfiles) __deprecated_msg

("use finish waypoint from waypointTimes instead.")

Time in seconds to the end of current route. Calculated with speed profiles, without traffic delays.

__deprecated_msg [3/3]

- (NSTimeInterval timeToEndWithSpeedProfileAndTraffic) __deprecated_msg

("use finish waypoint from waypointTimes instead.")

Time in seconds to the end of current route. Calculated with speed profiles and traffic delays.

Property Documentation

distanceFromStart

- (SYDistance) distanceFromStart

readnonatomicassign

Distance in meters from route start to the current position. Note: it is reset to zero in case route is recomputed.

distanceToEnd

- (SYDistance) distanceToEnd

readnonatomicassign

Distance in meters to the end of current route.

waypointDurationsFromNow

- (NSArray<SYWaypointDuration*>*) waypointDurationsFromNow

readnonatomicassign

Time to waypoints from current position.

routeProgress

- (CGFloat) routeProgress

readnonatomicassign

Progress on current navigation route. (from 0.0 to 1.0)

transportMode

- (SYTransportMode) transportMode

readnonatomicassign

Transport mode.

toEndBoundingBox

- (SYGeoBoundingBox*) toEndBoundingBox

readnonatomicassign

Geographic bounding box of route polyline from current position to end position.

---

The documentation for this class was generated from the following file:

• SYNavigationRouteProgress.h