MPRoute Class Reference

#include <MPRoute.h>

Inheritance diagram for MPRoute:

Instance Methods
(MPRouteSegmentPath)	- findNearestRouteSegmentPathFromPoint:floor:

Properties
NSString< Optional > *	copyrights
NSMutableArray< MPRouteLeg * >< MPRouteLeg, Optional > *	legs
MPEncodedPolyline< Optional > *	overview_polyline
NSString< Optional > *	summary
NSArray< Optional > *	warnings
MPRouteBounds< Optional > *	bounds
NSNumber< Optional > *	distance
NSNumber< Optional > *	duration
NSArray< NSString * >< Optional > *	restrictions

Detailed Description

The route model contains the route components: The start and end point, the overall route distance, the duration using the given travel mode(s), the actual route components (legs and steps) containing the route geometry and actions (shifts, turns, climbs etc.) performed to get to the destination point. Typically this object is not manually instantiated, but returns as a result from the MPDirectionsService.

Method Documentation

findNearestRouteSegmentPathFromPoint:floor:

- (MPRouteSegmentPath) findNearestRouteSegmentPathFromPoint:		(nonnull MPPoint *)	point
floor:		(nonnull NSNumber *)	floorIndex

Find route segment path (route leg and route step) nearest to a point and floor index.

Property Documentation

bounds

- (MPRouteBounds<Optional>*) bounds

readwritenonatomicstrong

The route bounds.

copyrights

- (NSString<Optional>*) copyrights

readwritenonatomicstrong

distance

- (NSNumber<Optional>*) distance

readwritenonatomicstrong

The full distance in meters.

duration

- (NSNumber<Optional>*) duration

readwritenonatomicstrong

The full duration in seconds based on travel times for each leg/step.

legs

- (NSMutableArray<MPRouteLeg*><MPRouteLeg,Optional> *) legs

readwritenonatomicstrong

The route legs: the different route components. Typically a route from 1st floor to 2nd floor will consist of two route legs.

overview_polyline

- (MPEncodedPolyline<Optional>*) overview_polyline

readwritenonatomicstrong

restrictions

- (NSArray<NSString*><Optional> *) restrictions

readwritenonatomicstrong

The restrictions that apply for the route. May be empty/nil

summary

- (NSString<Optional>*) summary

readwritenonatomicstrong

Textual summary of the route. May be empty/nil.

warnings

- (NSArray<Optional>*) warnings

readwritenonatomicstrong

Textual warning for the route. May be empty/nil.