GLRouteManeuver

Objective-C


@interface GLRouteManeuver : NSObject

Swift

class GLRouteManeuver : NSObject

GLRouteManeuver is a class that holds data for a route maneuver, providing information about the maneuver type, route mode, start and end points, and more.

  • Type of the maneuver see https://valhalla.github.io/valhalla/api/turn-by-turn/api-reference/ for details

    Declaration

    Objective-C

    @property (readonly) GLManeuverType type;

    Swift

    var type: GLManeuverType { get }

  • Route mode of this maneuver

    Declaration

    Objective-C

    @property (readonly) GLRouteMode routeMode;

    Swift

    var routeMode: GLRouteMode { get }

  • Start point of the maneuver

    Declaration

    Objective-C

    @property (readonly) GLMapPoint startPoint;

    Swift

    var startPoint: GLMapPoint { get }

  • End point of the maneuver

    Declaration

    Objective-C

    @property (readonly) GLMapPoint endPoint;

    Swift

    var endPoint: GLMapPoint { get }

  • Index of maneuver

    Declaration

    Objective-C

    @property (readonly) NSUInteger index;

    Swift

    var index: UInt { get }

  • Number of points in maneuver track.

    Declaration

    Objective-C

    @property (readonly) NSUInteger countOfPoints;

    Swift

    var countOfPoints: UInt { get }

  • The spoke to exit roundabout after entering. UINT32_MAX if not set.

    Declaration

    Objective-C

    @property (readonly) NSUInteger roundaboutExitCount;

    Swift

    var roundaboutExitCount: UInt { get }

  • First point equals to startPoint. Last point equals to endPoint

    Declaration

    Objective-C

    - (GLMapPoint)pointAtIndex:(NSUInteger)index;

    Swift

    func point(at index: UInt) -> GLMapPoint

    Parameters

    index

    index of point to return

    Return Value

    point of maneuver track at givenIndex

  • Number of lanes

    Declaration

    Objective-C

    @property (readonly) NSUInteger lanesCount;

    Swift

    var lanesCount: UInt { get }

  • Returns possible turn directions for a specific lane.

    Declaration

    Objective-C

    - (GLRouteTurnLaneMask)turnDirectionsAtLane:(NSUInteger)index;

    Swift

    func turnDirections(atLane index: UInt) -> GLRouteTurnLaneMask

    Parameters

    index

    The index of the lane (starting from 0).

    Return Value

    A mask indicating all valid turn directions for the lane.

  • Returns valid turn directions for a lane that can be used to follow the route initially. Valid turns indicate that the lane is suitable for the maneuver but may require further lane changes later.

    Declaration

    Objective-C

    - (GLRouteTurnLaneMask)validTurnAtLane:(NSUInteger)index;

    Swift

    func validTurn(atLane index: UInt) -> GLRouteTurnLaneMask

    Parameters

    index

    The index of the lane (starting from 0).

    Return Value

    A mask indicating valid turns for the lane.

  • Returns active turn directions for a lane that should be used to follow the route without requiring additional lane changes. Active turns indicate the optimal lane for continuing along the route as intended.

    Declaration

    Objective-C

    - (GLRouteTurnLaneMask)activeTurnAtLane:(NSUInteger)index;

    Swift

    func activeTurn(atLane index: UInt) -> GLRouteTurnLaneMask

    Parameters

    index

    The index of the lane (starting from 0).

    Return Value

    A mask indicating active turns for the lane.

  • Short instruction for UI. For example “Exit 3A → AZ 202 Loop East”

    Declaration

    Objective-C

    @property (readonly) NSString *_Nullable shortInstruction;

    Swift

    var shortInstruction: String? { get }

  • Text for use in UI. For example “Take exit 3A onto AZ 202 Loop East.”.

    Declaration

    Objective-C

    @property (readonly) NSString *_Nullable transitionInstruction;

    Swift

    var transitionInstruction: String? { get }

  • Text suitable for use as a verbal message immediately after the maneuver transition. For example “Continue for 1 kilometer.”.

    Declaration

    Objective-C

    @property (readonly) NSString *_Nullable verbalPostTransitionInstruction;

    Swift

    var verbalPostTransitionInstruction: String? { get }

  • Text suitable for use as a verbal message immediately prior to the maneuver transition. For example “Take exit 3A onto Arizona 2 o2 Loop East.”.

    Declaration

    Objective-C

    @property (readonly) NSString *_Nullable verbalPreTransitionInstruction;

    Swift

    var verbalPreTransitionInstruction: String? { get }

  • Text suitable for use as a verbal alert in a navigation application. The transition alert instruction will prepare the user for the forthcoming transition. For example: “Take exit 3A.”.

    Declaration

    Objective-C

    @property (readonly) NSString *_Nullable verbalTransitionInstruction;

    Swift

    var verbalTransitionInstruction: String? { get }

  • Maneuver length in meters

    Declaration

    Objective-C

    @property (readonly) double length;

    Swift

    var length: Double { get }

  • Estimated time along the maneuver in seconds.

    Declaration

    Objective-C

    @property (readonly) double time;

    Swift

    var time: Double { get }