MPDirectionsRenderer Class Reference

#include <MPDirectionsRenderer.h>

Inheritance diagram for MPDirectionsRenderer:

Instance Methods
(void)	- animate:

Properties
id< MPDirectionsRendererDelegate >	delegate
GMSMapView *	map
MPRoute *	route
UIButton *	nextRouteLegButton
UIButton *	previousRouteLegButton
NSInteger	routeLegIndex
NSInteger	routeStepIndex
UIColor *	solidColor
UIColor *	backgroundColor
BOOL	fitBounds
MPDirectionsRenderFit	fitMode
UIEdgeInsets	edgeInsets
BOOL	isRenderingRoute
NSArray< UIImage * > *	actionPointImages
MPDirectionsRendererContextualInfoSettings *	contextualInfoSettings

Detailed Description

Directions Renderer

Method Documentation

animate:

- (void) animate:

(NSTimeInterval)

duration

Start animation of the route leg/step with given duration. Starting with a backgroundColor route leg/step the polyline will be gradually stroked from start to end with the solidColor at the speed of leg/step length / duration.

Parameters

duration

Duration in seconds.

Property Documentation

actionPointImages

- (NSArray<UIImage*>*) actionPointImages

readwritenonatomicstrong

Custom images to use for representing the action points. The first image will be used as the start image. The image at position N in the array will be used at the end of the leg with index N-1, as well as the end of the last step of the leg with index N-1.

backgroundColor

- (UIColor*) backgroundColor

readwritenonatomicstrong

Background color of the rendered route leg/step. The background color will ne visible during animation.

contextualInfoSettings

- (MPDirectionsRendererContextualInfoSettings*) contextualInfoSettings

readwritenonatomicassign

Set this property to show labels and icons from nearby Locations as additional contextual information about the start and end positions of the rendered route segment.

delegate

- (id<MPDirectionsRendererDelegate>) delegate

readwritenonatomicweak

edgeInsets

- (UIEdgeInsets) edgeInsets

readwritenonatomicassign

Intentional egde insets for bounds fitting. The rendering is not guaranteed to respect the specified insets.

fitBounds

- (BOOL) fitBounds

readwritenonatomicassign

If set to YES, the map viewport will be adjusted to fit the rendered route leg/step.

fitMode

- (MPDirectionsRenderFit) fitMode

readwritenonatomicassign

Bounds fitting mode.

isRenderingRoute

- (BOOL) isRenderingRoute

readnonatomicassign

Indicates whether the renderer is currently showing a route or not.

map

- (GMSMapView*) map

readwritenonatomicstrong

Assigns (or unassigns) a Google map object

nextRouteLegButton

- (UIButton*) nextRouteLegButton

readwritenonatomicstrong

Template button used to render a marker at the end of the rendered route leg

previousRouteLegButton

- (UIButton*) previousRouteLegButton

readwritenonatomicstrong

Template button used to render a marker at the start of the rendered route leg

route

- (MPRoute*) route

readwritenonatomicstrong

Assigns (or unassigns) a route object

routeLegIndex

- (NSInteger) routeLegIndex

readwritenonatomicassign

Index of the route leg that will be rendered. If set to something negative, rendering will be disabled.

routeStepIndex

- (NSInteger) routeStepIndex

readwritenonatomicassign

Optional index of the route step in the current route leg. If set, only the step will be rendered and not the current route leg. If set to something negative, route step rendering will be disabled.

solidColor

- (UIColor*) solidColor

readwritenonatomicstrong

Foreground color of the rendered route leg/step.