mil.nga.geopackage.map.tiles.overlay

Class BoundedOverlay

java.lang.Object

mil.nga.geopackage.map.tiles.overlay.BoundedOverlay

Direct Known Subclasses:

FeatureOverlay, GeoPackageOverlay, GoogleAPIGeoPackageOverlay

public abstract class BoundedOverlay
extends Object

Abstract overlay which provides bounding returned tiles by zoom levels and/or a bounding box

Since:

1.2.5

Constructor Summary

Constructors

Constructor and Description
BoundedOverlay() Constructor

Method Summary

Modifier and Type	Method and Description
BoundingBox	getBoundingBox(Projection projection) Get the bounding box as the provided projection
Integer	getMaxZoom() Get the max zoom
Integer	getMinZoom() Get the min zoom
Tile	getTile(int x, int y, int zoom)
BoundingBox	getWebMercatorBoundingBox() Get the web mercator bounding box
boolean	hasTile(int x, int y, int zoom) Determine if there is a tile for the x, y, and zoom
protected abstract boolean	hasTileToRetrieve(int x, int y, int zoom) Check if there is a tile to retrieve
boolean	isWithinBoundingBox(int x, int y, int zoom) Check if the tile request is within the desired tile bounds
boolean	isWithinBounds(int x, int y, int zoom) Is the tile within the zoom and bounding box bounds
boolean	isWithinZoom(float zoom) Check if the zoom is within the overlay zoom range
protected abstract Tile	retrieveTile(int x, int y, int zoom) Retrieve the tile
void	setBoundingBox(BoundingBox boundingBox, Projection projection) Set the bounding box, provided as the indicated projection
void	setMaxZoom(Integer maxZoom) Set the max zoom
void	setMinZoom(Integer minZoom) Set the min zoom

Methods inherited from class java.lang.Object

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

Constructor Detail

BoundedOverlay

public BoundedOverlay()

Constructor

Method Detail

getMinZoom

public Integer getMinZoom()

Get the min zoom

Returns:

setMinZoom

public void setMinZoom(Integer minZoom)

Set the min zoom

Parameters:

minZoom -

getMaxZoom

public Integer getMaxZoom()

Get the max zoom

Returns:

setMaxZoom

public void setMaxZoom(Integer maxZoom)

Set the max zoom

Parameters:

maxZoom -

setBoundingBox

public void setBoundingBox(BoundingBox boundingBox,
                           Projection projection)

Set the bounding box, provided as the indicated projection

Parameters:

boundingBox -

projection -

getWebMercatorBoundingBox

public BoundingBox getWebMercatorBoundingBox()

Get the web mercator bounding box

Returns:

getBoundingBox

public BoundingBox getBoundingBox(Projection projection)

Get the bounding box as the provided projection

Parameters:

projection -

getTile

public Tile getTile(int x,
                    int y,
                    int zoom)

hasTile

public boolean hasTile(int x,
                       int y,
                       int zoom)

Determine if there is a tile for the x, y, and zoom

Parameters:

x - x coordinate

y - y coordinate

zoom - zoom value

Returns:

true if there is a tile

Since:

1.2.6

hasTileToRetrieve

protected abstract boolean hasTileToRetrieve(int x,
                                             int y,
                                             int zoom)

Check if there is a tile to retrieve

Parameters:

x - x coordinate

y - y coordinate

zoom - zoom value

Returns:

true if there is a tile

retrieveTile

protected abstract Tile retrieveTile(int x,
                                     int y,
                                     int zoom)

Retrieve the tile

Parameters:

x -

y -

zoom -

Returns:

tile

isWithinBounds

public boolean isWithinBounds(int x,
                              int y,
                              int zoom)

Is the tile within the zoom and bounding box bounds

Parameters:

x -

y -

zoom -

Returns:

true if within bounds

isWithinZoom

public boolean isWithinZoom(float zoom)

Check if the zoom is within the overlay zoom range

Parameters:

zoom -

Returns:

isWithinBoundingBox

public boolean isWithinBoundingBox(int x,
                                   int y,
                                   int zoom)

Check if the tile request is within the desired tile bounds

Parameters:

x -

y -

zoom -

Returns: