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