001// License: GPL. For details, see LICENSE file. 002package org.openstreetmap.josm.data.osm.visitor.paint; 003 004import java.awt.BasicStroke; 005import java.awt.Color; 006import java.awt.Graphics2D; 007import java.awt.Point; 008import java.awt.Rectangle; 009import java.awt.RenderingHints; 010import java.awt.Stroke; 011import java.awt.geom.GeneralPath; 012import java.util.ArrayList; 013import java.util.Iterator; 014import java.util.List; 015 016import org.openstreetmap.josm.Main; 017import org.openstreetmap.josm.data.Bounds; 018import org.openstreetmap.josm.data.osm.BBox; 019import org.openstreetmap.josm.data.osm.Changeset; 020import org.openstreetmap.josm.data.osm.DataSet; 021import org.openstreetmap.josm.data.osm.Node; 022import org.openstreetmap.josm.data.osm.OsmPrimitive; 023import org.openstreetmap.josm.data.osm.Relation; 024import org.openstreetmap.josm.data.osm.RelationMember; 025import org.openstreetmap.josm.data.osm.Way; 026import org.openstreetmap.josm.data.osm.WaySegment; 027import org.openstreetmap.josm.data.osm.visitor.Visitor; 028import org.openstreetmap.josm.gui.NavigatableComponent; 029 030/** 031 * A map renderer that paints a simple scheme of every primitive it visits to a 032 * previous set graphic environment. 033 * @since 23 034 */ 035public class WireframeMapRenderer extends AbstractMapRenderer implements Visitor { 036 037 /** Color Preference for ways not matching any other group */ 038 protected Color dfltWayColor; 039 /** Color Preference for relations */ 040 protected Color relationColor; 041 /** Color Preference for untagged ways */ 042 protected Color untaggedWayColor; 043 /** Color Preference for tagged nodes */ 044 protected Color taggedColor; 045 /** Color Preference for multiply connected nodes */ 046 protected Color connectionColor; 047 /** Color Preference for tagged and multiply connected nodes */ 048 protected Color taggedConnectionColor; 049 /** Preference: should directional arrows be displayed */ 050 protected boolean showDirectionArrow; 051 /** Preference: should arrows for oneways be displayed */ 052 protected boolean showOnewayArrow; 053 /** Preference: should only the last arrow of a way be displayed */ 054 protected boolean showHeadArrowOnly; 055 /** Preference: should the segment numbers of ways be displayed */ 056 protected boolean showOrderNumber; 057 /** Preference: should selected nodes be filled */ 058 protected boolean fillSelectedNode; 059 /** Preference: should unselected nodes be filled */ 060 protected boolean fillUnselectedNode; 061 /** Preference: should tagged nodes be filled */ 062 protected boolean fillTaggedNode; 063 /** Preference: should multiply connected nodes be filled */ 064 protected boolean fillConnectionNode; 065 /** Preference: size of selected nodes */ 066 protected int selectedNodeSize; 067 /** Preference: size of unselected nodes */ 068 protected int unselectedNodeSize; 069 /** Preference: size of multiply connected nodes */ 070 protected int connectionNodeSize; 071 /** Preference: size of tagged nodes */ 072 protected int taggedNodeSize; 073 074 /** Color cache to draw subsequent segments of same color as one <code>Path</code>. */ 075 protected Color currentColor; 076 /** Path store to draw subsequent segments of same color as one <code>Path</code>. */ 077 protected GeneralPath currentPath = new GeneralPath(); 078 /** 079 * <code>DataSet</code> passed to the @{link render} function to overcome the argument 080 * limitations of @{link Visitor} interface. Only valid until end of rendering call. 081 */ 082 private DataSet ds; 083 084 /** Helper variable for {@link #drawSegment} */ 085 private static final double PHI = Math.toRadians(20); 086 /** Helper variable for {@link #drawSegment} */ 087 private static final double cosPHI = Math.cos(PHI); 088 /** Helper variable for {@link #drawSegment} */ 089 private static final double sinPHI = Math.sin(PHI); 090 091 /** Helper variable for {@link #visit(Relation)} */ 092 private Stroke relatedWayStroke = new BasicStroke( 093 4, BasicStroke.CAP_SQUARE, BasicStroke.JOIN_BEVEL); 094 095 /** 096 * Creates an wireframe render 097 * 098 * @param g the graphics context. Must not be null. 099 * @param nc the map viewport. Must not be null. 100 * @param isInactiveMode if true, the paint visitor shall render OSM objects such that they 101 * look inactive. Example: rendering of data in an inactive layer using light gray as color only. 102 * @throws IllegalArgumentException if {@code g} is null 103 * @throws IllegalArgumentException if {@code nc} is null 104 */ 105 public WireframeMapRenderer(Graphics2D g, NavigatableComponent nc, boolean isInactiveMode) { 106 super(g, nc, isInactiveMode); 107 } 108 109 @Override 110 public void getColors() { 111 super.getColors(); 112 dfltWayColor = PaintColors.DEFAULT_WAY.get(); 113 relationColor = PaintColors.RELATION.get(); 114 untaggedWayColor = PaintColors.UNTAGGED_WAY.get(); 115 highlightColor = PaintColors.HIGHLIGHT_WIREFRAME.get(); 116 taggedColor = PaintColors.TAGGED.get(); 117 connectionColor = PaintColors.CONNECTION.get(); 118 119 if (taggedColor != nodeColor) { 120 taggedConnectionColor = taggedColor; 121 } else { 122 taggedConnectionColor = connectionColor; 123 } 124 } 125 126 @Override 127 protected void getSettings(boolean virtual) { 128 super.getSettings(virtual); 129 MapPaintSettings settings = MapPaintSettings.INSTANCE; 130 showDirectionArrow = settings.isShowDirectionArrow(); 131 showOnewayArrow = settings.isShowOnewayArrow(); 132 showHeadArrowOnly = settings.isShowHeadArrowOnly(); 133 showOrderNumber = settings.isShowOrderNumber(); 134 selectedNodeSize = settings.getSelectedNodeSize(); 135 unselectedNodeSize = settings.getUnselectedNodeSize(); 136 connectionNodeSize = settings.getConnectionNodeSize(); 137 taggedNodeSize = settings.getTaggedNodeSize(); 138 fillSelectedNode = settings.isFillSelectedNode(); 139 fillUnselectedNode = settings.isFillUnselectedNode(); 140 fillConnectionNode = settings.isFillConnectionNode(); 141 fillTaggedNode = settings.isFillTaggedNode(); 142 143 g.setRenderingHint(RenderingHints.KEY_ANTIALIASING, 144 Main.pref.getBoolean("mappaint.wireframe.use-antialiasing", false) ? 145 RenderingHints.VALUE_ANTIALIAS_ON : RenderingHints.VALUE_ANTIALIAS_OFF); 146 } 147 148 /** 149 * Renders the dataset for display. 150 * 151 * @param data <code>DataSet</code> to display 152 * @param virtual <code>true</code> if virtual nodes are used 153 * @param bounds display boundaries 154 */ 155 @Override 156 public void render(DataSet data, boolean virtual, Bounds bounds) { 157 BBox bbox = bounds.toBBox(); 158 this.ds = data; 159 getSettings(virtual); 160 161 for (final Relation rel : data.searchRelations(bbox)) { 162 if (rel.isDrawable() && !ds.isSelected(rel) && !rel.isDisabledAndHidden()) { 163 rel.accept(this); 164 } 165 } 166 167 // draw tagged ways first, then untagged ways, then highlighted ways 168 List<Way> highlightedWays = new ArrayList<>(); 169 List<Way> untaggedWays = new ArrayList<>(); 170 171 for (final Way way : data.searchWays(bbox)) { 172 if (way.isDrawable() && !ds.isSelected(way) && !way.isDisabledAndHidden()) { 173 if (way.isHighlighted()) { 174 highlightedWays.add(way); 175 } else if (!way.isTagged()) { 176 untaggedWays.add(way); 177 } else { 178 way.accept(this); 179 } 180 } 181 } 182 displaySegments(); 183 184 // Display highlighted ways after the other ones (fix #8276) 185 List<Way> specialWays = new ArrayList<>(untaggedWays); 186 specialWays.addAll(highlightedWays); 187 for (final Way way : specialWays) { 188 way.accept(this); 189 } 190 specialWays.clear(); 191 displaySegments(); 192 193 for (final OsmPrimitive osm : data.getSelected()) { 194 if (osm.isDrawable()) { 195 osm.accept(this); 196 } 197 } 198 displaySegments(); 199 200 for (final OsmPrimitive osm: data.searchNodes(bbox)) { 201 if (osm.isDrawable() && !ds.isSelected(osm) && !osm.isDisabledAndHidden()) { 202 osm.accept(this); 203 } 204 } 205 drawVirtualNodes(data, bbox); 206 207 // draw highlighted way segments over the already drawn ways. Otherwise each 208 // way would have to be checked if it contains a way segment to highlight when 209 // in most of the cases there won't be more than one segment. Since the wireframe 210 // renderer does not feature any transparency there should be no visual difference. 211 for (final WaySegment wseg : data.getHighlightedWaySegments()) { 212 drawSegment(nc.getPoint(wseg.getFirstNode()), nc.getPoint(wseg.getSecondNode()), highlightColor, false); 213 } 214 displaySegments(); 215 } 216 217 /** 218 * Helper function to calculate maximum of 4 values. 219 * 220 * @param a First value 221 * @param b Second value 222 * @param c Third value 223 * @param d Fourth value 224 */ 225 private static int max(int a, int b, int c, int d) { 226 return Math.max(Math.max(a, b), Math.max(c, d)); 227 } 228 229 /** 230 * Draw a small rectangle. 231 * White if selected (as always) or red otherwise. 232 * 233 * @param n The node to draw. 234 */ 235 @Override 236 public void visit(Node n) { 237 if (n.isIncomplete()) return; 238 239 if (n.isHighlighted()) { 240 drawNode(n, highlightColor, selectedNodeSize, fillSelectedNode); 241 } else { 242 Color color; 243 244 if (isInactiveMode || n.isDisabled()) { 245 color = inactiveColor; 246 } else if (n.isSelected()) { 247 color = selectedColor; 248 } else if (n.isMemberOfSelected()) { 249 color = relationSelectedColor; 250 } else if (n.isConnectionNode()) { 251 if (isNodeTagged(n)) { 252 color = taggedConnectionColor; 253 } else { 254 color = connectionColor; 255 } 256 } else { 257 if (isNodeTagged(n)) { 258 color = taggedColor; 259 } else { 260 color = nodeColor; 261 } 262 } 263 264 final int size = max(ds.isSelected(n) ? selectedNodeSize : 0, 265 isNodeTagged(n) ? taggedNodeSize : 0, 266 n.isConnectionNode() ? connectionNodeSize : 0, 267 unselectedNodeSize); 268 269 final boolean fill = (ds.isSelected(n) && fillSelectedNode) || 270 (isNodeTagged(n) && fillTaggedNode) || 271 (n.isConnectionNode() && fillConnectionNode) || 272 fillUnselectedNode; 273 274 drawNode(n, color, size, fill); 275 } 276 } 277 278 private static boolean isNodeTagged(Node n) { 279 return n.isTagged() || n.isAnnotated(); 280 } 281 282 /** 283 * Draw a line for all way segments. 284 * @param w The way to draw. 285 */ 286 @Override 287 public void visit(Way w) { 288 if (w.isIncomplete() || w.getNodesCount() < 2) 289 return; 290 291 /* show direction arrows, if draw.segment.relevant_directions_only is not set, the way is tagged with a direction key 292 (even if the tag is negated as in oneway=false) or the way is selected */ 293 294 boolean showThisDirectionArrow = ds.isSelected(w) || showDirectionArrow; 295 /* head only takes over control if the option is true, 296 the direction should be shown at all and not only because it's selected */ 297 boolean showOnlyHeadArrowOnly = showThisDirectionArrow && !ds.isSelected(w) && showHeadArrowOnly; 298 Color wayColor; 299 300 if (isInactiveMode || w.isDisabled()) { 301 wayColor = inactiveColor; 302 } else if (w.isHighlighted()) { 303 wayColor = highlightColor; 304 } else if (w.isSelected()) { 305 wayColor = selectedColor; 306 } else if (w.isMemberOfSelected()) { 307 wayColor = relationSelectedColor; 308 } else if (!w.isTagged()) { 309 wayColor = untaggedWayColor; 310 } else { 311 wayColor = dfltWayColor; 312 } 313 314 Iterator<Node> it = w.getNodes().iterator(); 315 if (it.hasNext()) { 316 Point lastP = nc.getPoint(it.next()); 317 for (int orderNumber = 1; it.hasNext(); orderNumber++) { 318 Point p = nc.getPoint(it.next()); 319 drawSegment(lastP, p, wayColor, 320 showOnlyHeadArrowOnly ? !it.hasNext() : showThisDirectionArrow); 321 if (showOrderNumber && !isInactiveMode) { 322 drawOrderNumber(lastP, p, orderNumber, g.getColor()); 323 } 324 lastP = p; 325 } 326 } 327 } 328 329 /** 330 * Draw objects used in relations. 331 * @param r The relation to draw. 332 */ 333 @Override 334 public void visit(Relation r) { 335 if (r.isIncomplete()) return; 336 337 Color col; 338 if (isInactiveMode || r.isDisabled()) { 339 col = inactiveColor; 340 } else if (r.isSelected()) { 341 col = selectedColor; 342 } else if (r.isMultipolygon() && r.isMemberOfSelected()) { 343 col = relationSelectedColor; 344 } else { 345 col = relationColor; 346 } 347 g.setColor(col); 348 349 for (RelationMember m : r.getMembers()) { 350 if (m.getMember().isIncomplete() || !m.getMember().isDrawable()) { 351 continue; 352 } 353 354 if (m.isNode()) { 355 Point p = nc.getPoint(m.getNode()); 356 if (p.x < 0 || p.y < 0 357 || p.x > nc.getWidth() || p.y > nc.getHeight()) { 358 continue; 359 } 360 361 g.drawOval(p.x-4, p.y-4, 9, 9); 362 } else if (m.isWay()) { 363 GeneralPath path = new GeneralPath(); 364 365 boolean first = true; 366 for (Node n : m.getWay().getNodes()) { 367 if (!n.isDrawable()) { 368 continue; 369 } 370 Point p = nc.getPoint(n); 371 if (first) { 372 path.moveTo(p.x, p.y); 373 first = false; 374 } else { 375 path.lineTo(p.x, p.y); 376 } 377 } 378 379 g.draw(relatedWayStroke.createStrokedShape(path)); 380 } 381 } 382 } 383 384 /** 385 * Visitor for changesets not used in this class 386 * @param cs The changeset for inspection. 387 */ 388 @Override 389 public void visit(Changeset cs) {/* ignore */} 390 391 @Override 392 public void drawNode(Node n, Color color, int size, boolean fill) { 393 if (size > 1) { 394 int radius = size / 2; 395 Point p = nc.getPoint(n); 396 if ((p.x < 0) || (p.y < 0) || (p.x > nc.getWidth()) 397 || (p.y > nc.getHeight())) 398 return; 399 g.setColor(color); 400 if (fill) { 401 g.fillRect(p.x - radius, p.y - radius, size, size); 402 g.drawRect(p.x - radius, p.y - radius, size, size); 403 } else { 404 g.drawRect(p.x - radius, p.y - radius, size, size); 405 } 406 } 407 } 408 409 /** 410 * Draw a line with the given color. 411 * 412 * @param path The path to append this segment. 413 * @param p1 First point of the way segment. 414 * @param p2 Second point of the way segment. 415 * @param showDirection <code>true</code> if segment direction should be indicated 416 */ 417 protected void drawSegment(GeneralPath path, Point p1, Point p2, boolean showDirection) { 418 Rectangle bounds = g.getClipBounds(); 419 bounds.grow(100, 100); // avoid arrow heads at the border 420 LineClip clip = new LineClip(p1, p2, bounds); 421 if (clip.execute()) { 422 p1 = clip.getP1(); 423 p2 = clip.getP2(); 424 path.moveTo(p1.x, p1.y); 425 path.lineTo(p2.x, p2.y); 426 427 if (showDirection) { 428 final double l = 10. / p1.distance(p2); 429 430 final double sx = l * (p1.x - p2.x); 431 final double sy = l * (p1.y - p2.y); 432 433 path.lineTo(p2.x + (int) Math.round(cosPHI * sx - sinPHI * sy), p2.y + (int) Math.round(sinPHI * sx + cosPHI * sy)); 434 path.moveTo(p2.x + (int) Math.round(cosPHI * sx + sinPHI * sy), p2.y + (int) Math.round(-sinPHI * sx + cosPHI * sy)); 435 path.lineTo(p2.x, p2.y); 436 } 437 } 438 } 439 440 /** 441 * Draw a line with the given color. 442 * 443 * @param p1 First point of the way segment. 444 * @param p2 Second point of the way segment. 445 * @param col The color to use for drawing line. 446 * @param showDirection <code>true</code> if segment direction should be indicated. 447 */ 448 protected void drawSegment(Point p1, Point p2, Color col, boolean showDirection) { 449 if (col != currentColor) { 450 displaySegments(col); 451 } 452 drawSegment(currentPath, p1, p2, showDirection); 453 } 454 455 /** 456 * Finally display all segments in currect path. 457 */ 458 protected void displaySegments() { 459 displaySegments(null); 460 } 461 462 /** 463 * Finally display all segments in currect path. 464 * 465 * @param newColor This color is set after the path is drawn. 466 */ 467 protected void displaySegments(Color newColor) { 468 if (currentPath != null) { 469 g.setColor(currentColor); 470 g.draw(currentPath); 471 currentPath = new GeneralPath(); 472 currentColor = newColor; 473 } 474 } 475}