com.mapbox.mapboxsdk.offline

Class OfflineGeometryRegionDefinition

java.lang.Object

com.mapbox.mapboxsdk.offline.OfflineGeometryRegionDefinition

All Implemented Interfaces:

android.os.Parcelable, OfflineRegionDefinition

public class OfflineGeometryRegionDefinition
extends java.lang.Object
implements OfflineRegionDefinition

An offline region defined by a style URL, geometry, 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.

if includeIdeographs is false, offline region will not include CJK glyphs

Nested Class Summary

Nested classes/interfaces inherited from interface android.os.Parcelable

android.os.Parcelable.ClassLoaderCreator<T>, android.os.Parcelable.Creator<T>

Field Summary

Fields

Modifier and Type	Field and Description
static android.os.Parcelable.Creator	CREATOR

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Constructor Summary

Constructors

Constructor and Description
OfflineGeometryRegionDefinition(android.os.Parcel parcel) Constructor to create an OfflineGeometryRegionDefinition from a Parcel.
OfflineGeometryRegionDefinition(java.lang.String styleURL, com.mapbox.geojson.Geometry geometry, double minZoom, double maxZoom, float pixelRatio) Constructor to create an OfflineGeometryRegionDefinition from parameters.
OfflineGeometryRegionDefinition(java.lang.String styleURL, com.mapbox.geojson.Geometry geometry, double minZoom, double maxZoom, float pixelRatio, boolean includeIdeographs) Constructor to create an OfflineGeometryRegionDefinition from parameters.

Method Summary

Modifier and Type	Method and Description
int	describeContents()
LatLngBounds	getBounds() Calculates the bounding box for the Geometry it contains to retain backwards compatibility
com.mapbox.geojson.Geometry	getGeometry()
boolean	getIncludeIdeographs() Specifies whether to include ideographic glyphs in downloaded font data.
double	getMaxZoom() Gets the maximum zoom level the OfflineRegion map can be displayed at.
double	getMinZoom() Gets the minimum zoom level the OfflineRegion map can be displayed at.
float	getPixelRatio() Gets the pixel ratio of the OfflineRegion map.
java.lang.String	getStyleURL() Returns the map style url of the OfflineRegion.
java.lang.String	getType() Gets the type of the OfflineRegionDefinition for telemetry ("tileregion", "shaperegion").
void	writeToParcel(android.os.Parcel dest, int flags)

Methods inherited from class java.lang.Object

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

Field Detail

CREATOR

public static final android.os.Parcelable.Creator CREATOR

Constructor Detail

OfflineGeometryRegionDefinition

public OfflineGeometryRegionDefinition(java.lang.String styleURL,
                                       com.mapbox.geojson.Geometry geometry,
                                       double minZoom,
                                       double maxZoom,
                                       float pixelRatio)

Constructor to create an OfflineGeometryRegionDefinition from parameters.

Parameters:

styleURL - the style

geometry - the geometry

minZoom - min zoom

maxZoom - max zoom

pixelRatio - pixel ratio of the device

OfflineGeometryRegionDefinition

public OfflineGeometryRegionDefinition(java.lang.String styleURL,
                                       com.mapbox.geojson.Geometry geometry,
                                       double minZoom,
                                       double maxZoom,
                                       float pixelRatio,
                                       boolean includeIdeographs)

Constructor to create an OfflineGeometryRegionDefinition from parameters.

Parameters:

styleURL - the style

geometry - the geometry

minZoom - min zoom

maxZoom - max zoom

pixelRatio - pixel ratio of the device

includeIdeographs - include glyphs for CJK languages

OfflineGeometryRegionDefinition

public OfflineGeometryRegionDefinition(android.os.Parcel parcel)

Constructor to create an OfflineGeometryRegionDefinition from a Parcel.

Parameters:

parcel - the parcel to create the OfflineGeometryRegionDefinition from

Method Detail

getStyleURL

public java.lang.String getStyleURL()

Description copied from interface: OfflineRegionDefinition

Returns the map style url of the OfflineRegion.

Specified by:

getStyleURL in interface OfflineRegionDefinition

Returns:

The URL of the map style.

getGeometry

@Nullable
public com.mapbox.geojson.Geometry getGeometry()

getBounds

@Nullable
public LatLngBounds getBounds()

Calculates the bounding box for the Geometry it contains to retain backwards compatibility

Specified by:

getBounds in interface OfflineRegionDefinition

Returns:

the LatLngBounds or null

getMinZoom

public double getMinZoom()

Description copied from interface: OfflineRegionDefinition

Gets the minimum zoom level the OfflineRegion map can be displayed at.

Specified by:

getMinZoom in interface OfflineRegionDefinition

Returns:

The minimum zoom level.

getMaxZoom

public double getMaxZoom()

Description copied from interface: OfflineRegionDefinition

Gets the maximum zoom level the OfflineRegion map can be displayed at.

Specified by:

getMaxZoom in interface OfflineRegionDefinition

Returns:

The maximum zoom level.

getPixelRatio

public float getPixelRatio()

Description copied from interface: OfflineRegionDefinition

Gets the pixel ratio of the OfflineRegion map.

Specified by:

getPixelRatio in interface OfflineRegionDefinition

Returns:

The pixel ratio of the OfflineRegion map.

getIncludeIdeographs

public boolean getIncludeIdeographs()

Description copied from interface: OfflineRegionDefinition

Specifies whether to include ideographic glyphs in downloaded font data. Ideographic glyphs make up the majority of downloaded font data, but it is possible to configure the renderer to use locally installed fonts instead of relying on fonts downloaded as part of the offline pack. Defaults to `true`

Specified by:

getIncludeIdeographs in interface OfflineRegionDefinition

Returns:

true if offline region will include ideographic glyphs

See Also:

MapboxMapOptions.localIdeographFontFamily(String)

getType

@NonNull
public java.lang.String getType()

Description copied from interface: OfflineRegionDefinition

Gets the type of the OfflineRegionDefinition for telemetry ("tileregion", "shaperegion").

Specified by:

getType in interface OfflineRegionDefinition

Returns:

The type of the OfflineRegionDefinition.

describeContents

public int describeContents()

Specified by:

describeContents in interface android.os.Parcelable

writeToParcel

public void writeToParcel(@NonNull
                          android.os.Parcel dest,
                          int flags)

Specified by:

writeToParcel in interface android.os.Parcelable