src/tim/prune/gui/map/MapTileManager.java

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