1 /*******************************************************************************
2 * Copyright (c) 2012 Association for Decentralized Information Management
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
10 * VTT Technical Research Centre of Finland - initial API and implementation
11 *******************************************************************************/
12 package org.simantics.maps.sg;
14 import java.awt.AlphaComposite;
15 import java.awt.Color;
16 import java.awt.Composite;
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.util.ArrayList;
29 import java.util.HashMap;
30 import java.util.HashSet;
31 import java.util.Hashtable;
32 import java.util.List;
34 import java.util.concurrent.Executors;
35 import java.util.concurrent.ScheduledExecutorService;
36 import java.util.concurrent.ScheduledFuture;
37 import java.util.concurrent.TimeUnit;
39 import org.simantics.maps.MapScalingTransform;
40 import org.simantics.maps.WebService;
41 import org.simantics.maps.osm.OSMTileProvider;
42 import org.simantics.maps.pojo.TileJobQueue;
43 import org.simantics.maps.prefs.MapsClientPreferences;
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 import org.slf4j.Logger;
53 import org.slf4j.LoggerFactory;
56 * @author Tuukka Lehtonen
58 public class MapNode extends G2DNode implements ITileListener {
60 private static final long serialVersionUID = 2490944880914577411L;
62 private static final Logger LOGGER = LoggerFactory.getLogger(MapNode.class);
64 //private final double MAP_SCALE = 1;
65 //private final int MAX_TILE_LEVEL = 19;
66 private final int TILE_PIXEL_SIZE = 256;
67 private final int VIEWBOX_QUIET_TIME = 500;
69 protected Boolean enabled = true;
70 protected Color backgroundColor;
79 class TileLevel extends HashSet<TileKey> {
80 private static final long serialVersionUID = 5743763238677223952L;
83 static class TileTraverser {
84 List<TileKey> tile = new ArrayList<TileKey>(4);
85 List<Integer> quadrant = new ArrayList<Integer>(4);
87 static int getTileQuadrant(TileKey k) {
91 return ((y & 1) == 0) ? 1 : 2;
93 return ((y & 1) == 0) ? 0 : 3;
101 void add(TileKey tile) {
103 this.quadrant.add(getTileQuadrant(tile));
110 TileKey getTile(int i) {
114 int getQuadrant(int i) {
115 return quadrant.get(i);
119 public class ObjectHolder<T>
125 public void set(T o) {
130 public final class Pair<T1, T2> {
131 public final T1 first;
132 public final T2 second;
133 public Pair(T1 first, T2 second) {
135 this.second = second;
139 private TileCache tileCache;
141 // For delaying the retrieval of map data until the viewport remains steady
142 private ScheduledFuture<?> pendingTileTask;
144 private Map<Integer, TileLevel> neededTiles = new HashMap<Integer, TileLevel>();
146 private TileTraverser tileTraverser = new TileTraverser();
148 private ITileJobQueue job = null;
150 private Map<TileKey, TileState> tileStates = new Hashtable<TileKey, TileState>();
151 private ObjectHolder<VolatileImage> notLoadedImage = new ObjectHolder<VolatileImage>();
152 private ObjectHolder<VolatileImage> loadingImage = new ObjectHolder<VolatileImage>();
153 private ObjectHolder<VolatileImage> notAvailableImage = new ObjectHolder<VolatileImage>();
155 private Font textFont = new Font(Font.SANS_SERIF, Font.BOLD, 40);
157 private AffineTransform oldTransform = new AffineTransform();
158 private final ScheduledExecutorService scheduler = Executors.newScheduledThreadPool(1);
160 private Composite normalComposite = AlphaComposite.SrcOver.derive(1f);
161 private Composite parentDataComposite = AlphaComposite.SrcOver.derive(0.75f);
163 private Rectangle2D helperRect = new Rectangle2D.Double();
165 ImageObserver observer = new ImageObserver() {
167 public boolean imageUpdate(Image img, int infoflags, int x, int y, int width, int height) {
168 // System.out.format("imageUpdate(%s, %d, %d, %d, %d, %d)\n", img.toString(), infoflags, x, y, width, height);
174 // Construct WebService from client properties
176 if (MapsClientPreferences.useBuiltinServer())
177 url = MapsClientPreferences.possibleBuiltinServerURL();
179 url = MapsClientPreferences.tileserverURL();
180 if (!url.endsWith("/"))
184 ITileProvider provider = new OSMTileProvider(new WebService(url), TILE_PIXEL_SIZE);
186 // Try to load eclipse specific implementation of TileJobQueue, if it doesn't exist, fall back to pojo implementation
188 Class<?> proxyClass = (Class<?>) Class.forName("org.simantics.maps.eclipse.TileJobQueue");
189 job = (ITileJobQueue)proxyClass.newInstance();
190 } catch (ClassNotFoundException e1) {
191 } catch (InstantiationException e) {
192 } catch (IllegalAccessException e) {
194 // AppletProxyUtil should exist always..
196 job = new TileJobQueue();
199 // Cache is also eclipse specific...
200 ITileProvider cachedProvider = null;
202 Class<?> proxyClass = (Class<?>) Class.forName("org.simantics.maps.eclipse.DiskCachingTileProvider");
203 cachedProvider = (ITileProvider)proxyClass.getConstructor(ITileProvider.class, Boolean.class).newInstance(provider, false);
204 } catch (ClassNotFoundException e1) {
205 } catch (InstantiationException e) {
206 } catch (IllegalAccessException e) {
209 if(cachedProvider != null) {
210 job.setTileProvider(cachedProvider);
212 job.setTileProvider(provider);
215 this.tileCache = new TileCache(job);
216 this.tileCache.addTileListener(this);
217 } catch(Exception e ) {
218 LOGGER.error("Failed to initialize MapNode", e);
222 @SyncField("enabled")
223 public void setEnabled(Boolean enabled) {
224 this.enabled = enabled;
227 @SyncField("backgroundColor")
228 public void setBackgroundColor(Color color) {
229 this.backgroundColor = color;
233 public void render(Graphics2D g2d) {
236 AffineTransform ot = g2d.getTransform();
237 //System.err.println("ot " + ot);
238 g2d.transform(transform);
240 AffineTransform tr = g2d.getTransform();
241 //System.err.println("tr " + tr);
242 // Graphics2D g = (Graphics2D)g2d.create();
243 // AffineTransform tr = (AffineTransform)g.getTransform().clone();
245 double scaleX = Math.abs(tr.getScaleX());
246 //System.err.println("scaleX : " + scaleX);
247 double scaleY = Math.abs(tr.getScaleY());
248 if (scaleX <= 0 || scaleY <= 0) {
249 // Make sure that we don't end up in an eternal loop below.
252 double offsetX = -tr.getTranslateX();
253 double offsetY = -tr.getTranslateY();
255 g2d.setRenderingHint(RenderingHints.KEY_ANTIALIASING, RenderingHints.VALUE_ANTIALIAS_ON);
257 Rectangle2D sp = localToControl(new Rectangle2D.Double(0.0, 0.0, 1.0, 1.0));
258 Rectangle2D b = (Rectangle2D)((Rectangle)g2d.getRenderingHint(G2DRenderingHints.KEY_CONTROL_BOUNDS)).getBounds2D(); // getClipBounds is not accurate enough, use original clipbounds and scale here
260 Rectangle2D viewbox = new Rectangle2D.Double(offsetX/scaleX, offsetY/scaleY, b.getWidth()/sp.getWidth(), b.getHeight()/sp.getHeight()); //g.getClipBounds();
263 int level = MapScalingTransform.zoomLevel(ot);
265 // double smallerViewboxDimension = viewbox.getWidth() < viewbox.getHeight() ? viewbox.getWidth() * MAP_SCALE : viewbox.getHeight() * MAP_SCALE;
267 // double tileSize = 360 * MAP_SCALE*2.5;
268 // while (level < MAX_TILE_LEVEL) {
269 // double ratio = smallerViewboxDimension / tileSize;
270 // if (ratio >= 0.85) {
277 * To convert y-coordinates to map coordinates in ruler, use:
278 * double val = (y-offsetY)/scaleY;
279 * val = Math.toDegrees(Math.atan(Math.sinh(Math.toRadians(val))));
280 * String str = formatValue(val);
283 double minx = Math.min(180, Math.max(viewbox.getMinX(), -180));
284 double maxx = Math.min(180, Math.max(viewbox.getMaxX(), -180));
286 double miny = Math.min(360, Math.max(viewbox.getMinY()+180, 0));
287 double maxy = Math.min(360, Math.max(viewbox.getMaxY()+180, 0));
288 //System.err.println("minx " + minx + " maxx " + maxx + " miny " + miny + " maxy " + maxy);
289 g2d.setTransform(new AffineTransform());
290 g2d.setRenderingHint(RenderingHints.KEY_INTERPOLATION, RenderingHints.VALUE_INTERPOLATION_BILINEAR);
292 int levels = (1 << level);
293 //System.err.println("level " + level);
294 //System.err.println("levels " + levels);
295 // http://wiki.openstreetmap.org/wiki/Slippy_map_tilenames
296 int left = (int)Math.floor( (minx + 180) / 360 * (1<<level) );
297 int right = (int)Math.floor( (maxx + 180) / 360 * (1<<level) );
298 int top = (int)Math.floor(miny / 360 * (1<<level));// (int)Math.floor( (1 - Math.log(Math.tan(Math.toRadians(miny)) + 1 / Math.cos(Math.toRadians(miny))) / Math.PI) / 2 * (1<<level) );
299 int bottom = (int)Math.floor(maxy / 360 * (1<<level));// (int)Math.floor( (1 - Math.log(Math.tan(Math.toRadians(maxy)) + 1 / Math.cos(Math.toRadians(maxy))) / Math.PI) / 2 * (1<<level) );
300 //System.err.println("left " + left + " right " + right + " bottom " + bottom + " top " + top);
301 double tsx = 360 / (double)levels; // Size of tile on zoom level
302 //System.err.println("tileSize " + tsx);
303 for (int tx = left; tx <= right; tx++) {
304 if (tx < 0 || tx >= levels)
306 for (int ty = top; ty <= bottom; ty++) {
307 if (ty < 0 || ty >= levels)
309 TileKey tile = new TileKey(level, tx, ty);
310 double y = (double) ty - (double) levels / 2; // In level 0 we have only one tile
312 paintTile(tileCache, g2d, tr, tile, tx * tsx - 180, y * tsx, tsx);
317 // Check if transform has changed
318 transformChanged(tr, level);
320 if (backgroundColor != null) {
321 g2d.setTransform(new AffineTransform());
322 Rectangle2D controlBounds = (Rectangle2D) g2d.getRenderingHint(G2DRenderingHints.KEY_CONTROL_BOUNDS);
323 Color color = g2d.getColor();
324 g2d.setColor(backgroundColor);
325 g2d.fill(controlBounds);
329 g2d.setTransform(ot);
333 public Rectangle2D getBoundsInLocal() {
337 private void paintTile(TileCache cache, Graphics2D g, AffineTransform userToScreenTransform, TileKey tile, double tx, double ty, double tileSize) {
338 GraphicsConfiguration gc = g.getDeviceConfiguration();
341 boolean usingParentData = false;
342 helperRect.setFrame(0, 0, TILE_PIXEL_SIZE, TILE_PIXEL_SIZE);
344 TileState state = tileStates.get(tile);
346 state = TileState.NOT_LOADED;
352 // The same logic applies both when the data has not been loaded
353 // or the data has been loaded previously, but may have been
354 // flushed from the cache.
355 img = cache.peek(tile);
357 // Either the data has never existed before or the cache has
358 // flushed this tile. Mark it as needed and try to use
359 // parent image instead.
362 Pair<TileKey, Image> p = findFirstAvailableParentTile(cache, tile, tileTraverser);
365 helperRect.setFrame(0, 0, img.getWidth(observer), img.getHeight(observer));
366 traverseRectangle(tileTraverser, helperRect);
367 usingParentData = true;
369 img = getNotLoadedImage(gc);
372 helperRect.setFrame(0, 0, img.getWidth(observer), img.getHeight(observer));
377 Pair<TileKey, Image> p = findFirstAvailableParentTile(cache, tile, tileTraverser);
380 helperRect.setFrame(0, 0, img.getWidth(observer), img.getHeight(observer));
381 traverseRectangle(tileTraverser, helperRect);
382 usingParentData = true;
384 img = getLoadingImage(gc);
388 case NOT_AVAILABLE: {
389 img = getMissingImage(gc);
393 throw new Error("Invalid tile state: " + state);
396 // Calculate where these user space coordinates are in the screen
397 // space and given them to drawImage().
398 Point2D helperPoint1 = new Point2D.Double(tx, ty);
399 Point2D helperPoint2 = new Point2D.Double(tx + tileSize, ty + tileSize);
400 userToScreenTransform.transform(helperPoint1, helperPoint1);
401 userToScreenTransform.transform(helperPoint2, helperPoint2);
403 int dx1 = (int) Math.round(helperPoint1.getX());
404 int dy1 = (int) Math.round(helperPoint1.getY());
405 int dx2 = (int) Math.round(helperPoint2.getX());
406 int dy2 = (int) Math.round(helperPoint2.getY());
408 int sx1 = (int) Math.round(helperRect.getMinX());
409 int sy1 = (int) Math.round(helperRect.getMinY());
410 int sx2 = (int) Math.round(helperRect.getMaxX());
411 int sy2 = (int) Math.round(helperRect.getMaxY());
413 if (usingParentData) {
414 g.setComposite(parentDataComposite);
416 g.setComposite(normalComposite);
418 g.drawImage(img, dx1, dy1, dx2, dy2, sx1, sy1, sx2, sy2, observer);
421 private void transformChanged(AffineTransform newTransform, final int level) {
422 // Cancel data fetching if the viewport changes.
423 AffineTransform ato = (AffineTransform) oldTransform;
424 AffineTransform atn = (AffineTransform) newTransform;
428 s1 = ato.getScaleX();
429 double s2 = atn.getScaleX();
431 if (Math.abs(ds) > 1e-6) {
432 if (pendingTileTask != null) {
433 pendingTileTask.cancel(false);
434 pendingTileTask = null;
436 Runnable r = new Runnable() {
439 // There was a quiet period of [delay] milliseconds.
440 // Now its time to start fetching the map data that has
441 // piled up into the queue.
442 loadNeededTiles(level);
445 pendingTileTask = scheduler.schedule(r, VIEWBOX_QUIET_TIME, TimeUnit.MILLISECONDS);
446 oldTransform = (AffineTransform)newTransform.clone();
448 loadNeededTiles(level);
452 private void loadNeededTiles(final int level) {
453 TileCache cache = this.tileCache;
455 // Remove all tile queries from the job queue that do not match the
456 // requested tile level. This helps speed up loading of the right tiles
457 // that should be shown to the user ASAP instead of spending time
458 // loading invisible tiles.
459 cache.filterJobQueue(new IFilter<TileKey>() {
461 public boolean select(TileKey tile) {
462 boolean result = (tile.getLevel() == level);
464 // System.out.println("FILTERED TILE: " + tile);
469 // Schedule retrieval of each tile on the current level.
471 synchronized (neededTiles) {
472 l = neededTiles.get(level);
475 if (l != null && !l.isEmpty()) {
476 for (TileKey k : l) {
477 tileStates.put(k, TileState.LOADING);
483 void needTile(TileKey t) {
484 synchronized (neededTiles) {
485 int level = t.getLevel();
486 TileLevel l = neededTiles.get(level);
489 neededTiles.put(level, l);
495 private Pair<TileKey, Image> findFirstAvailableParentTile(TileCache cache, TileKey tile, TileTraverser traverser) {
499 TileKey parent = getParentTile(tile);
500 while (parent != null) {
501 Image img = cache.peek(parent);
503 return new Pair<TileKey, Image>(parent, img);
504 traverser.add(parent);
505 parent = getParentTile(parent);
510 private TileKey getParentTile(TileKey k) {
511 if (k.getLevel() == 0)
513 return new TileKey(k.getLevel() - 1, k.getX() / 2, k.getY() / 2);
516 private void traverseRectangle(TileTraverser traverser, Rectangle2D rect) {
517 for (int i = traverser.size() - 1; i >= 0; --i) {
518 traverseToQuadrant(rect, traverser.getQuadrant(i));
522 private Rectangle2D traverseToQuadrant(Rectangle2D r, int quadrant) {
523 boolean left = quadrant == 1 || quadrant == 2;
524 boolean top = quadrant == 1 || quadrant == 0;
526 left ? r.getMinX() : r.getCenterX(),
527 top ? r.getMinY() : r.getCenterY(),
529 r.getHeight() / 2.0);
533 private synchronized VolatileImage getNotLoadedImage(GraphicsConfiguration gc) {
534 return validateImageWithCenteredText(gc, notLoadedImage, TILE_PIXEL_SIZE, "NOT LOADED", Color.LIGHT_GRAY, Color.BLACK);
537 private synchronized VolatileImage getLoadingImage(GraphicsConfiguration gc) {
538 return validateImageWithCenteredText(gc, loadingImage, TILE_PIXEL_SIZE, "LOADING", Color.BLUE, Color.BLACK);
541 private synchronized VolatileImage getMissingImage(GraphicsConfiguration gc) {
542 return validateImageWithCenteredText(gc, notAvailableImage, TILE_PIXEL_SIZE, "NOT AVAILABLE", Color.RED, Color.DARK_GRAY);
545 private void drawImageWithCenteredText(VolatileImage image, String str, Font font, Color color, Color bgColor) {
546 Graphics2D target = image.createGraphics();
547 Rectangle2D bb = target.getFontMetrics(font).getStringBounds(str, target);
549 target.setBackground(new Color(255,255,255,0));
550 int w = image.getWidth();
551 int h = image.getHeight();
553 target.setColor(Color.BLACK);
554 target.fillRect(0, 0, w, h);
555 target.setColor(bgColor);
556 target.fillRect(2, 2, w - 3, h - 3);
557 target.setRenderingHint(RenderingHints.KEY_ANTIALIASING, RenderingHints.VALUE_ANTIALIAS_ON);
558 target.setRenderingHint(RenderingHints.KEY_INTERPOLATION, RenderingHints.VALUE_INTERPOLATION_BICUBIC);
559 target.setRenderingHint(RenderingHints.KEY_ALPHA_INTERPOLATION, RenderingHints.VALUE_ALPHA_INTERPOLATION_QUALITY);
560 target.setRenderingHint(RenderingHints.KEY_TEXT_ANTIALIASING, RenderingHints.VALUE_TEXT_ANTIALIAS_ON);
561 target.setColor(color);
562 target.setFont(font);
563 target.drawString(str, (float) (((double)w - bb.getWidth()) / 2), (float) (((double)h + bb.getHeight()) / 2));
567 private VolatileImage validateImageWithCenteredText(GraphicsConfiguration gc, ObjectHolder<VolatileImage> container, int size, String text, Color textColor, Color bgColor) {
568 VolatileImage image = container.get();
570 int validateResult = image.validate(gc);
571 if (validateResult == VolatileImage.IMAGE_INCOMPATIBLE) {
573 } else if (validateResult == VolatileImage.IMAGE_OK) {
575 } else if (validateResult == VolatileImage.IMAGE_RESTORED) {
576 drawImageWithCenteredText(image, text, textFont, textColor, bgColor);
580 image = gc.createCompatibleVolatileImage(size, size);
581 container.set(image);
582 drawImageWithCenteredText(image, text, textFont, textColor, bgColor);
588 public void tileCanceled(TileKey key) {
589 tileStates.put(key, TileState.NOT_LOADED);
593 public void tileFailed(TileKey key, Throwable e) {
594 tileStates.put(key, TileState.NOT_AVAILABLE);
599 public void tileUpdated(TileKey key, Image image) {
600 tileStates.put(key, TileState.LOADED);