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.WebService;
40 import org.simantics.maps.osm.OSMTileProvider;
41 import org.simantics.maps.pojo.TileJobQueue;
42 import org.simantics.maps.prefs.MapsClientPreferences;
43 import org.simantics.maps.tile.IFilter;
44 import org.simantics.maps.tile.ITileJobQueue;
45 import org.simantics.maps.tile.ITileListener;
46 import org.simantics.maps.tile.ITileProvider;
47 import org.simantics.maps.tile.TileCache;
48 import org.simantics.maps.tile.TileKey;
49 import org.simantics.scenegraph.g2d.G2DNode;
50 import org.simantics.scenegraph.g2d.G2DRenderingHints;
51 import org.slf4j.Logger;
52 import org.slf4j.LoggerFactory;
55 * @author Tuukka Lehtonen
57 public class MapNode extends G2DNode implements ITileListener {
59 private static final long serialVersionUID = 2490944880914577411L;
61 private static final Logger LOGGER = LoggerFactory.getLogger(MapNode.class);
63 private final double MAP_SCALE = 1;
64 private final int MAX_TILE_LEVEL = 19;
65 private final int TILE_PIXEL_SIZE = 256;
66 private final int VIEWBOX_QUIET_TIME = 500;
68 protected Boolean enabled = true;
69 protected Color backgroundColor;
78 class TileLevel extends HashSet<TileKey> {
79 private static final long serialVersionUID = 5743763238677223952L;
82 static class TileTraverser {
83 List<TileKey> tile = new ArrayList<TileKey>(4);
84 List<Integer> quadrant = new ArrayList<Integer>(4);
86 static int getTileQuadrant(TileKey k) {
90 return ((y & 1) == 0) ? 1 : 2;
92 return ((y & 1) == 0) ? 0 : 3;
100 void add(TileKey tile) {
102 this.quadrant.add(getTileQuadrant(tile));
109 TileKey getTile(int i) {
113 int getQuadrant(int i) {
114 return quadrant.get(i);
118 public class ObjectHolder<T>
124 public void set(T o) {
129 public final class Pair<T1, T2> {
130 public final T1 first;
131 public final T2 second;
132 public Pair(T1 first, T2 second) {
134 this.second = second;
138 private TileCache tileCache;
140 // For delaying the retrieval of map data until the viewport remains steady
141 private ScheduledFuture<?> pendingTileTask;
143 private Map<Integer, TileLevel> neededTiles = new HashMap<Integer, TileLevel>();
145 private TileTraverser tileTraverser = new TileTraverser();
147 private ITileJobQueue job = null;
149 private Map<TileKey, TileState> tileStates = new Hashtable<TileKey, TileState>();
150 private ObjectHolder<VolatileImage> notLoadedImage = new ObjectHolder<VolatileImage>();
151 private ObjectHolder<VolatileImage> loadingImage = new ObjectHolder<VolatileImage>();
152 private ObjectHolder<VolatileImage> notAvailableImage = new ObjectHolder<VolatileImage>();
154 private Font textFont = new Font(Font.SANS_SERIF, Font.BOLD, 40);
156 private AffineTransform oldTransform = new AffineTransform();
157 private final ScheduledExecutorService scheduler = Executors.newScheduledThreadPool(1);
159 private Composite normalComposite = AlphaComposite.SrcOver.derive(1f);
160 private Composite parentDataComposite = AlphaComposite.SrcOver.derive(0.75f);
162 private Rectangle2D helperRect = new Rectangle2D.Double();
164 ImageObserver observer = new ImageObserver() {
166 public boolean imageUpdate(Image img, int infoflags, int x, int y, int width, int height) {
167 // System.out.format("imageUpdate(%s, %d, %d, %d, %d, %d)\n", img.toString(), infoflags, x, y, width, height);
173 // Construct WebService from client properties
175 if (MapsClientPreferences.useBuiltinServer())
176 url = MapsClientPreferences.possibleBuiltinServerURL();
178 url = MapsClientPreferences.tileserverURL();
179 if (!url.endsWith("/"))
183 ITileProvider provider = new OSMTileProvider(new WebService(url), TILE_PIXEL_SIZE);
185 // Try to load eclipse specific implementation of TileJobQueue, if it doesn't exist, fall back to pojo implementation
187 Class<?> proxyClass = (Class<?>) Class.forName("org.simantics.maps.eclipse.TileJobQueue");
188 job = (ITileJobQueue)proxyClass.newInstance();
189 } catch (ClassNotFoundException e1) {
190 } catch (InstantiationException e) {
191 } catch (IllegalAccessException e) {
193 // AppletProxyUtil should exist always..
195 job = new TileJobQueue();
198 // Cache is also eclipse specific...
199 ITileProvider cachedProvider = null;
201 Class<?> proxyClass = (Class<?>) Class.forName("org.simantics.maps.eclipse.DiskCachingTileProvider");
202 cachedProvider = (ITileProvider)proxyClass.getConstructor(ITileProvider.class, Boolean.class).newInstance(provider, false);
203 } catch (ClassNotFoundException e1) {
204 } catch (InstantiationException e) {
205 } catch (IllegalAccessException e) {
208 if(cachedProvider != null) {
209 job.setTileProvider(cachedProvider);
211 job.setTileProvider(provider);
214 this.tileCache = new TileCache(job);
215 this.tileCache.addTileListener(this);
216 } catch(Exception e ) {
217 LOGGER.error("Failed to initialize MapNode", e);
221 @SyncField("enabled")
222 public void setEnabled(Boolean enabled) {
223 this.enabled = enabled;
226 @SyncField("backgroundColor")
227 public void setBackgroundColor(Color color) {
228 this.backgroundColor = color;
232 public void render(Graphics2D g2d) {
235 AffineTransform ot = g2d.getTransform();
236 g2d.transform(transform);
238 AffineTransform tr = g2d.getTransform();
240 // Graphics2D g = (Graphics2D)g2d.create();
241 // AffineTransform tr = (AffineTransform)g.getTransform().clone();
243 double scaleX = Math.abs(tr.getScaleX());
244 double scaleY = Math.abs(tr.getScaleY());
245 if (scaleX <= 0 || scaleY <= 0) {
246 // Make sure that we don't end up in an eternal loop below.
249 double offsetX = -tr.getTranslateX();
250 double offsetY = -tr.getTranslateY();
252 g2d.setRenderingHint(RenderingHints.KEY_ANTIALIASING, RenderingHints.VALUE_ANTIALIAS_ON);
254 Rectangle2D sp = localToControl(new Rectangle2D.Double(0.0, 0.0, 1.0, 1.0));
255 Rectangle2D b = (Rectangle2D)((Rectangle)g2d.getRenderingHint(G2DRenderingHints.KEY_CONTROL_BOUNDS)).getBounds2D(); // getClipBounds is not accurate enough, use original clipbounds and scale here
257 Rectangle2D viewbox = new Rectangle2D.Double(offsetX/scaleX, offsetY/scaleY, b.getWidth()/sp.getWidth(), b.getHeight()/sp.getHeight()); //g.getClipBounds();
261 double smallerViewboxDimension = viewbox.getWidth() < viewbox.getHeight() ? viewbox.getWidth() * MAP_SCALE : viewbox.getHeight() * MAP_SCALE;
263 double tileSize = 360 * MAP_SCALE*2;
264 while (level < MAX_TILE_LEVEL) {
265 double ratio = smallerViewboxDimension / tileSize;
273 * To convert y-coordinates to map coordinates in ruler, use:
274 * double val = (y-offsetY)/scaleY;
275 * val = Math.toDegrees(Math.atan(Math.sinh(Math.toRadians(val))));
276 * String str = formatValue(val);
279 double minx = Math.min(180, Math.max(viewbox.getMinX(), -180));
280 double maxx = Math.min(180, Math.max(viewbox.getMaxX(), -180));
282 double miny = Math.min(360, Math.max(viewbox.getMinY()+180, 0));
283 double maxy = Math.min(360, Math.max(viewbox.getMaxY()+180, 0));
285 g2d.setTransform(new AffineTransform());
286 g2d.setRenderingHint(RenderingHints.KEY_INTERPOLATION, RenderingHints.VALUE_INTERPOLATION_BILINEAR);
288 int levels = (1 << level);
290 // http://wiki.openstreetmap.org/wiki/Slippy_map_tilenames
291 int left = (int)Math.floor( (minx + 180) / 360 * (1<<level) );
292 int right = (int)Math.floor( (maxx + 180) / 360 * (1<<level) );
293 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) );
294 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) );
296 double tsx = 360 / (double)levels; // Size of tile on zoom level
297 for(int tx = left; tx <= right; tx++) {
298 if(tx < 0 || tx >= levels) continue;
299 for(int ty = top; ty <= bottom; ty++) {
300 if(ty < 0 || ty >= levels) continue;
301 TileKey tile = new TileKey(level, tx, ty);
302 double y = (double)ty - (double)levels/2; // In level 0 we have only one tile
303 paintTile(tileCache, g2d, tr, tile, tx*tsx-180, y*tsx, tsx);
308 // Check if transform has changed
309 transformChanged(tr, level);
311 if (backgroundColor != null) {
312 g2d.setTransform(new AffineTransform());
313 Rectangle2D controlBounds = (Rectangle2D) g2d.getRenderingHint(G2DRenderingHints.KEY_CONTROL_BOUNDS);
314 Color color = g2d.getColor();
315 g2d.setColor(backgroundColor);
316 g2d.fill(controlBounds);
320 g2d.setTransform(ot);
324 public Rectangle2D getBoundsInLocal() {
328 private void paintTile(TileCache cache, Graphics2D g, AffineTransform userToScreenTransform, TileKey tile, double tx, double ty, double tileSize) {
329 GraphicsConfiguration gc = g.getDeviceConfiguration();
332 boolean usingParentData = false;
333 helperRect.setFrame(0, 0, TILE_PIXEL_SIZE, TILE_PIXEL_SIZE);
335 TileState state = tileStates.get(tile);
337 state = TileState.NOT_LOADED;
343 // The same logic applies both when the data has not been loaded
344 // or the data has been loaded previously, but may have been
345 // flushed from the cache.
346 img = cache.peek(tile);
348 // Either the data has never existed before or the cache has
349 // flushed this tile. Mark it as needed and try to use
350 // parent image instead.
353 Pair<TileKey, Image> p = findFirstAvailableParentTile(cache, tile, tileTraverser);
356 helperRect.setFrame(0, 0, img.getWidth(observer), img.getHeight(observer));
357 traverseRectangle(tileTraverser, helperRect);
358 usingParentData = true;
360 img = getNotLoadedImage(gc);
363 helperRect.setFrame(0, 0, img.getWidth(observer), img.getHeight(observer));
368 Pair<TileKey, Image> p = findFirstAvailableParentTile(cache, tile, tileTraverser);
371 helperRect.setFrame(0, 0, img.getWidth(observer), img.getHeight(observer));
372 traverseRectangle(tileTraverser, helperRect);
373 usingParentData = true;
375 img = getLoadingImage(gc);
379 case NOT_AVAILABLE: {
380 img = getMissingImage(gc);
384 throw new Error("Invalid tile state: " + state);
387 // Calculate where these user space coordinates are in the screen
388 // space and given them to drawImage().
389 Point2D helperPoint1 = new Point2D.Double(tx, ty);
390 Point2D helperPoint2 = new Point2D.Double(tx + tileSize, ty + tileSize);
391 userToScreenTransform.transform(helperPoint1, helperPoint1);
392 userToScreenTransform.transform(helperPoint2, helperPoint2);
394 int dx1 = (int) Math.round(helperPoint1.getX());
395 int dy1 = (int) Math.round(helperPoint1.getY());
396 int dx2 = (int) Math.round(helperPoint2.getX());
397 int dy2 = (int) Math.round(helperPoint2.getY());
399 int sx1 = (int) Math.round(helperRect.getMinX());
400 int sy1 = (int) Math.round(helperRect.getMinY());
401 int sx2 = (int) Math.round(helperRect.getMaxX());
402 int sy2 = (int) Math.round(helperRect.getMaxY());
404 if (usingParentData) {
405 g.setComposite(parentDataComposite);
407 g.setComposite(normalComposite);
409 g.drawImage(img, dx1, dy1, dx2, dy2, sx1, sy1, sx2, sy2, observer);
412 private void transformChanged(AffineTransform newTransform, final int level) {
413 // Cancel data fetching if the viewport changes.
414 AffineTransform ato = (AffineTransform) oldTransform;
415 AffineTransform atn = (AffineTransform) newTransform;
419 s1 = ato.getScaleX();
420 double s2 = atn.getScaleX();
422 if (Math.abs(ds) > 1e-6) {
423 if (pendingTileTask != null) {
424 pendingTileTask.cancel(false);
425 pendingTileTask = null;
427 Runnable r = new Runnable() {
430 // There was a quiet period of [delay] milliseconds.
431 // Now its time to start fetching the map data that has
432 // piled up into the queue.
433 loadNeededTiles(level);
436 pendingTileTask = scheduler.schedule(r, VIEWBOX_QUIET_TIME, TimeUnit.MILLISECONDS);
437 oldTransform = (AffineTransform)newTransform.clone();
439 loadNeededTiles(level);
443 private void loadNeededTiles(final int level) {
444 TileCache cache = this.tileCache;
446 // Remove all tile queries from the job queue that do not match the
447 // requested tile level. This helps speed up loading of the right tiles
448 // that should be shown to the user ASAP instead of spending time
449 // loading invisible tiles.
450 cache.filterJobQueue(new IFilter<TileKey>() {
452 public boolean select(TileKey tile) {
453 boolean result = (tile.getLevel() == level);
455 // System.out.println("FILTERED TILE: " + tile);
460 // Schedule retrieval of each tile on the current level.
462 synchronized (neededTiles) {
463 l = neededTiles.get(level);
466 if (l != null && !l.isEmpty()) {
467 for (TileKey k : l) {
468 tileStates.put(k, TileState.LOADING);
474 void needTile(TileKey t) {
475 synchronized (neededTiles) {
476 int level = t.getLevel();
477 TileLevel l = neededTiles.get(level);
480 neededTiles.put(level, l);
486 private Pair<TileKey, Image> findFirstAvailableParentTile(TileCache cache, TileKey tile, TileTraverser traverser) {
490 TileKey parent = getParentTile(tile);
491 while (parent != null) {
492 Image img = cache.peek(parent);
494 return new Pair<TileKey, Image>(parent, img);
495 traverser.add(parent);
496 parent = getParentTile(parent);
501 private TileKey getParentTile(TileKey k) {
502 if (k.getLevel() == 0)
504 return new TileKey(k.getLevel() - 1, k.getX() / 2, k.getY() / 2);
507 private void traverseRectangle(TileTraverser traverser, Rectangle2D rect) {
508 for (int i = traverser.size() - 1; i >= 0; --i) {
509 traverseToQuadrant(rect, traverser.getQuadrant(i));
513 private Rectangle2D traverseToQuadrant(Rectangle2D r, int quadrant) {
514 boolean left = quadrant == 1 || quadrant == 2;
515 boolean top = quadrant == 1 || quadrant == 0;
517 left ? r.getMinX() : r.getCenterX(),
518 top ? r.getMinY() : r.getCenterY(),
520 r.getHeight() / 2.0);
524 private synchronized VolatileImage getNotLoadedImage(GraphicsConfiguration gc) {
525 return validateImageWithCenteredText(gc, notLoadedImage, TILE_PIXEL_SIZE, "NOT LOADED", Color.LIGHT_GRAY, Color.BLACK);
528 private synchronized VolatileImage getLoadingImage(GraphicsConfiguration gc) {
529 return validateImageWithCenteredText(gc, loadingImage, TILE_PIXEL_SIZE, "LOADING", Color.BLUE, Color.BLACK);
532 private synchronized VolatileImage getMissingImage(GraphicsConfiguration gc) {
533 return validateImageWithCenteredText(gc, notAvailableImage, TILE_PIXEL_SIZE, "NOT AVAILABLE", Color.RED, Color.DARK_GRAY);
536 private void drawImageWithCenteredText(VolatileImage image, String str, Font font, Color color, Color bgColor) {
537 Graphics2D target = image.createGraphics();
538 Rectangle2D bb = target.getFontMetrics(font).getStringBounds(str, target);
540 target.setBackground(new Color(255,255,255,0));
541 int w = image.getWidth();
542 int h = image.getHeight();
544 target.setColor(Color.BLACK);
545 target.fillRect(0, 0, w, h);
546 target.setColor(bgColor);
547 target.fillRect(2, 2, w - 3, h - 3);
548 target.setRenderingHint(RenderingHints.KEY_ANTIALIASING, RenderingHints.VALUE_ANTIALIAS_ON);
549 target.setRenderingHint(RenderingHints.KEY_INTERPOLATION, RenderingHints.VALUE_INTERPOLATION_BICUBIC);
550 target.setRenderingHint(RenderingHints.KEY_ALPHA_INTERPOLATION, RenderingHints.VALUE_ALPHA_INTERPOLATION_QUALITY);
551 target.setRenderingHint(RenderingHints.KEY_TEXT_ANTIALIASING, RenderingHints.VALUE_TEXT_ANTIALIAS_ON);
552 target.setColor(color);
553 target.setFont(font);
554 target.drawString(str, (float) (((double)w - bb.getWidth()) / 2), (float) (((double)h + bb.getHeight()) / 2));
558 private VolatileImage validateImageWithCenteredText(GraphicsConfiguration gc, ObjectHolder<VolatileImage> container, int size, String text, Color textColor, Color bgColor) {
559 VolatileImage image = container.get();
561 int validateResult = image.validate(gc);
562 if (validateResult == VolatileImage.IMAGE_INCOMPATIBLE) {
564 } else if (validateResult == VolatileImage.IMAGE_OK) {
566 } else if (validateResult == VolatileImage.IMAGE_RESTORED) {
567 drawImageWithCenteredText(image, text, textFont, textColor, bgColor);
571 image = gc.createCompatibleVolatileImage(size, size);
572 container.set(image);
573 drawImageWithCenteredText(image, text, textFont, textColor, bgColor);
579 public void tileCanceled(TileKey key) {
580 tileStates.put(key, TileState.NOT_LOADED);
584 public void tileFailed(TileKey key, Throwable e) {
585 tileStates.put(key, TileState.NOT_AVAILABLE);
590 public void tileUpdated(TileKey key, Image image) {
591 tileStates.put(key, TileState.LOADED);