Overview
Information about a single step along a navigation route.
Public Member Functions | |
(nullable UIImage *) | - maneuverImageWithOptions: |
The UIImage for the maneuver of this step using provided options. | |
(nullable UIImage *) | - lanesImageWithOptions: |
The UIImage for the lane guidance of this step using provided options. | |
Properties | |
GMSNavigationManeuver | maneuver |
The GMSNavigationManeuver for this step. | |
NSArray< GMSNavigationLane * > * | lanes |
The different available lanes for this step. | |
NSString * | fullRoadName |
The full road name for this step containing all information for the road including direction. | |
NSString * | simpleRoadName |
The simplified version of the road name. | |
NSString * | fullInstructionText |
The full text of the instruction for this step. | |
NSString * | exitNumber |
Exit number of this step if it exists. | |
GMSNavigationDrivingSide | drivingSide |
Whether this step is on a drive-on-right or drive-on-left route. | |
NSInteger | roundaboutTurnNumber |
The counted number of the exit to take relative to the location where the roundabout was entered. | |
NSInteger | stepNumber |
The index of the step in the list of all steps in the route. | |
CLLocationDistance | distanceFromPrevStepMeters |
The total distance of this step. | |
NSTimeInterval | timeFromPrevStepSeconds |
The estimated time it takes to complete this step. |
Member Function Documentation
- (nullable UIImage *) maneuverImageWithOptions: | (nullable GMSNavigationStepInfoImageOptions *) | options |
The UIImage for the maneuver of this step using provided options.
Default options values will be used if the options parameter is nil.
Returns nil if there is no maneuver image for this step.
- (nullable UIImage *) lanesImageWithOptions: | (nullable GMSNavigationStepInfoImageOptions *) | options |
The UIImage for the lane guidance of this step using provided options.
Default options values will be used if the options parameter is nil.
Returns nil if there is no lane guidance for this step.
Property Documentation
- (GMSNavigationManeuver) maneuver [read, assign] |
The GMSNavigationManeuver
for this step.
- (NSArray<GMSNavigationLane *>*) lanes [read, assign] |
The different available lanes for this step.
The array is ordered such that the first lane is on the left and last lane is on the right regardless of driving side.
Returns nil if there is no lane guidance for this step.
- (NSString*) fullRoadName [read, assign] |
The full road name for this step containing all information for the road including direction.
Examples (each line is a separate example):
Lean Ave
CA-85 / Mtn View
Exit 9A / North First Street
- (NSString*) simpleRoadName [read, assign] |
The simplified version of the road name.
This is shorter than the full road name and may not contain all pieces of identifying information about the road such as direction or name of exit.
Examples (each line is a separate example):
Lean Ave
CA-85
Exit 9A
- (NSString*) fullInstructionText [read, assign] |
The full text of the instruction for this step.
Examples (each line is a separate example):
Turn left onto Lean Ave.
Use the right lane to take the CA-85 ramp to Mtn View.
Use the 2nd from the right lane to take exit 9A toward North First Street.
- (NSString*) exitNumber [read, assign] |
Exit number of this step if it exists.
- (GMSNavigationDrivingSide) drivingSide [read, assign] |
Whether this step is on a drive-on-right or drive-on-left route.
- (NSInteger) roundaboutTurnNumber [read, assign] |
The counted number of the exit to take relative to the location where the roundabout was entered.
Only set for roundabouts, otherwise -1.
- (NSInteger) stepNumber [read, assign] |
The index of the step in the list of all steps in the route.
The first step has step number 0.
- (CLLocationDistance) distanceFromPrevStepMeters [read, assign] |
The total distance of this step.
This value does not change.
- (NSTimeInterval) timeFromPrevStepSeconds [read, assign] |
The estimated time it takes to complete this step.
This value does not change.