org.osmdroid.util

Class TileSystem

java.lang.Object

org.osmdroid.util.TileSystem

public final 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
static double	MaxLongitude
static double	MinLatitude
static double	MinLongitude

Constructor Summary

Constructors

Constructor and Description
TileSystem()

Method Summary

Modifier and Type	Method and Description
static double	Clip(double n, double minValue, double maxValue)
static long	Clip(long n, long minValue, long maxValue)
static long	ClipToLong(double value, double max, boolean wrapEnabled)
static double	getBoundingBoxZoom(BoundingBox pBoundingBox, int pScreenWidth, int pScreenHeight)
static long	getCleanMercator(long pMercator, double pMercatorMapSize, boolean wrapEnabled)
static double	getFactor(double pZoomLevel)
static GeoPoint	getGeoFromMercator(long pMercatorX, long pMercatorY, double pMapSize, GeoPoint pReuse, boolean horizontalWrapEnabled, boolean verticalWrapEnabled)
static int	getInputTileZoomLevel(double pZoomLevel)
static 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 ...
static double	getLatitudeZoom(double pNorth, double pSouth, int pScreenHeight)
static 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 ...
static double	getLongitudeZoom(double pEast, double pWest, int pScreenWidth)
static PointL	getMercatorFromGeo(double pLatitude, double pLongitude, double pMapSize, PointL pReuse, boolean wrapEnabled)
static long	getMercatorFromTile(int pTile, double pTileSize)
static long	getMercatorFromXY01(double pXY01, double pMapSize, boolean wrapEnabled)
static long	getMercatorXFromLongitude(double pLongitude, double pMapSize, boolean wrapEnabled)
static long	getMercatorYFromLatitude(double pLatitude, double pMapSize, boolean wrapEnabled)
static double	getRandomLatitude(double pRandom01, double pMinLatitude)
static 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)
static 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
static double	getX01FromLongitudeWithoutWrap(double longitude) Converts a longitude to its "X01" value, Same as getX01FromLongitude but without wrap
static double	getXY01FromMercator(long pMercator, double pMapSize, boolean wrapEnabled)
static 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	getY01FromLatitudeWithoutWrap(double latitude) Converts a latitude to its "Y01" value, Same as getY01FromLatitude but without wrap
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
static PointL	LatLongToPixelXY(double latitude, double longitude, double zoomLevel, PointL reuse) Deprecated.
static Point	LatLongToPixelXY(double latitude, double longitude, int levelOfDetail, Point reuse) Deprecated.
static 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.
static GeoPoint	PixelXYToLatLong(int pixelX, int pixelY, double zoomLevel, GeoPoint reuse) Deprecated.
static GeoPoint	PixelXYToLatLong(int pixelX, int pixelY, int levelOfDetail, GeoPoint reuse) Deprecated.
static GeoPoint	PixelXYToLatLongMapSize(int pixelX, int pixelY, double mapSize, GeoPoint reuse, boolean horizontalWrapEnabled, boolean verticalWrapEnabled) Deprecated.
static GeoPoint	PixelXYToLatLongMapSizeWithoutWrap(int pixelX, int pixelY, double mapSize, GeoPoint reuse)
static GeoPoint	PixelXYToLatLongWithoutWrap(int pixelX, int pixelY, double zoomLevel, GeoPoint reuse)
static Point	PixelXYToTileXY(int pPixelX, int pPixelY, double pTileSize, Point pReuse) Deprecated.
static Point	PixelXYToTileXY(int pixelX, int pixelY, Point reuse) Deprecated.
static Rect	PixelXYToTileXY(Rect rect, double pTileSize, Rect pReuse) Deprecated.
static Point	QuadKeyToTileXY(String quadKey, Point reuse)
static void	setTileSize(int tileSize)
static PointL	TileXYToPixelXY(int pTileX, int pTileY, double pTileSize, PointL pReuse) Deprecated.
static Point	TileXYToPixelXY(int tileX, int tileY, Point reuse) Deprecated.
static String	TileXYToQuadKey(int tileX, int tileY, int levelOfDetail)
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

public static final double MinLatitude

See Also:

Constant Field Values

MaxLatitude

public static final double MaxLatitude

See Also:

Constant Field Values

MinLongitude

public static final double MinLongitude

See Also:

Constant Field Values

MaxLongitude

public static final double MaxLongitude

See Also:

Constant Field Values

Constructor Detail

TileSystem

public TileSystem()

Method Detail

setTileSize

public static void setTileSize(int tileSize)

See Also:

TileSystem.setTileSize(int)

getTileSize

public static int getTileSize()

See Also:

TileSystem.getTileSize()

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.

See Also:

TileSystem.MapSize(int)

MapSize

public static double MapSize(double pZoomLevel)

Since:

6.0.0

See Also:

TileSystem.MapSize(int)

getFactor

public static double getFactor(double pZoomLevel)

Since:

6.0.0

GroundResolution

public static double GroundResolution(double latitude,
                                      int levelOfDetail)

See Also:

TileSystem.GroundResolution(double, int)

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

See Also:

TileSystem.GroundResolution(double, int)

MapScale

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

See Also:

TileSystem.MapScale(double, int, int)

LatLongToPixelXY

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

Deprecated.

See Also:

TileSystem.LatLongToPixelXY(double, double, int, Point)

LatLongToPixelXY

@Deprecated
public static 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 static 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 static GeoPoint PixelXYToLatLong(int pixelX,
                                                     int pixelY,
                                                     int levelOfDetail,
                                                     GeoPoint reuse)

Deprecated.

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

PixelXYToLatLong

@Deprecated
public static 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 static GeoPoint PixelXYToLatLongWithoutWrap(int pixelX,
                                                   int pixelY,
                                                   double zoomLevel,
                                                   GeoPoint reuse)

Since:

6.0.0 Same as PixelXYToLatLong but without wrap

getX01FromLongitude

public static 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 static 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

getX01FromLongitudeWithoutWrap

public static double getX01FromLongitudeWithoutWrap(double longitude)

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

Since:

6.0.0

getY01FromLatitudeWithoutWrap

public static double getY01FromLatitudeWithoutWrap(double latitude)

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

Since:

6.0.0

PixelXYToLatLongMapSize

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

Deprecated.

Since:

6.0.0

See Also:

Use {@link TileSystem#getGeoFromMercator(long, long, double, GeoPoint, boolean, boolean)} instead

PixelXYToLatLongMapSizeWithoutWrap

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

Since:

6.0.0 Same as PixelXYToLatLongMapSize but without wrap

See Also:

TileSystem.PixelXYToLatLong(int, int, int, GeoPoint)

Clip

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

Since:

6.0.0

See Also:

TileSystem.Clip(double, double, double)

PixelXYToTileXY

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

Deprecated.

PixelXYToTileXY

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

Deprecated.

Since:

6.0.0

See Also:

Use {@link TileSystem#getTileFromMercator(long, double)} instead

PixelXYToTileXY

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

Deprecated.

Since:

6.0.0 Use getTileFromMercator(long, double) instead

TileXYToPixelXY

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

Deprecated.

TileXYToPixelXY

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

Deprecated.

Since:

6.0.0

See Also:

Use {@link TileSystem#getMercatorFromTile(int, double)} instead

TileXYToQuadKey

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

See Also:

TileSystem.TileXYToQuadKey(int, int, int)

QuadKeyToTileXY

public static Point QuadKeyToTileXY(String quadKey,
                                    Point reuse)

See Also:

TileSystem.QuadKeyToTileXY(String, Point)

getBoundingBoxZoom

public static 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 static 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 static 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 static long getMercatorYFromLatitude(double pLatitude,
                                            double pMapSize,
                                            boolean wrapEnabled)

Since:

6.0.0

getMercatorXFromLongitude

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

Since:

6.0.0

getMercatorFromXY01

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

Since:

6.0.0

getLatitudeFromY01

public static 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

getLongitudeFromX01

public static 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

getCleanMercator

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

Since:

6.0.0

ClipToLong

public static long ClipToLong(double value,
                              double max,
                              boolean wrapEnabled)

Since:

6.0.0

Clip

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

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 static PointL getMercatorFromGeo(double pLatitude,
                                        double pLongitude,
                                        double pMapSize,
                                        PointL pReuse,
                                        boolean wrapEnabled)

Since:

6.0.0

getGeoFromMercator

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

Since:

6.0.0

getXY01FromMercator

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

Since:

6.0.0

getRandomLongitude

public static double getRandomLongitude(double pRandom01)

Parameters:

pRandom01 - [0,1]

Since:

6.0.0

getRandomLatitude

public static double getRandomLatitude(double pRandom01,
                                       double pMinLatitude)

Parameters:

pRandom01 - [0,1]

Since:

6.0.0

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