MBMMapSnapshotter

 

@interface MBMMapSnapshotter : MBMCameraManager

MapSnapshotter exposes functionality to capture static map images.

  • Unavailable

    Undocumented

    Declaration

    Objective-C

    - (nonnull instancetype)init NS_UNAVAILABLE;

  • Unavailable

    Undocumented

    Declaration

    Objective-C

    + (nonnull instancetype)new NS_UNAVAILABLE;

  • Construct a new snapshotter.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithOptions:
    (nonnull MBMMapSnapshotOptions *)options;

    Swift

    init(options: MBMMapSnapshotOptions)

    Parameters

    options

    The map snapshot options to configure the snapshotter.

  • Sets the size of the snapshot

    Declaration

    Objective-C

    - (void)setSizeForSize:(nonnull MBMSize *)size;

    Swift

    func setSizeFor(_ size: MBMSize)

    Parameters

    size

    The new size of the snapshot in platform pixels.

  • Gets the size of the snapshot

    Declaration

    Objective-C

    - (nonnull MBMSize *)getSize;

    Swift

    func getSize() -> MBMSize

    Return Value

    Snapshot size in platform pixels.

  • Returns true if the snapshotter is in the tile mode.

    Declaration

    Objective-C

    - (BOOL)isInTileMode;

    Swift

    func isInTileMode() -> Bool

    Return Value

    true if the snapshotter is in the tile mode, false otherwise.

  • Sets the snapshotter to the tile mode.

    In the tile mode, the snapshotter fetches the still image of a single tile.

    Declaration

    Objective-C

    - (void)setTileModeForSet:(BOOL)set;

    Swift

    func setTileModeForSet(_ set: Bool)

    Parameters

    set

    A boolean value representing if the snapshotter is in the tile mode.

  • Cancel the current snapshot operation.

    Cancel the current snapshot operation, if any. The callback passed to the start method is called with error parameter set.

    Declaration

    Objective-C

    - (void)cancel;

    Swift

    func cancel()

  • Get elevation for the given coordinate. Note: Elevation is only available for the visible region on the screen.

    Declaration

    Objective-C

    - (nullable NSNumber *)getElevationForCoordinate:
    (CLLocationCoordinate2D)coordinate;

    Swift

    func getElevationFor(_ coordinate: CLLocationCoordinate2D) -> NSNumber?

    Parameters

    coordinate

    defined as longitude-latitude pair.

    Return Value

    Elevation (in meters) multiplied by current terrain exaggeration, or empty if elevation for the coordinate is not available.

  • Undocumented

    Declaration

    Objective-C

    - (void)startForCallback:(nonnull MBMSnapshotCompleteCallback)callback;

    Swift

    func start(forCallback callback: @escaping SnapshotCompleteCallback)