org.osmdroid.util

Class TileSystem

java.lang.Object

org.osmdroid.util.TileSystem

Direct Known Subclasses:

TileSystemWebMercator

public abstract class TileSystem
extends Object

Proxy class for TileSystem. For coordinate conversions (tile to lat/lon and reverse) TileSystem only accepts input parameters within certain ranges and crops any values outside of it. For lat/lon the range is ~(-85,+85) / (-180,+180) and for tile coordinates (0,mapsize-1). Under certain conditions osmdroid creates values outside of these ranges, for example when zooming out and displaying the earth more that once side by side or when scrolling across the 180 degree longitude (international date line). This class fixes this by wrapping input coordinates into a valid range by adding/subtracting the valid span. Example: longitude +185 => -175

Field Summary

Fields

Modifier and Type	Field and Description
static double	EarthRadius Deprecated.
static double	MaxLatitude Deprecated.
static double	MaxLongitude Deprecated.
static double	MinLatitude Deprecated.
static double	MinLongitude Deprecated.
static int	primaryKeyMaxZoomLevel The maximum possible zoom for primary key of SQLite table is 29, because it gives enough space for y(29bits), x(29bits) and zoom(5bits in order to code 29), total: 63 bits used, just small enough for a `long` variable of 4 bytes
static int	projectionZoomLevel

Constructor Summary

Constructors

Constructor and Description
TileSystem()

Method Summary

Modifier and Type	Method and Description
double	cleanLatitude(double pLatitude)
double	cleanLongitude(double pLongitude)
static double	Clip(double n, double minValue, double maxValue)
static long	Clip(long n, long minValue, long maxValue) Deprecated.
static long	ClipToLong(double pValue, double pMax, boolean pWrapEnabled)
double	getBoundingBoxZoom(BoundingBox pBoundingBox, int pScreenWidth, int pScreenHeight)
long	getCleanMercator(long pMercator, double pMercatorMapSize, boolean wrapEnabled)
static double	getFactor(double pZoomLevel)
GeoPoint	getGeoFromMercator(long pMercatorX, long pMercatorY, double pMapSize, GeoPoint pReuse, boolean horizontalWrapEnabled, boolean verticalWrapEnabled)
static int	getInputTileZoomLevel(double pZoomLevel)
double	getLatitudeFromTileY(int pY, int pZoom)
abstract double	getLatitudeFromY01(double pY01)
double	getLatitudeFromY01(double pY01, boolean wrapEnabled) Converts a "Y01" value into latitude "Y01" is a double between 0 and 1 for the whole latitude range MaxLatitude:0 ...
double	getLatitudeZoom(double pNorth, double pSouth, int pScreenHeight)
double	getLongitudeFromTileX(int pX, int pZoom)
abstract double	getLongitudeFromX01(double pX01)
double	getLongitudeFromX01(double pX01, boolean wrapEnabled) Converts a "X01" value into longitude "X01" is a double between 0 and 1 for the whole longitude range MinLongitude:0 ...
double	getLongitudeZoom(double pEast, double pWest, int pScreenWidth)
static int	getMaximumZoomLevel()
abstract double	getMaxLatitude()
abstract double	getMaxLongitude()
PointL	getMercatorFromGeo(double pLatitude, double pLongitude, double pMapSize, PointL pReuse, boolean wrapEnabled)
static long	getMercatorFromTile(int pTile, double pTileSize)
long	getMercatorFromXY01(double pXY01, double pMapSize, boolean wrapEnabled)
long	getMercatorXFromLongitude(double pLongitude, double pMapSize, boolean wrapEnabled)
long	getMercatorYFromLatitude(double pLatitude, double pMapSize, boolean wrapEnabled)
abstract double	getMinLatitude()
abstract double	getMinLongitude()
double	getRandomLatitude(double pRandom01)
double	getRandomLatitude(double pRandom01, double pMinLatitude)
double	getRandomLongitude(double pRandom01)
static int	getTileFromMercator(long pMercator, double pTileSize)
static Rect	getTileFromMercator(RectL pMercatorRect, double pTileSize, Rect pReuse)
static int	getTileSize()
static double	getTileSize(double pZoomLevel)
int	getTileXFromLongitude(double pLongitude, int pZoom)
int	getTileYFromLatitude(double pLatitude, int pZoom)
abstract double	getX01FromLongitude(double longitude) Converts a longitude to its "X01" value, Same as getX01FromLongitude but without wrap
double	getX01FromLongitude(double longitude, boolean wrapEnabled) Converts a longitude to its "X01" value, id est a double between 0 and 1 for the whole longitude range
double	getXY01FromMercator(long pMercator, double pMapSize, boolean wrapEnabled)
abstract double	getY01FromLatitude(double pLatitude) Converts a latitude to its "Y01" value, Same as getY01FromLatitude but without wrap
double	getY01FromLatitude(double latitude, boolean wrapEnabled) Converts a latitude to its "Y01" value, id est a double between 0 and 1 for the whole latitude range
static double	GroundResolution(double latitude, double zoomLevel)
static double	GroundResolution(double latitude, int levelOfDetail)
static double	GroundResolutionMapSize(double latitude, double mapSize) Most likely meters/pixel at the given latitude
boolean	isValidLatitude(double pLatitude)
boolean	isValidLongitude(double pLongitude)
PointL	LatLongToPixelXY(double latitude, double longitude, double zoomLevel, PointL reuse) Deprecated.
Point	LatLongToPixelXY(double latitude, double longitude, int levelOfDetail, Point reuse) Deprecated.
PointL	LatLongToPixelXYMapSize(double latitude, double longitude, double mapSize, PointL reuse) Deprecated.
static double	MapScale(double latitude, int levelOfDetail, int screenDpi)
static double	MapSize(double pZoomLevel)
static int	MapSize(int levelOfDetail) Deprecated.
GeoPoint	PixelXYToLatLong(int pixelX, int pixelY, double zoomLevel, GeoPoint reuse) Deprecated.
GeoPoint	PixelXYToLatLong(int pixelX, int pixelY, int levelOfDetail, GeoPoint reuse) Deprecated.
GeoPoint	PixelXYToLatLongMapSize(int pixelX, int pixelY, double mapSize, GeoPoint reuse, boolean horizontalWrapEnabled, boolean verticalWrapEnabled) Deprecated.
GeoPoint	PixelXYToLatLongMapSizeWithoutWrap(int pixelX, int pixelY, double mapSize, GeoPoint reuse)
GeoPoint	PixelXYToLatLongWithoutWrap(int pixelX, int pixelY, double zoomLevel, GeoPoint reuse)
Point	PixelXYToTileXY(int pPixelX, int pPixelY, double pTileSize, Point pReuse) Deprecated.
Point	PixelXYToTileXY(int pixelX, int pixelY, Point reuse) Deprecated.
Rect	PixelXYToTileXY(Rect rect, double pTileSize, Rect pReuse) Deprecated.
static Point	QuadKeyToTileXY(String quadKey, Point reuse) Use MapTileIndex.getX(long) and MapTileIndex.getY(long) instead Quadkey principles can be found at https://msdn.microsoft.com/en-us/library/bb259689.aspx
static void	setTileSize(int tileSize)
PointL	TileXYToPixelXY(int pTileX, int pTileY, double pTileSize, PointL pReuse) Deprecated.
Point	TileXYToPixelXY(int tileX, int tileY, Point reuse) Deprecated.
static String	TileXYToQuadKey(int tileX, int tileY, int levelOfDetail) Use MapTileIndex.getTileIndex(int, int, int) instead Quadkey principles can be found at https://msdn.microsoft.com/en-us/library/bb259689.aspx Works only for zoom level >= 1
String	toStringLatitudeSpan()
String	toStringLongitudeSpan()
static int	truncateToInt(long value)

Methods inherited from class java.lang.Object

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

Field Detail

EarthRadius

@Deprecated
public static final double EarthRadius

Deprecated.

See Also:

Constant Field Values

MinLatitude

@Deprecated
public static final double MinLatitude

Deprecated.

Use getMinLatitude() instead

See Also:

Constant Field Values

MaxLatitude

@Deprecated
public static final double MaxLatitude

Deprecated.

Use getMaxLatitude() instead

See Also:

Constant Field Values

MinLongitude

@Deprecated
public static final double MinLongitude

Deprecated.

Use getMinLongitude() instead

See Also:

Constant Field Values

MaxLongitude

@Deprecated
public static final double MaxLongitude

Deprecated.

Use getMaxLongitude() instead

See Also:

Constant Field Values

primaryKeyMaxZoomLevel

public static final int primaryKeyMaxZoomLevel

The maximum possible zoom for primary key of SQLite table is 29, because it gives enough space for y(29bits), x(29bits) and zoom(5bits in order to code 29), total: 63 bits used, just small enough for a `long` variable of 4 bytes

Since:

6.0.2 Used to be in the `TileSystem` class of another package

See Also:

Constant Field Values

projectionZoomLevel

public static final int projectionZoomLevel

Since:

6.0.2 Used to be in the `TileSystem` class of another package

See Also:

Constant Field Values

Constructor Detail

TileSystem

public TileSystem()

Method Detail

setTileSize

public static void setTileSize(int tileSize)

getTileSize

public static int getTileSize()

getMaximumZoomLevel

public static int getMaximumZoomLevel()

Since:

6.0.2 Used to be in the `TileSystem` class of another package

getTileSize

public static double getTileSize(double pZoomLevel)

Since:

6.0.0

getInputTileZoomLevel

public static int getInputTileZoomLevel(double pZoomLevel)

Since:

6.0.0

MapSize

@Deprecated
public static int MapSize(int levelOfDetail)

Deprecated.

MapSize

public static double MapSize(double pZoomLevel)

Since:

6.0.0

getFactor

public static double getFactor(double pZoomLevel)

Since:

6.0.0

GroundResolution

public static double GroundResolution(double latitude,
                                      int levelOfDetail)

GroundResolution

public static double GroundResolution(double latitude,
                                      double zoomLevel)

Since:

6.0.0

GroundResolutionMapSize

public static double GroundResolutionMapSize(double latitude,
                                             double mapSize)

Most likely meters/pixel at the given latitude

Since:

6.0.0

MapScale

public static double MapScale(double latitude,
                              int levelOfDetail,
                              int screenDpi)

LatLongToPixelXY

@Deprecated
public Point LatLongToPixelXY(double latitude,
                                           double longitude,
                                           int levelOfDetail,
                                           Point reuse)

Deprecated.

LatLongToPixelXY

@Deprecated
public PointL LatLongToPixelXY(double latitude,
                                            double longitude,
                                            double zoomLevel,
                                            PointL reuse)

Deprecated.

Since:

6.0.0 Use getMercatorFromGeo(double, double, double, PointL, boolean) instead

LatLongToPixelXYMapSize

@Deprecated
public PointL LatLongToPixelXYMapSize(double latitude,
                                                   double longitude,
                                                   double mapSize,
                                                   PointL reuse)

Deprecated.

Since:

6.0.0 Use getMercatorFromGeo(double, double, double, PointL, boolean) instead

PixelXYToLatLong

@Deprecated
public GeoPoint PixelXYToLatLong(int pixelX,
                                              int pixelY,
                                              int levelOfDetail,
                                              GeoPoint reuse)

Deprecated.

Use getGeoFromMercator(long, long, double, GeoPoint, boolean, boolean) instead

PixelXYToLatLong

@Deprecated
public GeoPoint PixelXYToLatLong(int pixelX,
                                              int pixelY,
                                              double zoomLevel,
                                              GeoPoint reuse)

Deprecated.

Since:

6.0.0 Use getGeoFromMercator(long, long, double, GeoPoint, boolean, boolean) instead

PixelXYToLatLongWithoutWrap

public GeoPoint PixelXYToLatLongWithoutWrap(int pixelX,
                                            int pixelY,
                                            double zoomLevel,
                                            GeoPoint reuse)

Since:

6.0.0 Same as PixelXYToLatLong but without wrap

getX01FromLongitude

public double getX01FromLongitude(double longitude,
                                  boolean wrapEnabled)

Converts a longitude to its "X01" value, id est a double between 0 and 1 for the whole longitude range

Since:

6.0.0

getY01FromLatitude

public double getY01FromLatitude(double latitude,
                                 boolean wrapEnabled)

Converts a latitude to its "Y01" value, id est a double between 0 and 1 for the whole latitude range

Since:

6.0.0

getX01FromLongitude

public abstract double getX01FromLongitude(double longitude)

Converts a longitude to its "X01" value, Same as getX01FromLongitude but without wrap

Since:

6.0.0

getY01FromLatitude

public abstract double getY01FromLatitude(double pLatitude)

Converts a latitude to its "Y01" value, Same as getY01FromLatitude but without wrap

Since:

6.0.0

PixelXYToLatLongMapSize

@Deprecated
public GeoPoint PixelXYToLatLongMapSize(int pixelX,
                                                     int pixelY,
                                                     double mapSize,
                                                     GeoPoint reuse,
                                                     boolean horizontalWrapEnabled,
                                                     boolean verticalWrapEnabled)

Deprecated.

Since:

6.0.0 Use getGeoFromMercator(long, long, double, GeoPoint, boolean, boolean) instead

PixelXYToLatLongMapSizeWithoutWrap

public GeoPoint PixelXYToLatLongMapSizeWithoutWrap(int pixelX,
                                                   int pixelY,
                                                   double mapSize,
                                                   GeoPoint reuse)

Since:

6.0.0 Same as PixelXYToLatLongMapSize but without wrap

Clip

public static double Clip(double n,
                          double minValue,
                          double maxValue)

Since:

6.0.0

PixelXYToTileXY

@Deprecated
public Point PixelXYToTileXY(int pixelX,
                                          int pixelY,
                                          Point reuse)

Deprecated.

PixelXYToTileXY

@Deprecated
public Point PixelXYToTileXY(int pPixelX,
                                          int pPixelY,
                                          double pTileSize,
                                          Point pReuse)

Deprecated.

Since:

6.0.0 Use getTileFromMercator(long, double) instead

PixelXYToTileXY

@Deprecated
public Rect PixelXYToTileXY(Rect rect,
                                         double pTileSize,
                                         Rect pReuse)

Deprecated.

Since:

6.0.0 Use getTileFromMercator(long, double) instead

TileXYToPixelXY

@Deprecated
public Point TileXYToPixelXY(int tileX,
                                          int tileY,
                                          Point reuse)

Deprecated.

TileXYToPixelXY

@Deprecated
public PointL TileXYToPixelXY(int pTileX,
                                           int pTileY,
                                           double pTileSize,
                                           PointL pReuse)

Deprecated.

Since:

6.0.0 Use getMercatorFromTile(int, double) instead

TileXYToQuadKey

public static String TileXYToQuadKey(int tileX,
                                     int tileY,
                                     int levelOfDetail)

Use MapTileIndex.getTileIndex(int, int, int) instead Quadkey principles can be found at https://msdn.microsoft.com/en-us/library/bb259689.aspx Works only for zoom level >= 1

QuadKeyToTileXY

public static Point QuadKeyToTileXY(String quadKey,
                                    Point reuse)

Use MapTileIndex.getX(long) and MapTileIndex.getY(long) instead Quadkey principles can be found at https://msdn.microsoft.com/en-us/library/bb259689.aspx

getBoundingBoxZoom

public double getBoundingBoxZoom(BoundingBox pBoundingBox,
                                 int pScreenWidth,
                                 int pScreenHeight)

Returns:

the maximum zoom level where a bounding box fits into a screen, or Double.MIN_VALUE if bounding box is a single point

Since:

6.0.0

getLongitudeZoom

public double getLongitudeZoom(double pEast,
                               double pWest,
                               int pScreenWidth)

Returns:

the maximum zoom level where both longitudes fit into a screen, or Double.MIN_VALUE if longitudes are equal

Since:

6.0.0

getLatitudeZoom

public double getLatitudeZoom(double pNorth,
                              double pSouth,
                              int pScreenHeight)

Returns:

the maximum zoom level where both latitudes fit into a screen, or Double.MIN_VALUE if latitudes are equal or ill positioned

Since:

6.0.0

getMercatorYFromLatitude

public long getMercatorYFromLatitude(double pLatitude,
                                     double pMapSize,
                                     boolean wrapEnabled)

Since:

6.0.0

getMercatorXFromLongitude

public long getMercatorXFromLongitude(double pLongitude,
                                      double pMapSize,
                                      boolean wrapEnabled)

Since:

6.0.0

getMercatorFromXY01

public long getMercatorFromXY01(double pXY01,
                                double pMapSize,
                                boolean wrapEnabled)

Since:

6.0.0

getLatitudeFromY01

public double getLatitudeFromY01(double pY01,
                                 boolean wrapEnabled)

Converts a "Y01" value into latitude "Y01" is a double between 0 and 1 for the whole latitude range MaxLatitude:0 ... MinLatitude:1

Since:

6.0.0

getLatitudeFromY01

public abstract double getLatitudeFromY01(double pY01)

getLongitudeFromX01

public double getLongitudeFromX01(double pX01,
                                  boolean wrapEnabled)

Converts a "X01" value into longitude "X01" is a double between 0 and 1 for the whole longitude range MinLongitude:0 ... MaxLongitude:1

Since:

6.0.0

getLongitudeFromX01

public abstract double getLongitudeFromX01(double pX01)

getCleanMercator

public long getCleanMercator(long pMercator,
                             double pMercatorMapSize,
                             boolean wrapEnabled)

Since:

6.0.0

ClipToLong

public static long ClipToLong(double pValue,
                              double pMax,
                              boolean pWrapEnabled)

Since:

6.0.0

Clip

@Deprecated
public static long Clip(long n,
                                     long minValue,
                                     long maxValue)

Deprecated.

Since:

6.0.0

truncateToInt

public static int truncateToInt(long value)

Since:

6.0.0 Casts a long type value into an int with no harm. The typical use case is to compute pixel coordinates with high zoom (which won't fit into int but will fit into long) and to truncate them into int in order to display them on the screen (which requires int) The meaning of a pixel coordinate of MIN/MAX_VALUE is just: it's far far away and it doesn't crash the app

getMercatorFromGeo

public PointL getMercatorFromGeo(double pLatitude,
                                 double pLongitude,
                                 double pMapSize,
                                 PointL pReuse,
                                 boolean wrapEnabled)

Since:

6.0.0

getGeoFromMercator

public GeoPoint getGeoFromMercator(long pMercatorX,
                                   long pMercatorY,
                                   double pMapSize,
                                   GeoPoint pReuse,
                                   boolean horizontalWrapEnabled,
                                   boolean verticalWrapEnabled)

Since:

6.0.0

getXY01FromMercator

public double getXY01FromMercator(long pMercator,
                                  double pMapSize,
                                  boolean wrapEnabled)

Since:

6.0.0

getRandomLongitude

public double getRandomLongitude(double pRandom01)

Parameters:

pRandom01 - [0,1]

Since:

6.0.0

getRandomLatitude

public double getRandomLatitude(double pRandom01,
                                double pMinLatitude)

Parameters:

pRandom01 - [0,1]

Since:

6.0.0

getRandomLatitude

public double getRandomLatitude(double pRandom01)

Parameters:

pRandom01 - [0,1]

Since:

6.0.3

getTileFromMercator

public static int getTileFromMercator(long pMercator,
                                      double pTileSize)

Since:

6.0.0

getTileFromMercator

public static Rect getTileFromMercator(RectL pMercatorRect,
                                       double pTileSize,
                                       Rect pReuse)

Since:

6.0.0

getMercatorFromTile

public static long getMercatorFromTile(int pTile,
                                       double pTileSize)

Since:

6.0.0

getMinLatitude

public abstract double getMinLatitude()

Since:

6.0.2

getMaxLatitude

public abstract double getMaxLatitude()

Since:

6.0.2

getMinLongitude

public abstract double getMinLongitude()

Since:

6.0.2

getMaxLongitude

public abstract double getMaxLongitude()

Since:

6.0.2

cleanLongitude

public double cleanLongitude(double pLongitude)

Since:

6.0.2

cleanLatitude

public double cleanLatitude(double pLatitude)

Since:

6.0.2

isValidLongitude

public boolean isValidLongitude(double pLongitude)

Since:

6.0.2

isValidLatitude

public boolean isValidLatitude(double pLatitude)

Since:

6.0.2

toStringLongitudeSpan

public String toStringLongitudeSpan()

Since:

6.0.2

toStringLatitudeSpan

public String toStringLatitudeSpan()

Since:

6.0.2

getTileXFromLongitude

public int getTileXFromLongitude(double pLongitude,
                                 int pZoom)

Since:

6.0.3

getTileYFromLatitude

public int getTileYFromLatitude(double pLatitude,
                                int pZoom)

Since:

6.0.3

getLatitudeFromTileY

public double getLatitudeFromTileY(int pY,
                                   int pZoom)

Since:

6.0.3

getLongitudeFromTileX

public double getLongitudeFromTileX(int pX,
                                    int pZoom)

Since:

6.0.3