1 package org.simantics.district.network.ui;
4 import java.awt.geom.AffineTransform;
5 import java.util.Collections;
7 import java.util.Objects;
8 import java.util.concurrent.TimeUnit;
9 import java.util.function.Consumer;
10 import java.util.function.Supplier;
12 import org.eclipse.e4.core.contexts.IEclipseContext;
13 import org.eclipse.e4.core.services.events.IEventBroker;
14 import org.eclipse.ui.PlatformUI;
15 import org.simantics.datatypes.literal.RGB;
16 import org.simantics.db.ReadGraph;
17 import org.simantics.db.Resource;
18 import org.simantics.db.common.request.PossibleIndexRoot;
19 import org.simantics.db.common.request.UnaryRead;
20 import org.simantics.db.exception.DatabaseException;
21 import org.simantics.db.procedure.Listener;
22 import org.simantics.diagram.ui.DiagramModelHints;
23 import org.simantics.district.network.DistrictNetworkUtil;
24 import org.simantics.district.network.ontology.DistrictNetworkResource;
25 import org.simantics.district.network.ui.internal.Activator;
26 import org.simantics.district.network.ui.nodes.DistrictRenderingPreparationNode;
27 import org.simantics.district.network.ui.nodes.DistrictSelectionNode;
28 import org.simantics.district.network.ui.participants.DNPointerInteractor;
29 import org.simantics.district.network.ui.participants.DistrictFinderVisualisationParticipant;
30 import org.simantics.district.network.ui.participants.DynamicVisualisationContributionsParticipant;
31 import org.simantics.district.network.ui.participants.MapRulerPainter;
32 import org.simantics.district.network.visualisations.DynamicVisualisations;
33 import org.simantics.district.network.visualisations.model.ColorBarOptions;
34 import org.simantics.district.network.visualisations.model.DynamicColorContribution;
35 import org.simantics.district.network.visualisations.model.DynamicSizeContribution;
36 import org.simantics.district.network.visualisations.model.SizeBarOptions;
37 import org.simantics.g2d.canvas.ICanvasContext;
38 import org.simantics.g2d.canvas.impl.CanvasContext;
39 import org.simantics.g2d.diagram.DiagramHints;
40 import org.simantics.g2d.diagram.handler.PickRequest.PickFilter;
41 import org.simantics.g2d.diagram.participant.DelayedBatchElementPainter;
42 import org.simantics.g2d.diagram.participant.ElementPainter;
43 import org.simantics.g2d.diagram.participant.ElementPainterConfiguration;
44 import org.simantics.g2d.diagram.participant.Selection;
45 import org.simantics.g2d.diagram.participant.ZOrderHandler;
46 import org.simantics.g2d.participant.BackgroundPainter;
47 import org.simantics.g2d.participant.GridPainter;
48 import org.simantics.g2d.participant.PanZoomRotateHandler;
49 import org.simantics.g2d.participant.RenderingQualityInteractor;
50 import org.simantics.g2d.participant.TransformUtil;
51 import org.simantics.g2d.participant.ZoomToAreaHandler;
52 import org.simantics.g2d.scenegraph.SceneGraphConstants;
53 import org.simantics.maps.MapScalingTransform;
54 import org.simantics.maps.eclipse.MapPainter;
55 import org.simantics.maps.sg.commands.MapCommands;
56 import org.simantics.modeling.ui.diagramEditor.DiagramViewer;
57 import org.simantics.scenegraph.g2d.G2DParentNode;
58 import org.simantics.scenegraph.g2d.events.command.Command;
59 import org.simantics.scenegraph.g2d.events.command.CommandEvent;
60 import org.simantics.scenegraph.g2d.events.command.Commands;
61 import org.simantics.utils.datastructures.hints.IHintContext;
62 import org.simantics.utils.datastructures.hints.IHintContext.Key;
63 import org.simantics.utils.datastructures.hints.IHintContext.KeyOf;
64 import org.slf4j.Logger;
65 import org.slf4j.LoggerFactory;
67 public class DistrictDiagramViewer extends DiagramViewer {
69 private static final Logger LOGGER = LoggerFactory.getLogger(DistrictDiagramViewer.class);
72 protected void addDiagramParticipants(ICanvasContext ctx) {
73 ctx.add(new ZOrderHandler());
74 ctx.add(new Selection());
75 ctx.add(new ElementPainter(new ElementPainterConfiguration().selectionNodeClass(DistrictSelectionNode.class)));
76 ctx.add(new DNPointerInteractor());
78 AffineTransform tr = new AffineTransform(MapScalingTransform.INSTANCE);
79 ctx.add(new MapPainter(tr));
81 DynamicVisualisationContributionsParticipant dynamicVisualisationContributionsParticipant = new DynamicVisualisationContributionsParticipant(tr);
82 ctx.add(new NetworkDrawingParticipant(dynamicVisualisationContributionsParticipant, tr));
83 ctx.add(dynamicVisualisationContributionsParticipant);
85 // Optimize AffineTransform memory allocations during district diagram rendering
86 G2DParentNode spatialRoot = (G2DParentNode) ctx.getSceneGraph().lookupNode(SceneGraphConstants.SPATIAL_ROOT_NODE_ID);
87 DistrictRenderingPreparationNode prepNode = new DistrictRenderingPreparationNode();
88 prepNode.setZIndex(Integer.MIN_VALUE / 2);
89 spatialRoot.addNode("districtRenderingPrepareNode", prepNode);
92 IEclipseContext workbenchContext = getWorkbenchContext();
93 IEventBroker eventBroker = workbenchContext.get(IEventBroker.class);
94 DistrictFinderVisualisationParticipant districtFinderVisualisationParticipant = new DistrictFinderVisualisationParticipant(eventBroker);
95 ctx.add(districtFinderVisualisationParticipant);
99 public static IEclipseContext getWorkbenchContext(){
100 return PlatformUI.getWorkbench().getService(IEclipseContext.class);
103 protected String getPopupId() {
104 return "#DistrictDiagramPopup";
108 protected void fillInitialDiagramHints(Resource diagram, IHintContext initialHints) throws DatabaseException {
109 super.fillInitialDiagramHints(diagram, initialHints);
114 public void initializeCanvasContext(CanvasContext ctx) {
115 super.initializeCanvasContext(ctx);
116 IHintContext h = ctx.getDefaultHintContext();
117 h.setHint(PanZoomRotateHandler.KEY_ZOOM_IN_LIMIT, 10000.0);
118 h.setHint(PanZoomRotateHandler.KEY_ZOOM_OUT_LIMIT, 0.01);
119 h.setHint(DiagramModelHints.KEY_DIAGRAM_RESOURCE, diagramResource);
120 h.removeHint(DiagramHints.SNAP_ADVISOR);
124 protected void addPainterParticipants(ICanvasContext ctx) {
125 ctx.add(new RenderingQualityInteractor());
126 ctx.add(new DelayedBatchElementPainter(PickFilter.FILTER_MONITORS, 500, TimeUnit.MILLISECONDS));
130 protected void addGridRulerBackgroundParticipants(CanvasContext ctx) {
131 ctx.add(new GridPainter());
132 ctx.add(new MapRulerPainter());
133 ctx.add(new BackgroundPainter());
136 protected void addViewManipulationParticipants(CanvasContext ctx) {
137 // Let's replace with our special util
138 TransformUtil util = ctx.getAtMostOneItemOfClass(TransformUtil.class);
141 ctx.add(new DistrictTransformUtil());
142 ctx.add(new DistrictPanZoomRotateHandler());
143 //ctx.add(new MousePanZoomInteractor());
144 //ctx.add(new MultitouchPanZoomRotateInteractor());
145 // ctx.add( new OrientationRestorer() );
146 ctx.add(new ZoomToAreaHandler());
150 protected void loadPageSettings(ICanvasContext ctx) {
151 super.loadPageSettings(ctx);
152 // this might be the wrong place to start such listening but at least
153 // super.loadPageSettings() does async-db-operations
154 setupDrawMapEnabled();
155 setupBackgroundColor();
156 setupColoringObjects();
157 setupColorBarOptions();
158 setupSizingObjects();
159 setupSizeBarOptions();
160 setupShowElevationServerBoundingBox();
163 DistrictDiagramViewerListener[] listeners = Activator.getInstance().getDistrictDiagramViewerListeners();
164 if (listeners != null) {
165 for (DistrictDiagramViewerListener listener : listeners) {
166 listener.diagramLoaded(getRuntime(), canvasContext);
172 public void dispose() {
173 DistrictDiagramViewerListener[] listeners = Activator.getInstance().getDistrictDiagramViewerListeners();
174 if (listeners != null) {
175 Resource runtime = getRuntime();
176 for (DistrictDiagramViewerListener listener : listeners) {
177 listener.diagramDisposed(runtime, canvasContext);
183 private void setupDrawMapEnabled() {
184 sessionContext.getSession().asyncRequest(new DrawMapEnabledRequest(getInputResource()), new DrawMapEnabledListener(
185 result -> canvasContext.getEventQueue().queueEvent(new CommandEvent(canvasContext, System.currentTimeMillis(), result ? Commands.MAP_ENABLE : Commands.MAP_DISABLE)),
186 () -> DistrictDiagramViewer.this.isDisposed()));
189 private void setupBackgroundColor() {
190 sessionContext.getSession().asyncRequest(new MapBackgroundColorRequest(getInputResource()), new MapBackgroundColorListener(
191 result -> queueBackgroundColorChangeEvent(result),
192 () -> DistrictDiagramViewer.this.isDisposed()));
195 private void queueBackgroundColorChangeEvent(RGB.Integer result) {
196 if (result != null) {
197 Color backgroundColor = new Color(result.red, result.green, result.blue);
198 canvasContext.getDefaultHintContext().setHint(MapCommands.KEY_MAP_BACKGROUND_COLOR, backgroundColor);
199 canvasContext.getEventQueue().queueEvent(new CommandEvent(canvasContext, System.currentTimeMillis(), MapCommands.MAP_BACKGROUND_COLOR_CHANGE));
203 private void setupColoringObjects() {
204 sessionContext.getSession().asyncRequest(new ColoringObjectsRequest(getInputResource()), new ColoringObjectsListener(
205 result -> queueColoringObjectsChangeEvent(result),
206 () -> DistrictDiagramViewer.this.isDisposed()));
210 private void setupColorBarOptions() {
211 sessionContext.getSession().asyncRequest(new ColorBarOptionsRequest(getInputResource()), new ColorBarOptionsListener(
212 result -> queueColorBarOptionsChangeEvent(result),
213 () -> DistrictDiagramViewer.this.isDisposed()));
216 private void setupSizingObjects() {
217 sessionContext.getSession().asyncRequest(new SizingObjectsRequest(getInputResource()), new SizingObjectsListener(
218 result -> queueSizingObjectsChangeEvent(result),
219 () -> DistrictDiagramViewer.this.isDisposed()));
222 private void setupSizeBarOptions() {
223 sessionContext.getSession().asyncRequest(new SizeBarOptionsRequest(getInputResource()), new SizeBarOptionsListener(
224 result -> queueSizeBarOptionsChangeEvent(result),
225 () -> DistrictDiagramViewer.this.isDisposed()));
228 private void setupShowElevationServerBoundingBox() {
229 sessionContext.getSession().asyncRequest(new ShowElevationServerRequest(getInputResource()), new ShowElevationServerListener(
230 result -> queueShowElevationServerChangeEvent(result),
231 () -> DistrictDiagramViewer.this.isDisposed()));
234 public static final Key KEY_MAP_COLOR_BAR_OPTIONS = new KeyOf(ColorBarOptions.class, "colorBarOptions");
235 public static final Command MAP_COLOR_BAR_OPTIONS_CHANGE = new Command("colorBarOptionsChange");
236 public static final Key KEY_MAP_SIZE_BAR_OPTIONS = new KeyOf(SizeBarOptions.class, "sizeBarOptions");
237 public static final Command MAP_SIZE_BAR_OPTIONS_CHANGE = new Command("sizeBarOptionsChange");
239 public static final Key KEY_MAP_COLORING_OBJECTS = new KeyOf(Map.class, "coloringObjects");
240 public static final Command MAP_COLORING_OBJECTS_CHANGE = new Command("coloringObjectsChange");
242 public static final Key KEY_MAP_SIZING_OBJECTS = new KeyOf(Map.class, "sizingObjects");
243 public static final Command MAP_SIZING_OBJECTS_CHANGE = new Command("sizingObjectsChange");
245 public static final Key KEY_SHOW_ELEVATION_SERVER = new KeyOf(Boolean.class, "showElevationServer");
246 public static final Command SHOW_ELEVATION_SERVER_CHANGE = new Command("showElevationServerChange");
248 private void queueColoringObjectsChangeEvent(Map<String, DynamicColorContribution> result) {
249 queueEventInternal(KEY_MAP_COLORING_OBJECTS, MAP_COLORING_OBJECTS_CHANGE, result);
252 private void queueColorBarOptionsChangeEvent(ColorBarOptions result) {
253 queueEventInternal(KEY_MAP_COLOR_BAR_OPTIONS, MAP_COLOR_BAR_OPTIONS_CHANGE, result);
256 private void queueSizingObjectsChangeEvent(Map<String, DynamicSizeContribution> result) {
257 queueEventInternal(KEY_MAP_SIZING_OBJECTS, MAP_SIZING_OBJECTS_CHANGE, result);
260 private void queueSizeBarOptionsChangeEvent(SizeBarOptions result) {
261 queueEventInternal(KEY_MAP_SIZE_BAR_OPTIONS, MAP_SIZE_BAR_OPTIONS_CHANGE, result);
264 private void queueShowElevationServerChangeEvent(Boolean result) {
265 queueEventInternal(KEY_SHOW_ELEVATION_SERVER, SHOW_ELEVATION_SERVER_CHANGE, result);
268 private void queueEventInternal(Key key, Command command, Object result) {
269 if (result != null && !canvasContext.isDisposed()) {
270 canvasContext.getThreadAccess().asyncExec(() -> {
271 canvasContext.getDefaultHintContext().setHint(key, result);
272 canvasContext.getEventQueue().queueEvent(new CommandEvent(canvasContext, System.currentTimeMillis(), command));
275 LOGGER.info("Result is either null or canvasContext is disposed", String.valueOf(result));
279 private static class DrawMapEnabledRequest extends UnaryRead<Resource, Boolean> {
281 public DrawMapEnabledRequest(Resource diagram) {
286 public Boolean perform(ReadGraph graph) throws DatabaseException {
287 return DistrictNetworkUtil.drawMapEnabled(graph, parameter);
291 private static class DrawMapEnabledListener implements Listener<Boolean> {
293 private static final Logger LOGGER = LoggerFactory.getLogger(DrawMapEnabledListener.class);
295 private Consumer<Boolean> callback;
296 private Supplier<Boolean> isDisposed;
298 private Boolean lastResult;
300 public DrawMapEnabledListener(Consumer<Boolean> callback, Supplier<Boolean> isDisposed) {
301 this.callback = callback;
302 this.isDisposed = isDisposed;
306 public void execute(Boolean result) {
307 // Minor optimization
308 if (!Objects.equals(lastResult, result)) {
310 callback.accept(result);
315 public void exception(Throwable t) {
316 LOGGER.error("Could not listen if draw map is enabled", t);
320 public boolean isDisposed() {
321 return isDisposed.get();
325 private static class MapBackgroundColorRequest extends UnaryRead<Resource, RGB.Integer> {
327 public MapBackgroundColorRequest(Resource diagram) {
332 public RGB.Integer perform(ReadGraph graph) throws DatabaseException {
333 return DistrictNetworkUtil.backgroundColor(graph, parameter);
337 private static class MapBackgroundColorListener implements Listener<RGB.Integer> {
339 private static final Logger LOGGER = LoggerFactory.getLogger(MapBackgroundColorListener.class);
341 private Consumer<RGB.Integer> callback;
342 private Supplier<Boolean> isDisposed;
344 private RGB.Integer lastResult;
346 public MapBackgroundColorListener(Consumer<RGB.Integer> callback, Supplier<Boolean> isDisposed) {
347 this.callback = callback;
348 this.isDisposed = isDisposed;
352 public void execute(RGB.Integer result) {
353 if (!Objects.equals(lastResult, result)) {
355 callback.accept(result);
360 public void exception(Throwable t) {
361 LOGGER.error("Could not listen map background color", t);
365 public boolean isDisposed() {
366 return isDisposed.get();
370 private static class ColorBarOptionsRequest extends UnaryRead<Resource, ColorBarOptions> {
372 public ColorBarOptionsRequest(Resource diagram) {
377 public ColorBarOptions perform(ReadGraph graph) throws DatabaseException {
378 DistrictNetworkResource DN = DistrictNetworkResource.getInstance(graph);
379 Resource model = graph.syncRequest(new PossibleIndexRoot(parameter));
381 Resource vf = DynamicVisualisations.getVisualisationFolder(graph, model);
383 Resource activeVisualisation = graph.getPossibleObject(vf, DN.Diagram_hasActiveVisualisation);
384 if (activeVisualisation != null) {
385 return DynamicVisualisations.colorBarOptions(graph, activeVisualisation);
388 LOGGER.debug("No visualisation folder available for model {}", model);
391 return ColorBarOptions.useDefault();
395 private static class ColoringObjectsRequest extends UnaryRead<Resource, Map<String,DynamicColorContribution>> {
397 public ColoringObjectsRequest(Resource diagram) {
402 public Map<String, DynamicColorContribution> perform(ReadGraph graph) throws DatabaseException {
403 DistrictNetworkResource DN = DistrictNetworkResource.getInstance(graph);
404 Resource model = graph.syncRequest(new PossibleIndexRoot(parameter));
406 Resource vf = DynamicVisualisations.getVisualisationFolder(graph, model);
408 Resource activeVisualisation = graph.getPossibleObject(vf, DN.Diagram_hasActiveVisualisation);
409 if (activeVisualisation != null) {
410 return DynamicVisualisations.colorContributions(graph, activeVisualisation);
413 LOGGER.debug("No visualisation folder available for model {}", model);
416 return Collections.emptyMap();
420 private static class ColoringObjectsListener implements Listener<Map<String,DynamicColorContribution>> {
422 private static final Logger LOGGER = LoggerFactory.getLogger(ColoringObjectsListener.class);
424 private Consumer<Map<String,DynamicColorContribution>> callback;
425 private Supplier<Boolean> isDisposed;
427 //private Map<String, DynamicColorContribution> lastResult
429 public ColoringObjectsListener(Consumer<Map<String,DynamicColorContribution>> callback, Supplier<Boolean> isDisposed) {
430 this.callback = callback;
431 this.isDisposed = isDisposed;
435 public void execute(Map<String,DynamicColorContribution> result) {
436 callback.accept(result);
440 public void exception(Throwable t) {
441 LOGGER.error("Could not listen ColoringObjects", t);
445 public boolean isDisposed() {
446 return isDisposed.get();
450 private static class ColorBarOptionsListener implements Listener<ColorBarOptions> {
452 private static final Logger LOGGER = LoggerFactory.getLogger(ColorBarOptionsListener.class);
454 private Consumer<ColorBarOptions> callback;
455 private Supplier<Boolean> isDisposed;
457 public ColorBarOptionsListener(Consumer<ColorBarOptions> callback, Supplier<Boolean> isDisposed) {
458 this.callback = callback;
459 this.isDisposed = isDisposed;
463 public void execute(ColorBarOptions result) {
464 callback.accept(result);
468 public void exception(Throwable t) {
469 LOGGER.error("Could not listen ColorBarOptions", t);
473 public boolean isDisposed() {
474 return isDisposed.get();
478 private static class SizeBarOptionsRequest extends UnaryRead<Resource, SizeBarOptions> {
480 public SizeBarOptionsRequest(Resource diagram) {
485 public SizeBarOptions perform(ReadGraph graph) throws DatabaseException {
486 DistrictNetworkResource DN = DistrictNetworkResource.getInstance(graph);
487 Resource model = graph.syncRequest(new PossibleIndexRoot(parameter));
489 Resource vf = DynamicVisualisations.getVisualisationFolder(graph, model);
491 Resource activeVisualisation = graph.getPossibleObject(vf, DN.Diagram_hasActiveVisualisation);
492 if (activeVisualisation != null) {
493 return DynamicVisualisations.sizeBarOptions(graph, activeVisualisation);
496 LOGGER.debug("No visualisation folder available for model {}", model);
499 return SizeBarOptions.useDefault();
503 private static class SizeBarOptionsListener implements Listener<SizeBarOptions> {
505 private static final Logger LOGGER = LoggerFactory.getLogger(SizeBarOptionsListener.class);
507 private Consumer<SizeBarOptions> callback;
508 private Supplier<Boolean> isDisposed;
510 public SizeBarOptionsListener(Consumer<SizeBarOptions> callback, Supplier<Boolean> isDisposed) {
511 this.callback = callback;
512 this.isDisposed = isDisposed;
516 public void execute(SizeBarOptions result) {
517 callback.accept(result);
521 public void exception(Throwable t) {
522 LOGGER.error("Could not listen SizeBarOptions", t);
526 public boolean isDisposed() {
527 return isDisposed.get();
531 private static class SizingObjectsRequest extends UnaryRead<Resource, Map<String, DynamicSizeContribution>> {
533 public SizingObjectsRequest(Resource diagram) {
538 public Map<String, DynamicSizeContribution> perform(ReadGraph graph) throws DatabaseException {
539 DistrictNetworkResource DN = DistrictNetworkResource.getInstance(graph);
540 Resource model = graph.syncRequest(new PossibleIndexRoot(parameter));
542 Resource vf = DynamicVisualisations.getVisualisationFolder(graph, model);
544 Resource activeVisualisation = graph.getPossibleObject(vf, DN.Diagram_hasActiveVisualisation);
545 if (activeVisualisation != null) {
546 return DynamicVisualisations.sizeContributions(graph, activeVisualisation);
549 LOGGER.debug("No visualisation folder available for model {}", model);
552 return Collections.emptyMap();
556 private static class SizingObjectsListener implements Listener<Map<String,DynamicSizeContribution>> {
558 private static final Logger LOGGER = LoggerFactory.getLogger(SizingObjectsListener.class);
560 private Consumer<Map<String,DynamicSizeContribution>> callback;
561 private Supplier<Boolean> isDisposed;
563 public SizingObjectsListener(Consumer<Map<String, DynamicSizeContribution>> callback, Supplier<Boolean> isDisposed) {
564 this.callback = callback;
565 this.isDisposed = isDisposed;
569 public void execute(Map<String, DynamicSizeContribution> result) {
570 callback.accept(result);
574 public void exception(Throwable t) {
575 LOGGER.error("Could not listen SizingObjectsOptions", t);
579 public boolean isDisposed() {
580 return isDisposed.get();
584 private static class ShowElevationServerRequest extends UnaryRead<Resource, Boolean> {
586 public ShowElevationServerRequest(Resource diagram) {
591 public Boolean perform(ReadGraph graph) throws DatabaseException {
592 DistrictNetworkResource DN = DistrictNetworkResource.getInstance(graph);
593 Resource model = graph.syncRequest(new PossibleIndexRoot(parameter));
595 Resource vf = DynamicVisualisations.getVisualisationFolder(graph, model);
597 Resource activeVisualisation = graph.getPossibleObject(vf, DN.Diagram_hasActiveVisualisation);
598 if (activeVisualisation != null) {
599 return DynamicVisualisations.showElevationServerBoundingBox(graph, activeVisualisation);
602 LOGGER.debug("No visualisation folder available for model {}", model);
609 private static class ShowElevationServerListener implements Listener<Boolean> {
611 private static final Logger LOGGER = LoggerFactory.getLogger(ShowElevationServerListener.class);
613 private Consumer<Boolean> callback;
614 private Supplier<Boolean> isDisposed;
616 public ShowElevationServerListener(Consumer<Boolean> callback, Supplier<Boolean> isDisposed) {
617 this.callback = callback;
618 this.isDisposed = isDisposed;
622 public void execute(Boolean result) {
623 callback.accept(result);
627 public void exception(Throwable t) {
628 LOGGER.error("Could not listen Show Elevation Server", t);
632 public boolean isDisposed() {
633 return isDisposed.get();