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