MapKit Mobile SDK

Warning

This feature is available in the Full MapKit SDK version

MMKRouteHelper

class MMKRouteHelper : NSObject

Undocumented

Summary

Class methods

class func createDefaultJamStyle() -> MMKJamStyle
Creates a default traffic style

class func createDisabledJamStyle() -> MMKJamStyle
Creates a disabled traffic jams style

class func createDefaultManeuverStyle() -> MMKManeuverStyle
Creates a default maneuver style

class func updatePolyline(withPolyline polyline: MMKPolylineMapObject,
                                          route: MMKDrivingRoute,
                                          style: MMKJamStyle,
                                 updateGeometry: Bool)
Sets a new geometry and colors for a polyline

class func addManeuvers(withPolyline polyline: MMKPolylineMapObject,
                                        route: MMKDrivingRoute)
Add maneuvers from provided route as arrows Behaviour is undefined if route

class func addJams(withPolyline polyline: MMKPolylineMapObject,
                                   route: MMKDrivingRoute)
Add jams from provided route as stroke colors Behaviour is undefined if route

class func applyJamStyle(withPolyline polyline: MMKPolylineMapObject,
                                         style: MMKJamStyle)
Applies the traffic jam style

class func applyManeuverStyle(withPolyline polyline: MMKPolylineMapObject,
                                              style: MMKManeuverStyle)
Applies a maneuver style

Class methods

createDefaultJamStyle()

class func createDefaultJamStyle() -> MMKJamStyle

Creates a default traffic style. Default values: colors : Blocked : 0x000000ff, Free : 0x00ff00ff, Hard : 0xff0000ff, Light : 0xffff00ff, Unknown : 0x909090ff, VeryHard : 0xa00000ff


createDisabledJamStyle()

class func createDisabledJamStyle() -> MMKJamStyle

Creates a disabled traffic jams style. Colors : Blocked : 0x909090ff, Free : 0x909090ff, Hard : 0x909090ff, Light : 0x909090ff, Unknown : 0x909090ff, VeryHard : 0x909090ff


createDefaultManeuverStyle()

class func createDefaultManeuverStyle() -> MMKManeuverStyle

Creates a default maneuver style.

Default values for ArrowManeuverStyle: fillColor : 0x000000ff outlineColor : 0xffffffff outlineWidth : 2.f length : 80 triangleHeight : 16 enabled : false

Default values for PolygonManeuverStyle: trajectoryWidth : 5.f trajectoryColor : 0xffffffff polygonAlpha : 60.f / 255.f polygonColor : 0xff00ffff renderMode : ColoredPolygon fadeDistance : 10.f fadeAlpha : 0.f enabled : false


updatePolyline(withPolyline:route:style:updateGeometry:)

class func updatePolyline(withPolyline polyline: MMKPolylineMapObject,
                                          route: MMKDrivingRoute,
                                          style: MMKJamStyle,
                                 updateGeometry: Bool)

Sets a new geometry and colors for a polyline. If style.enabled = false, the polyline is drawn using the color for the Unknown traffic jam type. If updateGeometry = false, but route geometry differs from polyline geometry, then behaviour is undefined.


addManeuvers(withPolyline:route:)

class func addManeuvers(withPolyline polyline: MMKPolylineMapObject,
                                        route: MMKDrivingRoute)

Add maneuvers from provided route as arrows Behaviour is undefined if route.geometry does not equals polyline.geometry.


addJams(withPolyline:route:)

class func addJams(withPolyline polyline: MMKPolylineMapObject,
                                   route: MMKDrivingRoute)

Add jams from provided route as stroke colors Behaviour is undefined if route.geometry does not equals polyline.geometry.


applyJamStyle(withPolyline:style:)

class func applyJamStyle(withPolyline polyline: MMKPolylineMapObject,
                                         style: MMKJamStyle)

Applies the traffic jam style. Updates colors for traffic jam types provided in the style parameter.


applyManeuverStyle(withPolyline:style:)

class func applyManeuverStyle(withPolyline polyline: MMKPolylineMapObject,
                                              style: MMKManeuverStyle)

Applies a maneuver style. This method should be called every time after updatePolyline with updateGeometry == true occurs; otherwise, the default maneuver style is applied.