GoogleMaps Framework Reference

GMSPath

@interface GMSPath : NSObject <NSCopying, NSMutableCopying>

GMSPath encapsulates an immutable array of CLLocationCooordinate2D. All the coordinates of a GMSPath must be valid. The mutable counterpart is GMSMutablePath.

• +path

  Convenience constructor for an empty path.

  Declaration

  Objective-C

  + (nonnull instancetype)path;

• -initWithPath:

  Initializes a newly allocated path with the contents of another GMSPath.

  Declaration

  Swift

  init(path: GMSPath)

  Objective-C

  - (nonnull id)initWithPath:(nonnull GMSPath *)path;

• -count

  Get size of path.

  Declaration

  Swift

  func count() -> UInt

  Objective-C

  - (NSUInteger)count;

• -coordinateAtIndex:

  Returns kCLLocationCoordinate2DInvalid if index >= count.

  Declaration

  Swift

  func coordinate(at index: UInt) -> CLLocationCoordinate2D

  Objective-C

  - (CLLocationCoordinate2D)coordinateAtIndex:(NSUInteger)index;

• +pathFromEncodedPath:

  Initializes a newly allocated path from -encodedPath. This format is described at: https://developers.google.com/maps/documentation/utilities/polylinealgorithm

  Declaration

  Swift

  convenience init?(fromEncodedPath encodedPath: String)

  Objective-C

  + (nullable instancetype)pathFromEncodedPath:(nonnull NSString *)encodedPath;

• -encodedPath

  Returns an encoded string of the path in the format described above.

  Declaration

  Swift

  func encodedPath() -> String

  Objective-C

  - (nonnull NSString *)encodedPath;

• -pathOffsetByLatitude:longitude:

  Returns a new path obtained by adding deltaLatitude and deltaLongitude to each coordinate of the current path. Does not modify the current path.

  Declaration

  Swift

  func pathOffset(byLatitude deltaLatitude: CLLocationDegrees, longitude deltaLongitude: CLLocationDegrees) -> Self

  Objective-C

  - (nonnull instancetype)pathOffsetByLatitude:(CLLocationDegrees)deltaLatitude
                                     longitude:(CLLocationDegrees)deltaLongitude;

GMSPathLength

• -segmentsForLength:kind:

  Returns the fractional number of segments along the path that correspond to length, interpreted according to kind. See GMSLengthKind.

  Declaration

  Swift

  func segments(forLength length: CLLocationDistance, kind: GMSLengthKind) -> Double

  Objective-C

  - (double)segmentsForLength:(CLLocationDistance)length kind:(GMSLengthKind)kind;

• -lengthOfKind:

  Returns the length of the path, according to kind. See GMSLengthKind.

  Declaration

  Swift

  func length(of kind: GMSLengthKind) -> CLLocationDistance

  Objective-C

  - (CLLocationDistance)lengthOfKind:(GMSLengthKind)kind;