GoogleMaps Framework Reference

AI-generated Key Takeaways

• GMSMutablePath is a dynamic array used to represent a series of geographical coordinates (CLLocationCoordinate2D).

• It provides methods to add, insert, replace, and remove coordinates within the path.

• GMSMutablePath allows for flexible manipulation of paths, enabling resizing and modification of coordinate sequences.

• This class serves as the mutable counterpart to the read-only GMSPath class.

GMSMutablePath

@interface GMSMutablePath : GMSPath

GMSMutablePath is a dynamic (resizable) array of CLLocationCoordinate2D. All coordinates must be valid. GMSMutablePath is the mutable counterpart to the immutable GMSPath.

• -addCoordinate:

  Adds coord at the end of the path.

  Declaration

  Swift

  func add(_ coord: CLLocationCoordinate2D)

  Objective-C

  - (void)addCoordinate:(CLLocationCoordinate2D)coord;

• -addLatitude:longitude:

  Adds a new CLLocationCoordinate2D instance with the given lat/lng.

  Declaration

  Swift

  func addLatitude(_ latitude: CLLocationDegrees, longitude: CLLocationDegrees)

  Objective-C

  - (void)addLatitude:(CLLocationDegrees)latitude
            longitude:(CLLocationDegrees)longitude;

• -insertCoordinate:atIndex:

  Inserts coord at index.

  If this is smaller than the size of the path, shifts all coordinates forward by one. Otherwise, behaves as -replaceCoordinateAtIndex:withCoordinate:.

  Declaration

  Swift

  func insert(_ coord: CLLocationCoordinate2D, at index: UInt)

  Objective-C

  - (void)insertCoordinate:(CLLocationCoordinate2D)coord
                   atIndex:(NSUInteger)index;

• -replaceCoordinateAtIndex:withCoordinate:

  Replace the coordinate at index with coord. If index is after the end, grows the array with an undefined coordinate.

  Declaration

  Swift

  func replaceCoordinate(at index: UInt, with coord: CLLocationCoordinate2D)

  Objective-C

  - (void)replaceCoordinateAtIndex:(NSUInteger)index
                    withCoordinate:(CLLocationCoordinate2D)coord;

• -removeCoordinateAtIndex:

  Remove entry at index.

  If index < count decrements size. If index >= count this is a silent no-op.

  Declaration

  Swift

  func removeCoordinate(at index: UInt)

  Objective-C

  - (void)removeCoordinateAtIndex:(NSUInteger)index;

• -removeLastCoordinate

  Removes the last coordinate of the path.

  If the array is non-empty decrements size. If the array is empty, this is a silent no-op.

  Declaration

  Swift

  func removeLastCoordinate()

  Objective-C

  - (void)removeLastCoordinate;

• -removeAllCoordinates

  Removes all coordinates in this path.

  Declaration

  Swift

  func removeAllCoordinates()

  Objective-C

  - (void)removeAllCoordinates;