Get Started Contact sales

GoogleNavigation Framework Reference

  • GMSNavigationMutableWaypoint allows customization of waypoint behavior for navigation.

  • It enables setting preferences for arriving on the same side of the road or with a specific heading.

  • Waypoints can be designated as vehicle stopovers for pickup/drop-off optimization, applicable to DRIVE and TWO_WHEELER travel modes.

  • By default, preferSameSideOfRoad and vehicleStopover are NO, while preferredHeading is -1 (unset).

GMSNavigationMutableWaypoint

@interface GMSNavigationMutableWaypoint : GMSNavigationWaypoint

A mutable waypoint class.

  • Whether it is preferred to route the driver to the same side of the road. The route will arrive on the preferred side of the road unless there is a significant delay caused by a road closure or slow-moving traffic. Default to NO. Setting this to true clears any value in preferredHeading.

    Declaration

    Swift

    var preferSameSideOfRoad: Bool { get set }

    Objective-C

    @property (nonatomic) BOOL preferSameSideOfRoad;

  • An angle used to express the direction of traffic on the side of the road that the vehicle should arrive on. Consequently, it is not useful for one-way streets. Units expressed in degrees [0, 360], where 0 means North and angles increase clockwise. Default and unset value is -1. Setting a valid value will clear the preferSameSideOfRoad.

    Declaration

    Swift

    var preferredHeading: Int32 { get set }

    Objective-C

    @property (nonatomic) int32_t preferredHeading;

  • Indicates that the waypoint is meant for vehicles to stop at, where the intention is to either pickup or drop-off. When you set this value, waypoints on roads that are unsuitable for pickup and drop-off may be adjusted to a more suitable location. This option works only for DRIVE and TWO_WHEELER travel modes. Default to NO.

    Declaration

    Swift

    var vehicleStopover: Bool { get set }

    Objective-C

    @property (nonatomic) BOOL vehicleStopover;