MPRouteStep Class Reference

#include <MPRouteStep.h>

Inheritance diagram for MPRouteStep:

Instance Methods
(nullable MPPoint *)	- getActionPoint
(nullable NSNumber *)	- getStartFloorName
(nullable MPPoint *)	- getStartPoint
(nullable MPPoint *)	- getEndPoint

Properties
NSString< Optional > *	travel_mode
MPRouteCoordinate< Optional > *	end_location
MPRouteCoordinate< Optional > *	start_location
NSNumber< Optional > *	distance
NSNumber< Optional > *	duration
NSString< Optional > *	maneuver
MPEncodedPolyline< Optional > *	polyline
NSMutableArray< MPRouteCoordinate * >< MPRouteCoordinate, Optional > *	geometry
NSString< Optional > *	html_instructions
_Nullable MPHighwayType	highway
NSString< Optional > *	routeContext
NSMutableArray< MPRouteStep * >< MPRouteStep, Optional > *	steps
MPTransitDetails< Optional > *	transit_details

Detailed Description

Route step model. A step is segment on a MPRouteLeg (MPRouteLeg is a segment on a MPRoute). The step contains start and end locations, distance and duration information, as well as navigational instructions.

Method Documentation

getActionPoint

- (nullable MPPoint *) getActionPoint

getEndPoint

- (nullable MPPoint *) getEndPoint

getStartFloorName

- (nullable NSNumber *) getStartFloorName

getStartPoint

- (nullable MPPoint *) getStartPoint

Property Documentation

distance

- (NSNumber<Optional>*) distance

readwritenonatomicstrong

Distance of the step in meters.

duration

- (NSNumber<Optional>*) duration

readwritenonatomicstrong

Duration of the step in seconds, with specified travel mode step.travel_mode

end_location

- (MPRouteCoordinate<Optional>*) end_location

readwritenonatomicstrong

End location coordinate and floor index

geometry

- (NSMutableArray<MPRouteCoordinate*><MPRouteCoordinate,Optional> *) geometry

readwritenonatomicstrong

Polyline geometry for the step.

highway

- (_Nullable MPHighwayType) highway

readwriteatomic

Way type for this step (part of the route). E.g. footway, steps, elevator, residential etc.

html_instructions

- (NSString<Optional>*) html_instructions

readwritenonatomicstrong

Textual instructions for the step. May not be specified.

maneuver

- (NSString<Optional>*) maneuver

readwritenonatomicstrong

Maneuver value for the step. Possible values are: straight, turn-left, turn-right, turn-sharp-left, turn-sharp-right, turn-slight-left, turn-slight-right, uturn-left, uturn-right

polyline

- (MPEncodedPolyline<Optional>*) polyline

readwritenonatomicstrong

Encoded polyline for the step. Can de decoded with [GMSPath pathFromEncodedPath:]. Only long polylines may be encoded.

routeContext

- (NSString<Optional>*) routeContext

readwritenonatomicstrong

Context of the step. May be InsideBuilding, OutsideOnVenue or a custom context e.g. Security

start_location

- (MPRouteCoordinate<Optional>*) start_location

readwritenonatomicstrong

Start location coordinate and floor index

steps

- (NSMutableArray<MPRouteStep*><MPRouteStep, Optional> *) steps

readwritenonatomicstrong

Substeps for the step. May be empty/nil.

transit_details

- (MPTransitDetails<Optional>*) transit_details

readwritenonatomicstrong

Transit details. May apply for travel mode transit.

travel_mode

- (NSString<Optional>*) travel_mode

readwritenonatomicstrong

Travel mode key. Can be walking, bicycling, driving and transit.