com.mapbox.mapboxsdk.offline.OfflineTilePyramidRegionDefinition Maven / Gradle / Ivy
package com.mapbox.mapboxsdk.offline;
import android.os.Parcel;
import android.os.Parcelable;
import com.mapbox.mapboxsdk.geometry.LatLng;
import com.mapbox.mapboxsdk.geometry.LatLngBounds;
/**
* An offline region defined by a style URL, geographic bounding box, zoom range, and
* device pixel ratio.
*
* Both minZoom and maxZoom must be ≥ 0, and maxZoom must be ≥ minZoom.
*
* maxZoom may be ∞, in which case for each tile source, the region will include
* tiles from minZoom up to the maximum zoom level provided by that source.
*
* pixelRatio must be ≥ 0 and should typically be 1.0 or 2.0.
*/
public class OfflineTilePyramidRegionDefinition implements OfflineRegionDefinition, Parcelable {
private String styleURL;
private LatLngBounds bounds;
private double minZoom;
private double maxZoom;
private float pixelRatio;
/**
* Constructor to create an OfflineTilePyramidDefinition from parameters.
*
* @param styleURL the style
* @param bounds the bounds
* @param minZoom min zoom
* @param maxZoom max zoom
* @param pixelRatio pixel ratio of the device
*/
public OfflineTilePyramidRegionDefinition(
String styleURL, LatLngBounds bounds, double minZoom, double maxZoom, float pixelRatio) {
// Note: Also used in JNI
this.styleURL = styleURL;
this.bounds = bounds;
this.minZoom = minZoom;
this.maxZoom = maxZoom;
this.pixelRatio = pixelRatio;
}
/**
* Constructor to create an OfflineTilePyramidDefinition from a Parcel.
*
* @param parcel the parcel to create the OfflineTilePyramidDefinition from
*/
public OfflineTilePyramidRegionDefinition(Parcel parcel) {
this.styleURL = parcel.readString();
this.bounds = new LatLngBounds.Builder()
.include(new LatLng(parcel.readDouble(), parcel.readDouble()))
.include(new LatLng(parcel.readDouble(), parcel.readDouble()))
.build();
this.minZoom = parcel.readDouble();
this.maxZoom = parcel.readDouble();
this.pixelRatio = parcel.readFloat();
}
/*
* Getters
*/
public String getStyleURL() {
return styleURL;
}
public LatLngBounds getBounds() {
return bounds;
}
public double getMinZoom() {
return minZoom;
}
public double getMaxZoom() {
return maxZoom;
}
public float getPixelRatio() {
return pixelRatio;
}
/*
* Parceable
*/
@Override
public int describeContents() {
return 0;
}
@Override
public void writeToParcel(Parcel dest, int flags) {
dest.writeString(styleURL);
dest.writeDouble(bounds.getLatNorth());
dest.writeDouble(bounds.getLonEast());
dest.writeDouble(bounds.getLatSouth());
dest.writeDouble(bounds.getLonWest());
dest.writeDouble(minZoom);
dest.writeDouble(maxZoom);
dest.writeFloat(pixelRatio);
}
public static final Parcelable.Creator CREATOR = new Parcelable.Creator() {
public OfflineTilePyramidRegionDefinition createFromParcel(Parcel in) {
return new OfflineTilePyramidRegionDefinition(in);
}
public OfflineTilePyramidRegionDefinition[] newArray(int size) {
return new OfflineTilePyramidRegionDefinition[size];
}
};
}