com.mapbox.mapboxsdk.snapshotter

Class MapSnapshotter

java.lang.Object

com.mapbox.mapboxsdk.snapshotter.MapSnapshotter

@UiThread
public class MapSnapshotter
extends java.lang.Object

The map snapshotter creates a large of the map, rendered off the UI thread. The snapshotter itself must be used on the UI thread (for access to the main looper)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	MapSnapshotter.ErrorHandler Can be used to get notified of errors in snapshot generation
static interface	MapSnapshotter.Observer Can be used to get notified on snapshotter style loading completion.
static class	MapSnapshotter.Options MapSnapshotter options
static interface	MapSnapshotter.SnapshotReadyCallback Get notified on snapshot completion.

Constructor Summary

Constructors

Constructor and Description
MapSnapshotter(android.content.Context context, MapSnapshotter.Options options) Creates the Map snapshotter, but doesn't start rendering or loading yet.

Method Summary

Modifier and Type	Method and Description
void	addImage(java.lang.String name, android.graphics.Bitmap bitmap, boolean sdf) Adds an image to be used in the snapshotter's style
protected void	addOverlay(MapSnapshot mapSnapshot) Draw an overlay on the map snapshot.
void	cancel() Must be called in on the thread the object was created on.
protected void	finalize()
Layer	getLayer(java.lang.String layerId) Returns Layer of a style that is used by a snapshotter
Source	getSource(java.lang.String sourceId) Returns Source of a style that is used by a snapshotter
protected void	nativeCancel()
protected void	nativeInitialize(MapSnapshotter mapSnapshotter, FileSource fileSource, float pixelRatio, int width, int height, java.lang.String styleUrl, java.lang.String styleJson, LatLngBounds region, CameraPosition position, boolean showLogo, int glyphsRasterizationMode, java.lang.String localIdeographFontFamily)
protected void	nativeStart()
protected void	onDidFailLoadingStyle(java.lang.String reason) Called by JNI peer when snapshot style is ready.
protected void	onDidFinishLoadingStyle() Called by JNI peer when snapshot style is loaded.
protected void	onSnapshotFailed(java.lang.String reason) Called by JNI peer when snapshot has failed.
protected void	onSnapshotReady(MapSnapshot snapshot) Called by JNI peer when snapshot is ready.
protected void	onStyleImageMissing(java.lang.String imageName) Called by JNI peer when snapshot style image is missing.
protected void	reset()
void	setCameraPosition(CameraPosition cameraPosition) Updates the snapshotter with a new CameraPosition
void	setObserver(MapSnapshotter.Observer observer) Sets observer for a snapshotter
void	setRegion(LatLngBounds region) Updates the snapshotter with a new LatLngBounds
void	setSize(int width, int height) Updates the snapshotter with a new size
void	setStyleJson(java.lang.String styleJson) Updates the snapshotter with a new style json
void	setStyleUrl(java.lang.String styleUrl) Updates the snapshotter with a new style url
void	start(MapSnapshotter.SnapshotReadyCallback callback) Starts loading and rendering the snapshot.
void	start(MapSnapshotter.SnapshotReadyCallback callback, MapSnapshotter.ErrorHandler errorHandler) Starts loading and rendering the snapshot.

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MapSnapshotter

public MapSnapshotter(@NonNull
                      android.content.Context context,
                      @NonNull
                      MapSnapshotter.Options options)

Creates the Map snapshotter, but doesn't start rendering or loading yet.

Parameters:

context - the Context that is or contains the Application context

options - the options to use for the snapshot

Method Detail

start

public void start(@NonNull
                  MapSnapshotter.SnapshotReadyCallback callback)

Starts loading and rendering the snapshot. The callback will be fired on the calling thread.

Parameters:

callback - the callback to use when the snapshot is ready

start

public void start(@NonNull
                  MapSnapshotter.SnapshotReadyCallback callback,
                  MapSnapshotter.ErrorHandler errorHandler)

Starts loading and rendering the snapshot. The callbacks will be fired on the calling thread.

Parameters:

callback - the callback to use when the snapshot is ready

errorHandler - the error handler to use on snapshot errors

setSize

public void setSize(int width,
                    int height)

Updates the snapshotter with a new size

Parameters:

width - the width

height - the height

setCameraPosition

public void setCameraPosition(CameraPosition cameraPosition)

Updates the snapshotter with a new CameraPosition

Parameters:

cameraPosition - the camera position

setRegion

public void setRegion(LatLngBounds region)

Updates the snapshotter with a new LatLngBounds

Parameters:

region - the region

setStyleUrl

public void setStyleUrl(java.lang.String styleUrl)

Updates the snapshotter with a new style url

Parameters:

styleUrl - the style url

setStyleJson

public void setStyleJson(java.lang.String styleJson)

Updates the snapshotter with a new style json

Parameters:

styleJson - the style json

addImage

public void addImage(@NonNull
                     java.lang.String name,
                     @NonNull
                     android.graphics.Bitmap bitmap,
                     boolean sdf)

Adds an image to be used in the snapshotter's style

Parameters:

name - the name of the image

bitmap - the pre-multiplied Bitmap

sdf - the flag indicating image is an SDF or template image

cancel

public void cancel()

Must be called in on the thread the object was created on.

setObserver

public void setObserver(@Nullable
                        MapSnapshotter.Observer observer)

Sets observer for a snapshotter

Parameters:

observer - an Observer object

addOverlay

protected void addOverlay(@NonNull
                          MapSnapshot mapSnapshot)

Draw an overlay on the map snapshot.

Parameters:

mapSnapshot - the map snapshot to draw the overlay on

onSnapshotReady

protected void onSnapshotReady(@NonNull
                               MapSnapshot snapshot)

Called by JNI peer when snapshot is ready. Always called on the origin (main) thread.

Parameters:

snapshot - the generated snapshot

onSnapshotFailed

protected void onSnapshotFailed(java.lang.String reason)

Called by JNI peer when snapshot has failed.

Parameters:

reason - the exception string

onDidFailLoadingStyle

protected void onDidFailLoadingStyle(java.lang.String reason)

Called by JNI peer when snapshot style is ready.

onDidFinishLoadingStyle

protected void onDidFinishLoadingStyle()

Called by JNI peer when snapshot style is loaded.

getLayer

@Nullable
public Layer getLayer(@NonNull
                                java.lang.String layerId)

Returns Layer of a style that is used by a snapshotter

Parameters:

layerId - the id of a Layer

Returns:

the Layer object if Layer with layerId exists, null otherwise

getSource

@Nullable
public Source getSource(@NonNull
                                  java.lang.String sourceId)

Returns Source of a style that is used by a snapshotter

Parameters:

sourceId - the id of a Source

Returns:

the Source object if a Source with sourceId exists, null otherwise

onStyleImageMissing

protected void onStyleImageMissing(java.lang.String imageName)

Called by JNI peer when snapshot style image is missing.

reset

protected void reset()

nativeInitialize

protected void nativeInitialize(MapSnapshotter mapSnapshotter,
                                FileSource fileSource,
                                float pixelRatio,
                                int width,
                                int height,
                                java.lang.String styleUrl,
                                java.lang.String styleJson,
                                LatLngBounds region,
                                CameraPosition position,
                                boolean showLogo,
                                int glyphsRasterizationMode,
                                java.lang.String localIdeographFontFamily)

nativeStart

protected void nativeStart()

nativeCancel

protected void nativeCancel()

finalize

protected void finalize()
                 throws java.lang.Throwable

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable