org.simantics.district.network.ui/src/org/simantics/district/network/ui/DistrictDiagramViewer.java

   1 package org.simantics.district.network.ui;
   2
   3 import java.awt.Color;
   4 import java.awt.geom.AffineTransform;
   5 import java.util.Collections;
   6 import java.util.Map;
   7 import java.util.Objects;
   8 import java.util.concurrent.TimeUnit;
   9 import java.util.function.Consumer;
  10 import java.util.function.Supplier;
  11
  12 import org.simantics.datatypes.literal.RGB;
  13 import org.simantics.db.ReadGraph;
  14 import org.simantics.db.Resource;
  15 import org.simantics.db.common.request.IndexRoot;
  16 import org.simantics.db.common.request.UnaryRead;
  17 import org.simantics.db.exception.DatabaseException;
  18 import org.simantics.db.procedure.Listener;
  19 import org.simantics.diagram.ui.DiagramModelHints;
  20 import org.simantics.district.network.DistrictNetworkUtil;
  21 import org.simantics.district.network.ontology.DistrictNetworkResource;
  22 import org.simantics.district.network.ui.internal.Activator;
  23 import org.simantics.district.network.ui.nodes.DistrictRenderingPreparationNode;
  24 import org.simantics.district.network.ui.participants.DNPointerInteractor;
  25 import org.simantics.district.network.ui.participants.DynamicVisualisationContributionsParticipant;
  26 import org.simantics.district.network.ui.participants.ElevationServerParticipant;
  27 import org.simantics.district.network.ui.participants.MapRulerPainter;
  28 import org.simantics.district.network.visualisations.DynamicVisualisations;
  29 import org.simantics.district.network.visualisations.model.ColorBarOptions;
  30 import org.simantics.district.network.visualisations.model.DynamicColorContribution;
  31 import org.simantics.district.network.visualisations.model.DynamicSizeContribution;
  32 import org.simantics.district.network.visualisations.model.SizeBarOptions;
  33 import org.simantics.g2d.canvas.ICanvasContext;
  34 import org.simantics.g2d.canvas.impl.CanvasContext;
  35 import org.simantics.g2d.diagram.handler.PickRequest.PickFilter;
  36 import org.simantics.g2d.diagram.participant.DelayedBatchElementPainter;
  37 import org.simantics.g2d.diagram.participant.ElementPainter;
  38 import org.simantics.g2d.diagram.participant.Selection;
  39 import org.simantics.g2d.diagram.participant.ZOrderHandler;
  40 import org.simantics.g2d.participant.BackgroundPainter;
  41 import org.simantics.g2d.participant.GridPainter;
  42 import org.simantics.g2d.participant.PanZoomRotateHandler;
  43 import org.simantics.g2d.participant.RenderingQualityInteractor;
  44 import org.simantics.g2d.participant.TransformUtil;
  45 import org.simantics.g2d.participant.ZoomToAreaHandler;
  46 import org.simantics.g2d.scenegraph.SceneGraphConstants;
  47 import org.simantics.maps.MapScalingTransform;
  48 import org.simantics.maps.eclipse.MapPainter;
  49 import org.simantics.maps.sg.commands.MapCommands;
  50 import org.simantics.modeling.ui.diagramEditor.DiagramViewer;
  51 import org.simantics.scenegraph.g2d.G2DParentNode;
  52 import org.simantics.scenegraph.g2d.events.command.Command;
  53 import org.simantics.scenegraph.g2d.events.command.CommandEvent;
  54 import org.simantics.scenegraph.g2d.events.command.Commands;
  55 import org.simantics.utils.datastructures.hints.IHintContext;
  56 import org.simantics.utils.datastructures.hints.IHintContext.Key;
  57 import org.simantics.utils.datastructures.hints.IHintContext.KeyOf;
  58 import org.slf4j.Logger;
  59 import org.slf4j.LoggerFactory;
  60
  61 public class DistrictDiagramViewer extends DiagramViewer {
  62
  63         private static final Logger LOGGER = LoggerFactory.getLogger(DistrictDiagramViewer.class);
  64
  65     @Override
  66     protected void addDiagramParticipants(ICanvasContext ctx) {
  67         ctx.add(new ZOrderHandler());
  68         ctx.add(new Selection());
  69         ctx.add(new ElementPainter());
  70         ctx.add(new DNPointerInteractor());
  71
  72         AffineTransform tr = new AffineTransform(MapScalingTransform.INSTANCE);
  73         ctx.add(new MapPainter(tr));
  74
  75         ctx.add(new NetworkDrawingParticipant(tr));
  76         ctx.add(new ElevationServerParticipant(tr));
  77         ctx.add(new DynamicVisualisationContributionsParticipant(tr));
  78
  79         // Optimize AffineTransform memory allocations during district diagram rendering
  80         G2DParentNode spatialRoot = (G2DParentNode) ctx.getSceneGraph().lookupNode(SceneGraphConstants.SPATIAL_ROOT_NODE_ID);
  81         DistrictRenderingPreparationNode prepNode = new DistrictRenderingPreparationNode();
  82         prepNode.setZIndex(Integer.MIN_VALUE / 2);
  83         spatialRoot.addNode("districtRenderingPrepareNode", prepNode);
  84     }
  85
  86     protected String getPopupId() {
  87         return "#DistrictDiagramPopup";
  88     }
  89
  90     @Override
  91     protected void fillInitialDiagramHints(Resource diagram, IHintContext initialHints) throws DatabaseException {
  92         super.fillInitialDiagramHints(diagram, initialHints);
  93
  94     }
  95
  96     @Override
  97     public void initializeCanvasContext(CanvasContext ctx) {
  98         super.initializeCanvasContext(ctx);
  99         IHintContext h = ctx.getDefaultHintContext();
 100         h.setHint(PanZoomRotateHandler.KEY_ZOOM_IN_LIMIT, 10000.0);
 101         h.setHint(PanZoomRotateHandler.KEY_ZOOM_OUT_LIMIT, 0.01);
 102         h.setHint(DiagramModelHints.KEY_DIAGRAM_RESOURCE, diagramResource);
 103     }
 104
 105     @Override
 106     protected void addPainterParticipants(ICanvasContext ctx) {
 107         ctx.add(new RenderingQualityInteractor());
 108         ctx.add(new DelayedBatchElementPainter(PickFilter.FILTER_MONITORS, 500, TimeUnit.MILLISECONDS));
 109     }
 110
 111     @Override
 112     protected void addGridRulerBackgroundParticipants(CanvasContext ctx) {
 113         ctx.add(new GridPainter());
 114         ctx.add(new MapRulerPainter());
 115         ctx.add(new BackgroundPainter());
 116     }
 117
 118     protected void addViewManipulationParticipants(CanvasContext ctx) {
 119         // Let's replace with our special util
 120         TransformUtil util = ctx.getAtMostOneItemOfClass(TransformUtil.class);
 121         if (util != null)
 122             ctx.remove(util);
 123         ctx.add(new DistrictTransformUtil());
 124         ctx.add(new DistrictPanZoomRotateHandler());
 125         //ctx.add(new MousePanZoomInteractor());
 126         //ctx.add(new MultitouchPanZoomRotateInteractor());
 127         // ctx.add( new OrientationRestorer() );
 128         ctx.add(new ZoomToAreaHandler());
 129     }
 130
 131     @Override
 132     protected void loadPageSettings(ICanvasContext ctx) {
 133         super.loadPageSettings(ctx);
 134         // this might be the wrong place to start such listening but at least
 135         // super.loadPageSettings() does async-db-operations
 136         setupDrawMapEnabled();
 137         setupBackgroundColor();
 138         setupColoringObjects();
 139         setupColorBarOptions();
 140         setupSizingObjects();
 141         setupSizeBarOptions();
 142
 143         // add listeners
 144         DistrictDiagramViewerListener[] listeners = Activator.getInstance().getDistrictDiagramViewerListeners();
 145         if (listeners != null) {
 146             for (DistrictDiagramViewerListener listener : listeners) {
 147                 listener.diagramLoaded(getRuntime(), canvasContext);
 148             }
 149         }
 150     }
 151
 152     @Override
 153     public void dispose() {
 154         DistrictDiagramViewerListener[] listeners = Activator.getInstance().getDistrictDiagramViewerListeners();
 155         if (listeners != null) {
 156             for (DistrictDiagramViewerListener listener : listeners) {
 157                 listener.diagramDisposed(getRuntime(), canvasContext);
 158             }
 159         }
 160         super.dispose();
 161     }
 162
 163     private void setupDrawMapEnabled() {
 164         sessionContext.getSession().asyncRequest(new DrawMapEnabledRequest(getInputResource()), new DrawMapEnabledListener(
 165                 result -> canvasContext.getEventQueue().queueEvent(new CommandEvent(canvasContext, System.currentTimeMillis(), result ? Commands.MAP_ENABLE : Commands.MAP_DISABLE)),
 166                 () -> DistrictDiagramViewer.this.isDisposed()));
 167     }
 168
 169     private void setupBackgroundColor() {
 170         sessionContext.getSession().asyncRequest(new MapBackgroundColorRequest(getInputResource()), new MapBackgroundColorListener(
 171                 result -> queueBackgroundColorChangeEvent(result),
 172                 () -> DistrictDiagramViewer.this.isDisposed()));
 173     }
 174
 175     private void queueBackgroundColorChangeEvent(RGB.Integer result) {
 176         if (result != null) {
 177             Color backgroundColor = new Color(result.red, result.green, result.blue);
 178             canvasContext.getDefaultHintContext().setHint(MapCommands.KEY_MAP_BACKGROUND_COLOR, backgroundColor);
 179             canvasContext.getEventQueue().queueEvent(new CommandEvent(canvasContext, System.currentTimeMillis(), MapCommands.MAP_BACKGROUND_COLOR_CHANGE));
 180         }
 181     }
 182
 183     private void setupColoringObjects() {
 184         sessionContext.getSession().asyncRequest(new ColoringObjectsRequest(getInputResource()), new ColoringObjectsListener(
 185                 result -> queueColoringObjectsChangeEvent(result),
 186                 () -> DistrictDiagramViewer.this.isDisposed()));
 187     }
 188
 189
 190     private void setupColorBarOptions() {
 191         sessionContext.getSession().asyncRequest(new ColorBarOptionsRequest(getInputResource()), new ColorBarOptionsListener(
 192                 result -> queueColorBarOptionsChangeEvent(result),
 193                 () -> DistrictDiagramViewer.this.isDisposed()));
 194     }
 195
 196     private void setupSizingObjects() {
 197         sessionContext.getSession().asyncRequest(new SizingObjectsRequest(getInputResource()), new SizingObjectsListener(
 198                 result -> queueSizingObjectsChangeEvent(result),
 199                 () -> DistrictDiagramViewer.this.isDisposed()));
 200     }
 201
 202
 203     private void setupSizeBarOptions() {
 204         sessionContext.getSession().asyncRequest(new SizeBarOptionsRequest(getInputResource()), new SizeBarOptionsListener(
 205                 result -> queueSizeBarOptionsChangeEvent(result),
 206                 () -> DistrictDiagramViewer.this.isDisposed()));
 207     }
 208
 209     public static final Key KEY_MAP_COLOR_BAR_OPTIONS = new KeyOf(ColorBarOptions.class, "colorBarOptions");
 210     public static final Command MAP_COLOR_BAR_OPTIONS_CHANGE = new Command("colorBarOptionsChange");
 211     public static final Key KEY_MAP_SIZE_BAR_OPTIONS = new KeyOf(SizeBarOptions.class, "sizeBarOptions");
 212     public static final Command MAP_SIZE_BAR_OPTIONS_CHANGE = new Command("sizeBarOptionsChange");
 213
 214     public static final Key KEY_MAP_COLORING_OBJECTS = new KeyOf(Map.class, "coloringObjects");
 215     public static final Command MAP_COLORING_OBJECTS_CHANGE = new Command("coloringObjectsChange");
 216
 217     public static final Key KEY_MAP_SIZING_OBJECTS = new KeyOf(Map.class, "sizingObjects");
 218     public static final Command MAP_SIZING_OBJECTS_CHANGE = new Command("sizingObjectsChange");
 219
 220
 221     private void queueColoringObjectsChangeEvent(Map<String, DynamicColorContribution> result) {
 222         queueEventInternal(KEY_MAP_COLORING_OBJECTS, MAP_COLORING_OBJECTS_CHANGE, result);
 223     }
 224
 225     private void queueColorBarOptionsChangeEvent(ColorBarOptions result) {
 226         queueEventInternal(KEY_MAP_COLOR_BAR_OPTIONS, MAP_COLOR_BAR_OPTIONS_CHANGE, result);
 227     }
 228
 229     private void queueSizingObjectsChangeEvent(Map<String, DynamicSizeContribution> result) {
 230         queueEventInternal(KEY_MAP_SIZING_OBJECTS, MAP_SIZING_OBJECTS_CHANGE, result);
 231     }
 232
 233     private void queueSizeBarOptionsChangeEvent(SizeBarOptions result) {
 234         queueEventInternal(KEY_MAP_SIZE_BAR_OPTIONS, MAP_SIZE_BAR_OPTIONS_CHANGE, result);
 235     }
 236
 237     private void queueEventInternal(Key key, Command command, Object result) {
 238         if (result != null && !canvasContext.isDisposed()) {
 239             canvasContext.getThreadAccess().asyncExec(() -> {
 240                 canvasContext.getDefaultHintContext().setHint(key, result);
 241                 canvasContext.getEventQueue().queueEvent(new CommandEvent(canvasContext, System.currentTimeMillis(), command));
 242             });
 243         } else {
 244             LOGGER.info("Result is either null or canvasContext is disposed", String.valueOf(result));
 245         }
 246     }
 247
 248     private static class DrawMapEnabledRequest extends UnaryRead<Resource, Boolean> {
 249
 250         public DrawMapEnabledRequest(Resource diagram) {
 251             super(diagram);
 252         }
 253
 254         @Override
 255         public Boolean perform(ReadGraph graph) throws DatabaseException {
 256             return DistrictNetworkUtil.drawMapEnabled(graph, parameter);
 257         }
 258     }
 259
 260     private static class DrawMapEnabledListener implements Listener<Boolean> {
 261
 262         private static final Logger LOGGER = LoggerFactory.getLogger(DrawMapEnabledListener.class);
 263
 264         private Consumer<Boolean> callback;
 265         private Supplier<Boolean> isDisposed;
 266
 267         private Boolean lastResult;
 268
 269         public DrawMapEnabledListener(Consumer<Boolean> callback, Supplier<Boolean> isDisposed) {
 270             this.callback = callback;
 271             this.isDisposed = isDisposed;
 272         }
 273
 274         @Override
 275         public void execute(Boolean result) {
 276             // Minor optimization
 277             if (!Objects.equals(lastResult, result)) {
 278                 lastResult = result;
 279                 callback.accept(result);
 280             }
 281         }
 282
 283         @Override
 284         public void exception(Throwable t) {
 285             LOGGER.error("Could not listen if draw map is enabled", t);
 286         }
 287
 288         @Override
 289         public boolean isDisposed() {
 290             return isDisposed.get();
 291         }
 292     }
 293
 294     private static class MapBackgroundColorRequest extends UnaryRead<Resource, RGB.Integer> {
 295
 296         public MapBackgroundColorRequest(Resource diagram) {
 297             super(diagram);
 298         }
 299
 300         @Override
 301         public RGB.Integer perform(ReadGraph graph) throws DatabaseException {
 302             return DistrictNetworkUtil.backgroundColor(graph, parameter);
 303         }
 304     }
 305
 306     private static class MapBackgroundColorListener implements Listener<RGB.Integer> {
 307
 308         private static final Logger LOGGER = LoggerFactory.getLogger(MapBackgroundColorListener.class);
 309
 310         private Consumer<RGB.Integer> callback;
 311         private Supplier<Boolean> isDisposed;
 312
 313         private RGB.Integer lastResult;
 314
 315         public MapBackgroundColorListener(Consumer<RGB.Integer> callback, Supplier<Boolean> isDisposed) {
 316             this.callback = callback;
 317             this.isDisposed = isDisposed;
 318         }
 319
 320         @Override
 321         public void execute(RGB.Integer result) {
 322             if (!Objects.equals(lastResult, result)) {
 323                 lastResult = result;
 324                 callback.accept(result);
 325             }
 326         }
 327
 328         @Override
 329         public void exception(Throwable t) {
 330             LOGGER.error("Could not listen map background color", t);
 331         }
 332
 333         @Override
 334         public boolean isDisposed() {
 335             return isDisposed.get();
 336         }
 337     }
 338
 339     private static class ColorBarOptionsRequest extends UnaryRead<Resource, ColorBarOptions> {
 340
 341         public ColorBarOptionsRequest(Resource diagram) {
 342             super(diagram);
 343         }
 344
 345         @Override
 346         public ColorBarOptions perform(ReadGraph graph) throws DatabaseException {
 347             DistrictNetworkResource DN = DistrictNetworkResource.getInstance(graph);
 348             Resource model = graph.syncRequest(new IndexRoot(parameter));
 349             Resource vf = DynamicVisualisations.getVisualisationFolder(graph, model);
 350             if (vf != null) {
 351                 Resource activeVisualisation = graph.getPossibleObject(vf, DN.Diagram_hasActiveVisualisation);
 352                 if (activeVisualisation != null) {
 353                     return DynamicVisualisations.colorBarOptions(graph, activeVisualisation);
 354                 }
 355             } else {
 356                 LOGGER.debug("No visualisation folder available for model {}", model);
 357             }
 358             return ColorBarOptions.useDefault();
 359         }
 360     }
 361
 362     private static class ColoringObjectsRequest extends UnaryRead<Resource, Map<String,DynamicColorContribution>> {
 363
 364         public ColoringObjectsRequest(Resource diagram) {
 365             super(diagram);
 366         }
 367
 368         @Override
 369         public Map<String, DynamicColorContribution> perform(ReadGraph graph) throws DatabaseException {
 370             DistrictNetworkResource DN = DistrictNetworkResource.getInstance(graph);
 371             Resource model = graph.syncRequest(new IndexRoot(parameter));
 372             Resource vf = DynamicVisualisations.getVisualisationFolder(graph, model);
 373             if (vf != null) {
 374                 Resource activeVisualisation = graph.getPossibleObject(vf, DN.Diagram_hasActiveVisualisation);
 375                 if (activeVisualisation != null) {
 376                     return DynamicVisualisations.colorContributions(graph, activeVisualisation);
 377                 }
 378             } else {
 379                 LOGGER.debug("No visualisation folder available for model {}", model);
 380             }
 381             return Collections.emptyMap();
 382         }
 383     }
 384
 385     private static class ColoringObjectsListener implements Listener<Map<String,DynamicColorContribution>> {
 386
 387         private static final Logger LOGGER = LoggerFactory.getLogger(ColoringObjectsListener.class);
 388
 389         private Consumer<Map<String,DynamicColorContribution>> callback;
 390         private Supplier<Boolean> isDisposed;
 391
 392         //private Map<String, DynamicColorContribution> lastResult
 393
 394         public ColoringObjectsListener(Consumer<Map<String,DynamicColorContribution>> callback, Supplier<Boolean> isDisposed) {
 395             this.callback = callback;
 396             this.isDisposed = isDisposed;
 397         }
 398
 399         @Override
 400         public void execute(Map<String,DynamicColorContribution> result) {
 401             callback.accept(result);
 402         }
 403
 404         @Override
 405         public void exception(Throwable t) {
 406             LOGGER.error("Could not listen ColorBarOptions", t);
 407         }
 408
 409         @Override
 410         public boolean isDisposed() {
 411             return isDisposed.get();
 412         }
 413     }
 414
 415     private static class ColorBarOptionsListener implements Listener<ColorBarOptions> {
 416
 417         private static final Logger LOGGER = LoggerFactory.getLogger(ColorBarOptionsListener.class);
 418
 419         private Consumer<ColorBarOptions> callback;
 420         private Supplier<Boolean> isDisposed;
 421
 422         public ColorBarOptionsListener(Consumer<ColorBarOptions> callback, Supplier<Boolean> isDisposed) {
 423             this.callback = callback;
 424             this.isDisposed = isDisposed;
 425         }
 426
 427         @Override
 428         public void execute(ColorBarOptions result) {
 429             callback.accept(result);
 430         }
 431
 432         @Override
 433         public void exception(Throwable t) {
 434             LOGGER.error("Could not listen ColorBarOptions", t);
 435         }
 436
 437         @Override
 438         public boolean isDisposed() {
 439             return isDisposed.get();
 440         }
 441     }
 442
 443     private static class SizeBarOptionsRequest extends UnaryRead<Resource, SizeBarOptions> {
 444
 445         public SizeBarOptionsRequest(Resource diagram) {
 446             super(diagram);
 447         }
 448
 449         @Override
 450         public SizeBarOptions perform(ReadGraph graph) throws DatabaseException {
 451             DistrictNetworkResource DN = DistrictNetworkResource.getInstance(graph);
 452             Resource model = graph.syncRequest(new IndexRoot(parameter));
 453             Resource vf = DynamicVisualisations.getVisualisationFolder(graph, model);
 454             if (vf != null) {
 455                 Resource activeVisualisation = graph.getPossibleObject(vf, DN.Diagram_hasActiveVisualisation);
 456                 if (activeVisualisation != null) {
 457                     return DynamicVisualisations.sizeBarOptions(graph, activeVisualisation);
 458                 }
 459             } else {
 460                 LOGGER.debug("No visualisation folder available for model {}", model);
 461             }
 462             return SizeBarOptions.useDefault();
 463         }
 464     }
 465
 466     private static class SizeBarOptionsListener implements Listener<SizeBarOptions> {
 467
 468         private static final Logger LOGGER = LoggerFactory.getLogger(SizeBarOptionsListener.class);
 469
 470         private Consumer<SizeBarOptions> callback;
 471         private Supplier<Boolean> isDisposed;
 472
 473         public SizeBarOptionsListener(Consumer<SizeBarOptions> callback, Supplier<Boolean> isDisposed) {
 474             this.callback = callback;
 475             this.isDisposed = isDisposed;
 476         }
 477
 478         @Override
 479         public void execute(SizeBarOptions result) {
 480             callback.accept(result);
 481         }
 482
 483         @Override
 484         public void exception(Throwable t) {
 485             LOGGER.error("Could not listen SizeBarOptions", t);
 486         }
 487
 488         @Override
 489         public boolean isDisposed() {
 490             return isDisposed.get();
 491         }
 492     }
 493
 494     private static class SizingObjectsRequest extends UnaryRead<Resource, Map<String, DynamicSizeContribution>> {
 495
 496         public SizingObjectsRequest(Resource diagram) {
 497             super(diagram);
 498         }
 499
 500         @Override
 501         public Map<String, DynamicSizeContribution> perform(ReadGraph graph) throws DatabaseException {
 502             DistrictNetworkResource DN = DistrictNetworkResource.getInstance(graph);
 503             Resource model = graph.syncRequest(new IndexRoot(parameter));
 504             Resource vf = DynamicVisualisations.getVisualisationFolder(graph, model);
 505             if (vf != null) {
 506                 Resource activeVisualisation = graph.getPossibleObject(vf, DN.Diagram_hasActiveVisualisation);
 507                 if (activeVisualisation != null) {
 508                     return DynamicVisualisations.sizeContributions(graph, activeVisualisation);
 509                 }
 510             } else {
 511                 LOGGER.debug("No visualisation folder available for model {}", model);
 512             }
 513             return Collections.emptyMap();
 514         }
 515     }
 516
 517     private static class SizingObjectsListener implements Listener<Map<String,DynamicSizeContribution>> {
 518
 519         private static final Logger LOGGER = LoggerFactory.getLogger(SizingObjectsListener.class);
 520
 521         private Consumer<Map<String,DynamicSizeContribution>> callback;
 522         private Supplier<Boolean> isDisposed;
 523
 524         public SizingObjectsListener(Consumer<Map<String, DynamicSizeContribution>> callback, Supplier<Boolean> isDisposed) {
 525             this.callback = callback;
 526             this.isDisposed = isDisposed;
 527         }
 528
 529         @Override
 530         public void execute(Map<String, DynamicSizeContribution> result) {
 531             callback.accept(result);
 532         }
 533
 534         @Override
 535         public void exception(Throwable t) {
 536             LOGGER.error("Could not listen ColorBarOptions", t);
 537         }
 538
 539         @Override
 540         public boolean isDisposed() {
 541             return isDisposed.get();
 542         }
 543     }
 544 }