1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256
|
package tim.prune.gui.map;
import java.awt.Image;
import java.awt.image.ImageObserver;
import java.net.MalformedURLException;
import java.net.URL;
import tim.prune.config.Config;
/**
* Class responsible for managing the map tiles,
* including invoking the correct memory cacher(s) and/or disk cacher(s)
*/
public class MapTileManager implements ImageObserver
{
/** Consumer object to inform when tiles received */
private TileConsumer _consumer = null;
/** Current map source */
private MapSource _mapSource = null;
/** Array of tile caches, one per layer */
private MemTileCacher[] _tempCaches = null;
/** Flag for whether to download any tiles or just pull from disk */
private boolean _downloadTiles = true;
/** Flag for whether to return incomplete images or just pass to tile cache until they're done */
private boolean _returnIncompleteImages = false;
/** Number of layers */
private int _numLayers = -1;
/** Current zoom level */
private int _zoom = 0;
/** Number of tiles in each direction for this zoom level */
private int _numTileIndices = 1;
/**
* Constructor
* @param inConsumer consumer object to be notified
*/
public MapTileManager(TileConsumer inConsumer)
{
_consumer = inConsumer;
}
/**
* Recentre the map
* @param inZoom zoom level
* @param inTileX x coord of central tile
* @param inTileY y coord of central tile
*/
public void centreMap(int inZoom, int inTileX, int inTileY)
{
setZoom(inZoom);
// Pass params onto all memory cachers
if (_tempCaches != null) {
for (int i=0; i<_tempCaches.length; i++) {
_tempCaches[i].centreMap(inZoom, inTileX, inTileY);
}
}
}
/** @param inZoom zoom level to set */
public void setZoom(int inZoom)
{
_zoom = inZoom;
// Calculate number of tiles = 2^^zoom
_numTileIndices = 1 << _zoom;
}
/**
* @return true if zoom is too high for tiles
*/
public boolean isOverzoomed()
{
// Ask current map source what maximum zoom is
int maxZoom = (_mapSource == null?0:_mapSource.getMaxZoomLevel());
return (_zoom > maxZoom);
}
/**
* Enable or disable tile downloading
* @param inEnabled true to enable downloading, false to just get tiles from disk
*/
public void enableTileDownloading(boolean inEnabled)
{
_downloadTiles = inEnabled;
}
/** Configure to return incomplete images instead of going via caches (and another call) */
public void setReturnIncompleteImages()
{
_returnIncompleteImages = true;
}
/**
* Clear all the memory caches due to changed config / zoom
*/
public void clearMemoryCaches()
{
int numLayers = _mapSource.getNumLayers();
if (_tempCaches == null || _tempCaches.length != numLayers)
{
// Cachers don't match, so need to create the right number of them
_tempCaches = new MemTileCacher[numLayers];
for (int i=0; i<numLayers; i++) {
_tempCaches[i] = new MemTileCacher();
}
}
else {
// Cachers already there, just need to be cleared
for (int i=0; i<numLayers; i++) {
_tempCaches[i].clearAll();
}
}
}
/**
* @param inSourceNum selected map source index
*/
public void setMapSource(int inSourceNum)
{
setMapSource(MapSourceLibrary.getSource(inSourceNum));
}
/**
* @param inMapSource selected map source
*/
public void setMapSource(MapSource inMapSource)
{
_mapSource = inMapSource;
if (_mapSource == null) {_mapSource = MapSourceLibrary.getSource(0);}
clearMemoryCaches();
_numLayers = _mapSource.getNumLayers();
}
/**
* @return the number of layers in the map
*/
public int getNumLayers()
{
return _numLayers;
}
/**
* Get a tile from the currently selected map source
* @param inLayer layer number, starting from 0
* @param inX x index of tile
* @param inY y index of tile
* @param inDownloadIfNecessary true to download the file if it's not available
* @return selected tile if already loaded, or null otherwise
*/
public Image getTile(int inLayer, int inX, int inY, boolean inDownloadIfNecessary)
{
if (inY < 0 || inY >= _numTileIndices) return null;
// Wrap tile indices which are too big or too small
inX = ((inX % _numTileIndices) + _numTileIndices) % _numTileIndices;
// Check first in memory cache for tile
Image tile = null;
MemTileCacher tempCache = null;
if (_tempCaches != null)
{
tempCache = _tempCaches[inLayer]; // Should probably guard array indexes here
tile = tempCache.getTile(inX, inY);
if (tile != null) {
return tile;
}
}
// Tile wasn't in memory, but maybe it's in disk cache (if there is one)
String diskCachePath = Config.getConfigString(Config.KEY_DISK_CACHE);
boolean useDisk = (diskCachePath != null);
boolean onlineMode = Config.getConfigBoolean(Config.KEY_ONLINE_MODE);
if (useDisk)
{
tile = DiskTileCacher.getTile(diskCachePath, _mapSource.makeFilePath(inLayer, _zoom, inX, inY), onlineMode);
if (tile != null)
{
if (_returnIncompleteImages) {return tile;}
// Pass tile to memory cache
if (tempCache != null) {
tempCache.setTile(tile, inX, inY, _zoom);
}
if (tile.getWidth(this) > 0) {return tile;}
return null;
}
// else System.out.println("DTC gave null tile for " + _zoom + ", " + inX + ", " + inY);
}
// Tile wasn't in memory or on disk, so if online let's get it
if (onlineMode && _downloadTiles && inDownloadIfNecessary)
{
try
{
URL tileUrl = new URL(_mapSource.makeURL(inLayer, _zoom, inX, inY));
// System.out.println("Going to fetch: " + tileUrl);
if (useDisk && DiskTileCacher.saveTile(tileUrl, diskCachePath,
_mapSource.makeFilePath(inLayer, _zoom, inX, inY), this))
{
// Image now copied directly from URL stream to disk cache
}
else
{
// Load image asynchronously, using observer
// In order to set the http user agent, need to use a TileDownloader instead
TileDownloader.triggerLoad(this, tileUrl, inLayer, inX, inY, _zoom);
}
}
catch (MalformedURLException urle) {} // ignore
}
return null;
}
/**
* Method called by image loader to inform of updates to the tiles
* @param img the image
* @param infoflags flags describing how much of the image is known
* @param x ignored
* @param y ignored
* @param width ignored
* @param height ignored
* @return false to carry on loading, true to stop
*/
public boolean imageUpdate(Image img, int infoflags, int x, int y, int width, int height)
{
boolean loaded = (infoflags & ImageObserver.ALLBITS) > 0;
boolean error = (infoflags & ImageObserver.ERROR) > 0;
if (loaded || error) {
_consumer.tilesUpdated(loaded);
}
return !loaded;
}
/**
* Callback method from TileDownloader to let us know that an image has been loaded
* @param inTile Loaded Image object
* @param inLayer layer index from 0
* @param inX x coordinate of tile
* @param inY y coordinate of tile
* @param inZoom zoom level of loaded image
*/
public void notifyImageLoaded(Image inTile, int inLayer, int inX, int inY, int inZoom)
{
if (inTile != null && _tempCaches != null)
{
MemTileCacher tempCache = _tempCaches[inLayer]; // Should probably guard against nulls and array indexes here
if (tempCache.getTile(inX, inY) == null)
{
// Check with cache that the zoom level is still valid
tempCache.setTile(inTile, inX, inY, inZoom);
inTile.getWidth(this); // trigger imageUpdate when image is ready
}
}
else if (inTile != null) {
inTile.getWidth(this);
}
}
}
|