org.simantics.district.maps/src/org/simantics/maps/sg/MapNode.java

   1 /*******************************************************************************
   2  * Copyright (c) 2012 Association for Decentralized Information Management
   3  * in Industry THTH ry.
   4  * All rights reserved. This program and the accompanying materials
   5  * are made available under the terms of the Eclipse Public License v1.0
   6  * which accompanies this distribution, and is available at
   7  * http://www.eclipse.org/legal/epl-v10.html
   8  *
   9  * Contributors:
  10  *     VTT Technical Research Centre of Finland - initial API and implementation
  11  *******************************************************************************/
  12 package org.simantics.maps.sg;
  13
  14 import java.awt.AlphaComposite;
  15 import java.awt.Color;
  16 import java.awt.Composite;
  17 import java.awt.Font;
  18 import java.awt.Graphics2D;
  19 import java.awt.GraphicsConfiguration;
  20 import java.awt.Image;
  21 import java.awt.Rectangle;
  22 import java.awt.RenderingHints;
  23 import java.awt.geom.AffineTransform;
  24 import java.awt.geom.Point2D;
  25 import java.awt.geom.Rectangle2D;
  26 import java.awt.image.ImageObserver;
  27 import java.awt.image.VolatileImage;
  28 import java.net.MalformedURLException;
  29 import java.net.URISyntaxException;
  30 import java.util.ArrayList;
  31 import java.util.HashMap;
  32 import java.util.HashSet;
  33 import java.util.Hashtable;
  34 import java.util.List;
  35 import java.util.Map;
  36 import java.util.concurrent.Executors;
  37 import java.util.concurrent.ScheduledExecutorService;
  38 import java.util.concurrent.ScheduledFuture;
  39 import java.util.concurrent.TimeUnit;
  40
  41 import org.simantics.maps.WebService;
  42 import org.simantics.maps.osm.OSMTileProvider;
  43 import org.simantics.maps.pojo.TileJobQueue;
  44 import org.simantics.maps.tile.IFilter;
  45 import org.simantics.maps.tile.ITileJobQueue;
  46 import org.simantics.maps.tile.ITileListener;
  47 import org.simantics.maps.tile.ITileProvider;
  48 import org.simantics.maps.tile.TileCache;
  49 import org.simantics.maps.tile.TileKey;
  50 import org.simantics.scenegraph.g2d.G2DNode;
  51 import org.simantics.scenegraph.g2d.G2DRenderingHints;
  52
  53 /**
  54  * @author Tuukka Lehtonen
  55  */
  56 public class MapNode extends G2DNode implements ITileListener  {
  57
  58     private static final long serialVersionUID = 2490944880914577411L;
  59
  60     private final double MAP_SCALE          = 1;
  61     private final int    MAX_TILE_LEVEL     = 19;
  62     private final int    TILE_PIXEL_SIZE    = 256;
  63     private final int    VIEWBOX_QUIET_TIME = 500;
  64
  65     protected Boolean enabled = true;
  66
  67     enum TileState {
  68         NOT_LOADED,
  69         LOADING,
  70         LOADED,
  71         NOT_AVAILABLE
  72     }
  73
  74     class TileLevel extends HashSet<TileKey> {
  75         private static final long serialVersionUID = 5743763238677223952L;
  76     }
  77
  78     static class TileTraverser {
  79         List<TileKey> tile = new ArrayList<TileKey>(4);
  80         List<Integer> quadrant = new ArrayList<Integer>(4);
  81
  82         static int getTileQuadrant(TileKey k) {
  83             int x = k.getX();
  84             int y = k.getY();
  85             if ((x & 1) == 0) {
  86                 return ((y & 1) == 0) ? 1 : 2;
  87             }
  88             return ((y & 1) == 0) ? 0 : 3;
  89         }
  90
  91         void clear() {
  92             tile.clear();
  93             quadrant.clear();
  94         }
  95
  96         void add(TileKey tile) {
  97             this.tile.add(tile);
  98             this.quadrant.add(getTileQuadrant(tile));
  99         }
 100
 101         int size() {
 102             return tile.size();
 103         }
 104
 105         TileKey getTile(int i) {
 106             return tile.get(i);
 107         }
 108
 109         int getQuadrant(int i) {
 110             return quadrant.get(i);
 111         }
 112     }
 113
 114     public class ObjectHolder<T>
 115     {
 116         private T o = null;
 117         public T get() {
 118             return o;
 119         }
 120         public void set(T o) {
 121             this.o = o;
 122         }
 123     }
 124
 125     public final class Pair<T1, T2> {
 126         public final T1 first;
 127         public final T2 second;
 128         public Pair(T1 first, T2 second) {
 129             this.first = first;
 130             this.second = second;
 131         }
 132     }
 133
 134     private TileCache                      tileCache;
 135
 136     // For delaying the retrieval of map data until the viewport remains steady
 137     private ScheduledFuture<?>             pendingTileTask;
 138
 139     private Map<Integer, TileLevel>        neededTiles          = new HashMap<Integer, TileLevel>();
 140
 141     private TileTraverser                  tileTraverser        = new TileTraverser();
 142
 143     private ITileJobQueue                  job                  = null;
 144
 145     private Map<TileKey, TileState>        tileStates           = new Hashtable<TileKey, TileState>();
 146     private ObjectHolder<VolatileImage>    notLoadedImage       = new ObjectHolder<VolatileImage>();
 147     private ObjectHolder<VolatileImage>    loadingImage         = new ObjectHolder<VolatileImage>();
 148     private ObjectHolder<VolatileImage>    notAvailableImage    = new ObjectHolder<VolatileImage>();
 149
 150     private Font                           textFont             = new Font(Font.SANS_SERIF, Font.BOLD, 40);
 151
 152         private AffineTransform                oldTransform         = new AffineTransform();
 153     private final ScheduledExecutorService scheduler            = Executors.newScheduledThreadPool(1);
 154
 155     private Composite                      normalComposite      = AlphaComposite.SrcOver.derive(1f);
 156     private Composite                      parentDataComposite  = AlphaComposite.SrcOver.derive(0.75f);
 157
 158     private Rectangle2D                    helperRect           = new Rectangle2D.Double();
 159
 160     ImageObserver observer = new ImageObserver() {
 161         @Override
 162         public boolean imageUpdate(Image img, int infoflags, int x, int y, int width, int height) {
 163 //            System.out.format("imageUpdate(%s, %d, %d, %d, %d, %d)\n", img.toString(), infoflags, x, y, width, height);
 164             return true;
 165         }
 166     };
 167
 168     private int scale;
 169
 170     public void init() {
 171         try {
 172             ITileProvider provider = new OSMTileProvider(new WebService("http://localhost:8080/mapbox-studio-osm-bright.tm2/"), TILE_PIXEL_SIZE);
 173
 174             // Try to load eclipse specific implementation of TileJobQueue, if it doesn't exist, fall back to pojo implementation
 175             try {
 176                 Class<?> proxyClass = (Class<?>) Class.forName("org.simantics.maps.eclipse.TileJobQueue");
 177                 job = (ITileJobQueue)proxyClass.newInstance();
 178             } catch (ClassNotFoundException e1) {
 179             } catch (InstantiationException e) {
 180             } catch (IllegalAccessException e) {
 181             }
 182             // AppletProxyUtil should exist always..
 183             if(job == null) {
 184                 job = new TileJobQueue();
 185             }
 186
 187             // Cache is also eclipse specific...
 188             ITileProvider cachedProvider = null;
 189             try {
 190                 Class<?> proxyClass = (Class<?>) Class.forName("org.simantics.maps.eclipse.DiskCachingTileProvider");
 191                 cachedProvider = (ITileProvider)proxyClass.getConstructor(ITileProvider.class, Boolean.class).newInstance(provider, false);
 192             } catch (ClassNotFoundException e1) {
 193             } catch (InstantiationException e) {
 194             } catch (IllegalAccessException e) {
 195             }
 196
 197             if(cachedProvider != null) {
 198                 job.setTileProvider(cachedProvider);
 199             } else {
 200                 job.setTileProvider(provider);
 201             }
 202
 203             this.tileCache = new TileCache(job);
 204             this.tileCache.addTileListener(this);
 205         } catch (MalformedURLException e) {
 206             // TODO Auto-generated catch block
 207             e.printStackTrace();
 208         } catch (URISyntaxException e) {
 209             // TODO Auto-generated catch block
 210             e.printStackTrace();
 211         } catch(Exception e ) {
 212             e.printStackTrace();
 213         }
 214     }
 215
 216     @SyncField("enabled")
 217     public void setEnabled(Boolean enabled) {
 218         this.enabled = enabled;
 219     }
 220
 221     @Override
 222     public void render(Graphics2D g2d) {
 223         if (!enabled)
 224             return;
 225
 226         Graphics2D g = (Graphics2D)g2d.create();
 227
 228         AffineTransform tr = (AffineTransform)g.getTransform().clone();
 229
 230         double scaleX = Math.abs(tr.getScaleX());
 231         double scaleY = Math.abs(tr.getScaleY());
 232         if (scaleX <= 0 || scaleY <= 0) {
 233             // Make sure that we don't end up in an eternal loop below.
 234             return;
 235         }
 236         double offsetX = -tr.getTranslateX();
 237         double offsetY = -tr.getTranslateY();
 238
 239         g.setRenderingHint(RenderingHints.KEY_ANTIALIASING, RenderingHints.VALUE_ANTIALIAS_ON);
 240
 241         Rectangle2D sp = localToControl(new Rectangle2D.Double(0.0, 0.0, 1.0, 1.0));
 242         Rectangle2D b = (Rectangle2D)((Rectangle)g.getRenderingHint(G2DRenderingHints.KEY_CONTROL_BOUNDS)).getBounds2D(); // getClipBounds is not accurate enough, use original clipbounds and scale here
 243
 244         Rectangle2D viewbox = new Rectangle2D.Double(offsetX/scaleX, offsetY/scaleY, b.getWidth()/sp.getWidth(), b.getHeight()/sp.getHeight()); //g.getClipBounds();
 245         if(viewbox == null) return; // FIXME
 246
 247         double smallerViewboxDimension = viewbox.getWidth() < viewbox.getHeight() ? viewbox.getWidth() * MAP_SCALE : viewbox.getHeight() * MAP_SCALE;
 248         int level = 0;
 249         double tileSize = get360Scaled() * MAP_SCALE*2;
 250         while (level < MAX_TILE_LEVEL) {
 251             double ratio = smallerViewboxDimension / tileSize;
 252             if (ratio >= 0.85) {
 253                 break;
 254             }
 255             tileSize *= 0.5;
 256             level++;
 257         }
 258
 259         /*
 260          *  To convert y-coordinates to map coordinates in ruler, use:
 261          *    double val = (y-offsetY)/scaleY;
 262          *    val = Math.toDegrees(Math.atan(Math.sinh(Math.toRadians(val))));
 263          *    String str = formatValue(val);
 264          */
 265
 266         double minx = Math.min(get180Scaled(), Math.max(viewbox.getMinX(), -get180Scaled()));
 267         double maxx = Math.min(get180Scaled(), Math.max(viewbox.getMaxX(), -get180Scaled()));
 268
 269         double miny = Math.min(get360Scaled(), Math.max(viewbox.getMinY()+get180Scaled(), 0));
 270         double maxy = Math.min(get360Scaled(), Math.max(viewbox.getMaxY()+get180Scaled(), 0));
 271
 272         g.setTransform(new AffineTransform());
 273         g.setRenderingHint(RenderingHints.KEY_INTERPOLATION, RenderingHints.VALUE_INTERPOLATION_BILINEAR);
 274
 275         int levels = (1 << level);
 276
 277         // http://wiki.openstreetmap.org/wiki/Slippy_map_tilenames
 278         int left = (int)Math.floor( (minx + get180Scaled()) / get360Scaled() * (1<<level) );
 279         int right = (int)Math.floor( (maxx + get180Scaled()) / get360Scaled() * (1<<level) );
 280         int top = (int)Math.floor(miny / get360Scaled() * (1<<level));//  (int)Math.floor( (1 - Math.log(Math.tan(Math.toRadians(miny)) + 1 / Math.cos(Math.toRadians(miny))) / Math.PI) / 2 * (1<<level) );
 281         int bottom = (int)Math.floor(maxy / get360Scaled() * (1<<level));//  (int)Math.floor( (1 - Math.log(Math.tan(Math.toRadians(maxy)) + 1 / Math.cos(Math.toRadians(maxy))) / Math.PI) / 2 * (1<<level) );
 282
 283         double tsx = get360Scaled() / (double)levels; // Size of tile on zoom level
 284         for(int tx = left; tx <= right; tx++) {
 285             if(tx < 0 || tx >= levels) continue;
 286             for(int ty = top; ty <= bottom; ty++) {
 287                 if(ty < 0 || ty >= levels) continue;
 288                 TileKey tile = new TileKey(level, tx, ty);
 289                 double y = (double)ty - (double)levels/2; // In level 0 we have only one tile
 290                 paintTile(tileCache, g, tr, tile, tx*tsx-get180Scaled(), y*tsx, tsx);
 291             }
 292         }
 293         g.dispose();
 294
 295         // Check if transform has changed
 296         transformChanged(tr, level);
 297     }
 298
 299     private double get360Scaled() {
 300         return 360 * scale;
 301     }
 302
 303     private double get180Scaled() {
 304         return 180 * scale;
 305     }
 306
 307     @Override
 308     public Rectangle2D getBoundsInLocal() {
 309         return null;
 310     }
 311
 312     private void paintTile(TileCache cache, Graphics2D g, AffineTransform userToScreenTransform, TileKey tile, double tx, double ty, double tileSize) {
 313         GraphicsConfiguration gc = g.getDeviceConfiguration();
 314
 315         Image img = null;
 316         boolean usingParentData = false;
 317         helperRect.setFrame(0, 0, TILE_PIXEL_SIZE, TILE_PIXEL_SIZE);
 318
 319         TileState state = tileStates.get(tile);
 320         if (state == null)
 321             state = TileState.NOT_LOADED;
 322
 323         switch (state) {
 324             case NOT_LOADED:
 325             case LOADED:
 326             {
 327                 // The same logic applies both when the data has not been loaded
 328                 // or the data has been loaded previously, but may have been
 329                 // flushed from the cache.
 330                 img = cache.peek(tile);
 331                 if (img == null) {
 332                     // Either the data has never existed before or the cache has
 333                     // flushed this tile. Mark it as needed and try to use
 334                     // parent image instead.
 335                     needTile(tile);
 336
 337                     Pair<TileKey, Image> p = findFirstAvailableParentTile(cache, tile, tileTraverser);
 338                     if (p != null) {
 339                         img = p.second;
 340                         helperRect.setFrame(0, 0, img.getWidth(observer), img.getHeight(observer));
 341                         traverseRectangle(tileTraverser, helperRect);
 342                         usingParentData = true;
 343                     } else {
 344                         img = getNotLoadedImage(gc);
 345                     }
 346                 } else {
 347                     helperRect.setFrame(0, 0, img.getWidth(observer), img.getHeight(observer));
 348                 }
 349                 break;
 350             }
 351             case LOADING: {
 352                 Pair<TileKey, Image> p = findFirstAvailableParentTile(cache, tile, tileTraverser);
 353                 if (p != null) {
 354                     img = p.second;
 355                     helperRect.setFrame(0, 0, img.getWidth(observer), img.getHeight(observer));
 356                     traverseRectangle(tileTraverser, helperRect);
 357                     usingParentData = true;
 358                 } else {
 359                     img = getLoadingImage(gc);
 360                 }
 361                 break;
 362             }
 363             case NOT_AVAILABLE: {
 364                 img = getMissingImage(gc);
 365                 break;
 366             }
 367             default:
 368                 throw new Error("Invalid tile state: " + state);
 369         }
 370
 371         // Calculate where these user space coordinates are in the screen
 372         // space and given them to drawImage().
 373         Point2D     helperPoint1  = new Point2D.Double(tx, ty);
 374         Point2D     helperPoint2  = new Point2D.Double(tx + tileSize, ty + tileSize);
 375         userToScreenTransform.transform(helperPoint1, helperPoint1);
 376         userToScreenTransform.transform(helperPoint2, helperPoint2);
 377
 378         int dx1 = (int) Math.round(helperPoint1.getX());
 379         int dy1 = (int) Math.round(helperPoint1.getY());
 380         int dx2 = (int) Math.round(helperPoint2.getX());
 381         int dy2 = (int) Math.round(helperPoint2.getY());
 382
 383         int sx1 = (int) Math.round(helperRect.getMinX());
 384         int sy1 = (int) Math.round(helperRect.getMinY());
 385         int sx2 = (int) Math.round(helperRect.getMaxX());
 386         int sy2 = (int) Math.round(helperRect.getMaxY());
 387
 388         if (usingParentData) {
 389             g.setComposite(parentDataComposite);
 390         } else {
 391             g.setComposite(normalComposite);
 392         }
 393         g.drawImage(img, dx1, dy1, dx2, dy2, sx1, sy1, sx2, sy2, observer);
 394     }
 395
 396     private void transformChanged(AffineTransform newTransform, final int level) {
 397         // Cancel data fetching if the viewport changes.
 398         AffineTransform ato = (AffineTransform) oldTransform;
 399         AffineTransform atn = (AffineTransform) newTransform;
 400
 401         double s1 = -1;
 402         if (ato != null)
 403             s1 = ato.getScaleX();
 404         double s2 = atn.getScaleX();
 405         double ds = s2 - s1;
 406         if (Math.abs(ds) > 1e-6) {
 407             if (pendingTileTask != null) {
 408                 pendingTileTask.cancel(false);
 409                 pendingTileTask = null;
 410             }
 411             Runnable r = new Runnable() {
 412                 @Override
 413                 public void run() {
 414                     // There was a quiet period of [delay] milliseconds.
 415                     // Now its time to start fetching the map data that has
 416                     // piled up into the queue.
 417                     loadNeededTiles(level);
 418                 }
 419             };
 420             pendingTileTask = scheduler.schedule(r, VIEWBOX_QUIET_TIME, TimeUnit.MILLISECONDS);
 421             oldTransform = (AffineTransform)newTransform.clone();
 422         } else {
 423             loadNeededTiles(level);
 424         }
 425     }
 426
 427     private void loadNeededTiles(final int level) {
 428         TileCache cache = this.tileCache;
 429
 430         // Remove all tile queries from the job queue that do not match the
 431         // requested tile level. This helps speed up loading of the right tiles
 432         // that should be shown to the user ASAP instead of spending time
 433         // loading invisible tiles.
 434         cache.filterJobQueue(new IFilter<TileKey>() {
 435             @Override
 436             public boolean select(TileKey tile) {
 437                 boolean result = (tile.getLevel() == level);
 438                 //if (!result)
 439                 //    System.out.println("FILTERED TILE: " + tile);
 440                 return result;
 441             }
 442         });
 443
 444         // Schedule retrieval of each tile on the current level.
 445         TileLevel l = null;
 446         synchronized (neededTiles) {
 447             l = neededTiles.get(level);
 448             neededTiles.clear();
 449         }
 450         if (l != null && !l.isEmpty()) {
 451             for (TileKey k : l) {
 452                 tileStates.put(k, TileState.LOADING);
 453                 tileCache.get(k);
 454             }
 455         }
 456     }
 457
 458     void needTile(TileKey t) {
 459         synchronized (neededTiles) {
 460             int level = t.getLevel();
 461             TileLevel l = neededTiles.get(level);
 462             if (l == null) {
 463                 l = new TileLevel();
 464                 neededTiles.put(level, l);
 465             }
 466             l.add(t);
 467         }
 468     }
 469
 470     private Pair<TileKey, Image> findFirstAvailableParentTile(TileCache cache, TileKey tile, TileTraverser traverser) {
 471         traverser.clear();
 472         traverser.add(tile);
 473
 474         TileKey parent = getParentTile(tile);
 475         while (parent != null) {
 476             Image img = cache.peek(parent);
 477             if (img != null)
 478                 return new Pair<TileKey, Image>(parent, img);
 479             traverser.add(parent);
 480             parent = getParentTile(parent);
 481         }
 482         return null;
 483     }
 484
 485     private TileKey getParentTile(TileKey k) {
 486         if (k.getLevel() == 0)
 487             return null;
 488         return new TileKey(k.getLevel() - 1, k.getX() / 2, k.getY() / 2);
 489     }
 490
 491     private void traverseRectangle(TileTraverser traverser, Rectangle2D rect) {
 492         for (int i = traverser.size() - 1; i >= 0; --i) {
 493             traverseToQuadrant(rect, traverser.getQuadrant(i));
 494         }
 495     }
 496
 497     private Rectangle2D traverseToQuadrant(Rectangle2D r, int quadrant) {
 498         boolean left = quadrant == 1 || quadrant == 2;
 499         boolean top = quadrant == 1 || quadrant == 0;
 500         r.setFrame(
 501                 left ? r.getMinX() : r.getCenterX(),
 502                 top ? r.getMinY() : r.getCenterY(),
 503                 r.getWidth() / 2.0,
 504                 r.getHeight() / 2.0);
 505         return r;
 506     }
 507
 508     private synchronized VolatileImage getNotLoadedImage(GraphicsConfiguration gc) {
 509         return validateImageWithCenteredText(gc, notLoadedImage, TILE_PIXEL_SIZE, "NOT LOADED", Color.LIGHT_GRAY, Color.BLACK);
 510     }
 511
 512     private synchronized VolatileImage getLoadingImage(GraphicsConfiguration gc) {
 513         return validateImageWithCenteredText(gc, loadingImage, TILE_PIXEL_SIZE, "LOADING", Color.BLUE, Color.BLACK);
 514     }
 515
 516     private synchronized VolatileImage getMissingImage(GraphicsConfiguration gc) {
 517         return validateImageWithCenteredText(gc, notAvailableImage, TILE_PIXEL_SIZE, "NOT AVAILABLE", Color.RED, Color.DARK_GRAY);
 518     }
 519
 520     private void drawImageWithCenteredText(VolatileImage image, String str, Font font, Color color, Color bgColor) {
 521         Graphics2D target = image.createGraphics();
 522         Rectangle2D bb = target.getFontMetrics(font).getStringBounds(str, target);
 523
 524         target.setBackground(new Color(255,255,255,0));
 525         int w = image.getWidth();
 526         int h = image.getHeight();
 527
 528         target.setColor(Color.BLACK);
 529         target.fillRect(0, 0, w, h);
 530         target.setColor(bgColor);
 531         target.fillRect(2, 2, w - 3, h - 3);
 532         target.setRenderingHint(RenderingHints.KEY_ANTIALIASING, RenderingHints.VALUE_ANTIALIAS_ON);
 533         target.setRenderingHint(RenderingHints.KEY_INTERPOLATION, RenderingHints.VALUE_INTERPOLATION_BICUBIC);
 534         target.setRenderingHint(RenderingHints.KEY_ALPHA_INTERPOLATION, RenderingHints.VALUE_ALPHA_INTERPOLATION_QUALITY);
 535         target.setRenderingHint(RenderingHints.KEY_TEXT_ANTIALIASING, RenderingHints.VALUE_TEXT_ANTIALIAS_ON);
 536         target.setColor(color);
 537         target.setFont(font);
 538         target.drawString(str, (float) (((double)w - bb.getWidth()) / 2), (float) (((double)h + bb.getHeight()) / 2));
 539         target.dispose();
 540     }
 541
 542     private VolatileImage validateImageWithCenteredText(GraphicsConfiguration gc, ObjectHolder<VolatileImage> container, int size, String text, Color textColor, Color bgColor) {
 543         VolatileImage image = container.get();
 544         if (image != null) {
 545             int validateResult = image.validate(gc);
 546             if (validateResult == VolatileImage.IMAGE_INCOMPATIBLE) {
 547                 image = null;
 548             } else if (validateResult == VolatileImage.IMAGE_OK) {
 549                 return image;
 550             } else if (validateResult == VolatileImage.IMAGE_RESTORED) {
 551                 drawImageWithCenteredText(image, text, textFont, textColor, bgColor);
 552             }
 553         }
 554         if (image == null) {
 555             image = gc.createCompatibleVolatileImage(size, size);
 556             container.set(image);
 557             drawImageWithCenteredText(image, text, textFont, textColor, bgColor);
 558         }
 559         return image;
 560     }
 561
 562     @Override
 563     public void tileCanceled(TileKey key) {
 564         tileStates.put(key, TileState.NOT_LOADED);
 565     }
 566
 567     @Override
 568     public void tileFailed(TileKey key, Throwable e) {
 569         tileStates.put(key, TileState.NOT_AVAILABLE);
 570         repaint();
 571     }
 572
 573     @Override
 574     public void tileUpdated(TileKey key, Image image) {
 575         tileStates.put(key, TileState.LOADED);
 576         repaint();
 577     }
 578
 579     public void setScale(int scale) {
 580         this.scale = scale;
 581     }
 582
 583 }