MBMMapSnapshot.h 1.6 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647
  1. // This file is generated and will be overwritten automatically.
  2. #import <Foundation/Foundation.h>
  3. #import <CoreLocation/CoreLocation.h>
  4. @class MBMImage;
  5. @class MBMScreenCoordinate;
  6. /** An image snapshot of a map rendered by `map snapshotter`. */
  7. NS_SWIFT_NAME(MapSnapshot)
  8. __attribute__((visibility ("default")))
  9. @interface MBMMapSnapshot : NSObject
  10. // This class provides custom init which should be called
  11. - (nonnull instancetype)init NS_UNAVAILABLE;
  12. // This class provides custom init which should be called
  13. + (nonnull instancetype)new NS_UNAVAILABLE;
  14. /**
  15. * Calculate screen coordinate on the snapshot from geographical `coordinate`.
  16. *
  17. * @param coordinate A geographical `coordinate`.
  18. * @return A `screen coordinate` measured in `platform pixels` on the snapshot for geographical `coordinate`.
  19. */
  20. - (nonnull MBMScreenCoordinate *)screenCoordinateForCoordinate:(CLLocationCoordinate2D)coordinate __attribute((ns_returns_retained));
  21. /**
  22. * Calculate geographical coordinates from a point on the snapshot.
  23. *
  24. * @param screenCoordinate A `screen coordinate` on the snapshot in `platform pixels`.
  25. * @return A geographical `coordinate` for a `screen coordinate` on the snapshot.
  26. */
  27. - (CLLocationCoordinate2D)coordinateForScreenCoordinate:(nonnull MBMScreenCoordinate *)screenCoordinate;
  28. /**
  29. * Get list of attributions for the sources in this snapshot.
  30. *
  31. * @return A list of attributions for the sources in this snapshot.
  32. */
  33. - (nonnull NSArray<NSString *> *)attributions __attribute((ns_returns_retained));
  34. /**
  35. * Get the rendered snapshot `image`.
  36. *
  37. * @return A rendered snapshot `image`.
  38. */
  39. - (nonnull MBMImage *)image __attribute((ns_returns_retained));
  40. @end