GoogleNavigation Framework Reference

AI-generated Key Takeaways

• GMSRouteLeg represents a single leg of a journey, from the current location to the first destination, or between destinations.

• Each leg has a destination waypoint, a final coordinate (which may differ from the waypoint), and a path of coordinates.

• The path property provides access to the coordinates that make up the route leg.

• Although a destination waypoint is associated with the leg, the final coordinate might not be the same if the waypoint isn't directly on a road.

• Attempting to initialize GMSRouteLeg directly using init is not allowed.

GMSRouteLeg

@interface GMSRouteLeg : NSObject

An immutable class which represents a single leg of a journey, either from the device’s current position to the first destination, or from one destination to a subsequent destination.

• destinationWaypoint

  The destination waypoint associated with this leg of the route.

  Declaration

  Swift

  var destinationWaypoint: GMSNavigationWaypoint? { get }

  Objective-C

  @property (nonatomic, readonly, nullable) GMSNavigationWaypoint *destinationWaypoint;

• destinationCoordinate

  The final coordinate in this leg. Note that this will in general not be the same location as the destination waypoint, unless the waypoint is positioned directly on a road.

  Declaration

  Swift

  var destinationCoordinate: CLLocationCoordinate2D { get }

  Objective-C

  @property (nonatomic, readonly) CLLocationCoordinate2D destinationCoordinate;

• path

  The path containing the coordinates which make up this route leg.

  Declaration

  Swift

  var path: GMSPath? { get }

  Objective-C

  @property (nonatomic, readonly, nullable) GMSPath *path;

• -init

  Unavailable

  Declaration

  Objective-C

  - (null_unspecified instancetype)init NS_UNAVAILABLE;