]> gerrit.simantics Code Review - simantics/3d.git/blob - org.simantics.g3d.vtk/src/org/simantics/g3d/vtk/common/AbstractVTKNodeMap.java
Perform node map updates in a procedure instead of a request
[simantics/3d.git] / org.simantics.g3d.vtk / src / org / simantics / g3d / vtk / common / AbstractVTKNodeMap.java
1 /*******************************************************************************
2  * Copyright (c) 2012, 2013 Association for Decentralized Information Management in
3  * Industry THTH ry.
4  * All rights reserved. This program and the accompanying materials
5  * are made available under the terms of the Eclipse Public License v1.0
6  * which accompanies this distribution, and is available at
7  * http://www.eclipse.org/legal/epl-v10.html
8  *
9  * Contributors:
10  *     VTT Technical Research Centre of Finland - initial API and implementation
11  *******************************************************************************/
12 package org.simantics.g3d.vtk.common;
13
14 import java.lang.reflect.InvocationTargetException;
15 import java.util.ArrayDeque;
16 import java.util.ArrayList;
17 import java.util.Collection;
18 import java.util.Collections;
19 import java.util.Deque;
20 import java.util.HashMap;
21 import java.util.HashSet;
22 import java.util.List;
23 import java.util.Map;
24 import java.util.Set;
25 import java.util.Stack;
26
27 import org.eclipse.ui.PlatformUI;
28 import org.eclipse.ui.progress.IProgressService;
29 import org.simantics.db.ReadGraph;
30 import org.simantics.db.Session;
31 import org.simantics.db.UndoContext;
32 import org.simantics.db.WriteGraph;
33 import org.simantics.db.common.request.UniqueRead;
34 import org.simantics.db.common.request.WriteRequest;
35 import org.simantics.db.exception.DatabaseException;
36 import org.simantics.db.layer0.util.Layer0Utils;
37 import org.simantics.db.procedure.SyncProcedure;
38 import org.simantics.db.service.UndoRedoSupport;
39 import org.simantics.g3d.ontology.G3D;
40 import org.simantics.g3d.scenegraph.RenderListener;
41 import org.simantics.g3d.scenegraph.base.INode;
42 import org.simantics.g3d.scenegraph.base.NodeListener;
43 import org.simantics.g3d.scenegraph.base.ParentNode;
44 import org.simantics.objmap.exceptions.MappingException;
45 import org.simantics.objmap.graph.IMapping;
46 import org.simantics.objmap.graph.IMappingListener;
47 import org.simantics.utils.datastructures.MapList;
48 import org.simantics.utils.datastructures.MapSet;
49 import org.simantics.utils.datastructures.Pair;
50 import org.simantics.utils.ui.ExceptionUtils;
51 import org.slf4j.Logger;
52 import org.slf4j.LoggerFactory;
53
54 import vtk.vtkProp;
55
56 public abstract class AbstractVTKNodeMap<DBObject,E extends INode> implements VTKNodeMap<DBObject,E>, IMappingListener, RenderListener, NodeListener, UndoRedoSupport.ChangeListener{
57
58         private static final boolean DEBUG = true;
59
60         private static final Logger LOGGER = LoggerFactory.getLogger(AbstractVTKNodeMap.class);
61         
62         protected Session session;
63         protected IMapping<DBObject, INode> mapping;
64         protected VtkView view;
65         
66         private MapList<E, vtkProp> nodeToActor = new MapList<E, vtkProp>();
67         private Map<vtkProp,E> actorToNode = new HashMap<vtkProp, E>();
68
69         protected ParentNode<E> rootNode;
70         
71         protected UndoRedoSupport undoRedoSupport;
72         protected int undoOpCount = 0;
73         protected int redoOpCount = 0;
74         protected boolean runUndo = false;
75         protected boolean runRedo = false;
76         public AbstractVTKNodeMap(Session session, IMapping<DBObject,INode> mapping, VtkView view, ParentNode<E> rootNode) {
77                 this.session = session;
78                 this.mapping = mapping;
79                 this.view = view;
80                 this.rootNode = rootNode;
81                 view.addListener(this);
82                 mapping.addMappingListener(this);
83                 rootNode.addListener(this);
84                 
85                 undoRedoSupport = session.getService(UndoRedoSupport.class);
86                 undoRedoSupport.subscribe(this);
87                 try {
88                         UndoContext undoContext = undoRedoSupport.getUndoContext(session); 
89                         undoOpCount = undoContext.getAll().size();
90                         redoOpCount = undoContext.getRedoList().size();
91                 } catch(DatabaseException e) {
92                         e.printStackTrace();
93                 }
94         }
95
96         protected abstract void addActor(E node);
97         protected abstract void removeActor(E node);
98         protected abstract void updateActor(E node,Set<String> ids);
99         
100         public void repaint() {
101                 view.refresh();
102         }
103         
104         public void populate() {
105                 for (E node : rootNode.getNodes()) {
106                         receiveAdd(node, node.getParentRel(),true);
107                 }
108                 repaint();
109         }
110         
111         @Override
112         public E getNode(vtkProp prop) {
113                 return actorToNode.get(prop);
114         }
115         
116         @SuppressWarnings("unchecked")
117         @Override
118         public Collection<vtkProp> getRenderObjects(INode node) {
119                 return nodeToActor.getValues((E) node);
120         }
121         
122         protected <T extends vtkProp> void map(E node, Collection<T> props) {
123             for (vtkProp p : props) {
124                 nodeToActor.add(node, p);
125                 actorToNode.put(p, node);
126             }
127         }
128         
129         protected void removeMap(E node) {
130             Collection<vtkProp> coll = nodeToActor.getValuesUnsafe(node);
131             if (coll.size() > 0) {
132                 view.lock();
133             for (vtkProp p : coll) {
134                 actorToNode.remove(p);
135                 if (p.GetVTKId() != 0) {
136                     view.getRenderer().RemoveActor(p);
137                     p.Delete();
138                 }
139             }
140             view.unlock();
141             }
142             nodeToActor.remove(node);
143         }
144         
145         @Override
146         public ParentNode<E> getRootNode() {
147                 return (ParentNode<E>)rootNode;
148         }
149         
150         
151         
152         @Override
153         public boolean isChangeTracking() {
154                 return changeTracking;
155         }
156         
157         @Override
158         public void setChangeTracking(boolean enabled) {
159                 changeTracking = enabled;
160         }
161         
162         private boolean changeTracking = true;
163         
164         protected Object syncMutex = new Object(); 
165         
166
167         private List<Pair<E,String>> added = new ArrayList<Pair<E,String>>();
168         private List<Pair<E,String>> removed = new ArrayList<Pair<E,String>>();
169         private MapSet<E, String> updated = new MapSet.Hash<E, String>();
170
171         private boolean rangeModified = false;
172         
173         public boolean isRangeModified() {
174         return rangeModified;
175     }
176         
177         @Override
178         public void onChanged() {
179                 try {
180                         UndoContext undoContext = undoRedoSupport.getUndoContext(session);
181                         int ucount = undoContext.getAll().size();
182                         int rcount = undoContext.getRedoList().size();
183                         if (DEBUG) System.out.println("Previous U:" + undoOpCount +" R:" + redoOpCount +" Current U:"+ucount+" R:"+rcount);
184                         if (ucount < undoOpCount) {
185                                 runUndo = true;
186                         } else {
187                                 runUndo = false;
188                         }
189                         if (!runUndo && rcount > 0)
190                                 runRedo = true;
191                         else
192                                 runRedo = false;
193                         undoOpCount = ucount;
194                         redoOpCount = rcount;
195                         
196                         if (DEBUG) System.out.println("Undo " + runUndo + " Redo " + runRedo);
197                 } catch (DatabaseException e) {
198                         // TODO Auto-generated catch block
199                         e.printStackTrace();
200                 }
201                 
202                 
203         }
204         
205         @Override
206         public void updateRenderObjectsFor(E node) {
207                 List<vtkProp> toDelete = new ArrayList<vtkProp>();
208                 view.lock();
209                 for (vtkProp prop : nodeToActor.getValues(node)) {
210                         if (prop.GetVTKId() != 0) {
211                                 view.getRenderer().RemoveActor(prop);
212                                 //prop.Delete();
213                                 toDelete.add(prop);
214                         }
215                         actorToNode.remove(prop);
216                 }
217                 view.unlock();
218                 nodeToActor.remove(node);
219                 Collection<vtkProp> coll = getActors(node);
220                 if (coll != null) {
221                         for (vtkProp prop : coll) {
222                                 nodeToActor.add(node,prop);
223                                 actorToNode.put(prop, node);
224                                 toDelete.remove(prop);
225                         }
226                 }
227                 for (vtkProp p : toDelete)
228                         p.Delete();
229         }
230         
231         protected abstract  Collection<vtkProp> getActors(E node);
232         
233         @SuppressWarnings("unchecked")
234         private void receiveAdd(E node, String id, boolean db) {
235                 if (DEBUG) System.out.println("receiveAdd " + debugString(node)  + " " + id + " " + db);
236                 synchronized (syncMutex) {
237                         for (Pair<E, String> n : added) {
238                                 if (n.first.equals(node))
239                                         return;
240                         }
241                         if (changeTracking) {
242                                 mapping.rangeModified((E)node.getParent());
243                                 mapping.rangeModified((E)node);
244                         }
245                         added.add(new Pair<E, String>(node, id));
246                         rangeModified = true;
247                 }
248                 repaint();
249         }
250         
251         @SuppressWarnings("unchecked")
252         private void receiveRemove(E node, String id, boolean db) {
253                 if (DEBUG) System.out.println("receiveRemove " + debugString(node)  + " " + id + " " + db);
254                 synchronized (syncMutex) {
255                         for (Pair<E, String> n : removed) {
256                                 if (n.first.equals(node))
257                                         return;
258                         }
259                         if (changeTracking && !db) {
260                             mapping.rangeModified((E)node);
261                                 mapping.rangeModified((E)node.getParent());
262                         }
263                         removed.add(new Pair<E, String>(node, id));
264                         rangeModified = true;
265                 }
266                 repaint();
267         }
268         
269         private void receiveUpdate(E node, String id, boolean db) {
270                 if (DEBUG) System.out.println("receiveUpdate " + debugString(node)  + " " + id + " " + db);
271                 synchronized (syncMutex) {
272 //          for (Pair<E, String> n : updated) {
273 //              if (n.first.equals(node))
274 //                  return;
275 //          }
276                         if (changeTracking && !db)
277                                 mapping.rangeModified(node);
278                         //updated.add(new Pair<E, String>(node, id));
279                         updated.add(node, id);
280                         rangeModified = true;
281                 }
282                 repaint();
283         }
284         
285         private boolean graphUpdates = false;
286         private Set<E> graphModified = new HashSet<E>();
287         
288         private boolean requestCommit = false;
289         private String commitMessage = null;
290         
291         @Override
292         public void commit(String message) {
293                 requestCommit = true;
294                 commitMessage = message;
295         }
296         
297         protected void doCommit() {
298                 IProgressService service = PlatformUI.getWorkbench().getProgressService();
299                 try {
300                         service.busyCursorWhile(monitor -> {
301                                 try {
302                                         session.syncRequest(new WriteRequest() {
303                                                 @Override
304                                                 public void perform(WriteGraph graph) throws DatabaseException {
305                                                         if (DEBUG) System.out.println("Commit " + commitMessage);
306                                                         if (commitMessage != null) {
307                                                                 Layer0Utils.addCommentMetadata(graph, commitMessage);
308                                                                 graph.markUndoPoint();
309                                                                 commitMessage = null;
310                                                         }
311                                                         commit(graph);
312                                                 }
313                                         });
314                                 } catch (DatabaseException e) {
315                                         ExceptionUtils.logAndShowError("Cannot commit editor changes", e);
316                                 }
317                         });
318                 } catch (InvocationTargetException | InterruptedException e) {
319                         LOGGER.error("Unexpected exception", e);
320                 }
321         }
322         
323         protected void commit(WriteGraph graph) throws DatabaseException {
324                 synchronized(syncMutex) {
325                         if (DEBUG) System.out.println("Commit");
326                         graphUpdates = true;
327                         mapping.updateDomain(graph);
328                         graphUpdates = false;
329                         clearDeletes();
330                         if (DEBUG) System.out.println("Commit done");
331                 }
332         }
333         
334         
335         
336         @Override
337         public void domainModified() {
338                 if (graphUpdates)
339                         return;
340                 if (DEBUG)System.out.println("domainModified");
341                 session.asyncRequest(new UniqueRead<Object>() {
342                         @Override
343                         public Object perform(ReadGraph graph) throws DatabaseException {
344                                 return new Object();
345                         }
346                 }, new SyncProcedure<Object>() {
347                         @Override
348                         public void execute(ReadGraph graph, Object result) throws DatabaseException {
349                                 // Perform all updates to the model in a single query thread
350                                 update(graph);
351                         };
352                         
353                         @Override
354                         public void exception(ReadGraph graph, Throwable throwable) throws DatabaseException {
355                                 LOGGER.error("Failed to update pipeline changes" + throwable);
356                         }
357                 });
358         }
359         
360         protected void reset(ReadGraph graph) throws MappingException {
361                 if (DEBUG) System.out.println("Reset");
362                 
363                 graphUpdates = true;
364                 mapping.getRangeModified().clear();
365                 for (DBObject o : mapping.getDomain())
366                         mapping.domainModified(o);
367                 mapping.updateRange(graph);
368                 graphModified.clear();
369                 graphUpdates = false;
370         }
371         
372         private boolean useFullSyncWithUndo = false;
373         
374         protected void update(ReadGraph graph) throws DatabaseException {
375                 synchronized (syncMutex) {
376                         if (DEBUG) System.out.println("Graph update start");
377                         
378                         if (runUndo && useFullSyncWithUndo) {
379                                 reset(graph);
380                         } else {
381                                 graphUpdates = true;
382                                 for (DBObject domainObject : mapping.getDomainModified()) {
383                                         @SuppressWarnings("unchecked")
384                                         E rangeObject = (E) mapping.get(domainObject);
385                                         if (rangeObject != null)
386                                                 graphModified.add(rangeObject);
387                                 }
388                                 mapping.updateRange(graph);
389                                 graphModified.clear();
390                                 syncDeletes();
391                                 clearDeletes();
392                                 graphUpdates = false;
393                 }
394                         
395                         if (mapping.isRangeModified() && !runUndo && !runRedo)
396                                 commit((String)null);
397                         
398                         if (DEBUG) System.out.println("Graph update done");
399                 }
400         }
401         
402         @Override
403         public void rangeModified() {
404                 //System.out.println("rangeModified");
405
406         }
407         
408         @Override
409         public void postRender() {
410                 // Commit changes if
411                 // 1. Commit has been requested
412                 // 2. There are no pending changes that should be processed in preRender() 
413                 if (requestCommit && !rangeModified) { // FIXME : not thread safe.
414                         requestCommit = false;
415                         doCommit();
416                 }
417         }
418         
419         // Reusable containers for data synchronisation
420         List<Pair<E, String>> rem = new ArrayList<Pair<E,String>>();  // Removed objects
421         List<Pair<E, String>> add = new ArrayList<Pair<E,String>>();  // Added objects
422         MapSet<E, String> mod = new MapSet.Hash<E, String>();         // Modified objects
423         Set<E> propagation = new HashSet<E>();                        // Objects with propagated changes 
424         Stack<E> stack = new Stack<E>();                              // Stack for handling propagation
425         Set<E> delete = Collections.synchronizedSet(new HashSet<E>()); // Objects to be completely deleted
426         Set<E> deleteUC = new HashSet<E>();
427         
428         @Override
429         public synchronized void preRender() {
430                 updateCycle();
431         }
432         
433         
434         /**
435          * When objects are removed (either from Java or Graph), after remove processing the Java objects remain in mapping cache.
436          * This causes problems with Undo and Redo, which cause re-using the removed objects from mapping cache.
437          * 
438          * This code here synchronizes removed and added objects to collect deletable objects. (a deletable object is one which is removed but not added).  
439          * 
440          */
441         @SuppressWarnings("unused")
442         protected void syncDeletes() {
443                 deleteUC.clear();
444                 for (Pair<E, String> n : removed) {
445                         deleteUC.add(n.first);   
446                 }
447                 for (Pair<E, String> n : added) {
448                         deleteUC.remove(n.first);   
449                 } 
450                 if (DEBUG && deleteUC.size() > 0) {
451                         System.out.println("Delete sync");
452                         for (E n : delete) {
453                                 System.out.println(debugString(n));
454                         }
455                 }
456                 delete.addAll(deleteUC);
457                 deleteUC.clear();
458         }
459
460         /**
461          * Clears deletable objects from mapping cache.
462          */
463         @SuppressWarnings("unused")
464         protected void clearDeletes() {
465                 if (DEBUG && delete.size() > 0) System.out.println("Delete");
466                 for (E n : delete) {
467                         if (DEBUG) System.out.println(debugString(n));
468                         mapping.getRange().remove(n);
469                         stopListening(n);
470                 }
471                 delete.clear();
472         }
473         
474         protected String debugString(E n) {
475                 return n + "@" + Integer.toHexString(n.hashCode());
476         }
477         
478         protected boolean filterChange(List<Pair<E,String>> list,E n) {
479             for (int i = list.size()-1; i >= 0; i--) {
480             if (list.get(i).first == n) {
481                 list.remove(i);
482                 return true;
483             }
484         }
485             return false;
486         }
487         
488         @SuppressWarnings("unchecked")
489         protected void updateCycle() {
490                 rem.clear();
491                 add.clear();
492                 mod.clear();
493                 propagation.clear();
494                 
495                 
496                 synchronized (syncMutex) {
497                     // Check for overlapping additions and deletions, prevent deleting objects that are also added and vice versa.
498                     Deque<E> stack = new ArrayDeque<E>();
499                 for (Pair<E, String> n : added) {
500                     stack.add(n.first);
501                 }
502                 while (!stack.isEmpty()) {
503                     E n = stack.pop();
504                     boolean conflict = filterChange(removed, n);
505                     if (conflict) {
506                         if (DEBUG) System.out.println("Prevent removing " + n);
507                         //filterChange(added, n)
508                         if (filterChange(added, n))
509                            if (DEBUG) System.out.println("Prevent adding " + n);
510                     }
511                     if (n instanceof ParentNode) {
512                         ParentNode<INode> pn = (ParentNode<INode>)n;
513                         for (INode cn : pn.getNodes()) {
514                             stack.push((E)cn);
515                         }
516                     }
517                 }
518                 // Do not process updates for removed nodes.
519                 for (Pair<E, String> r : removed) {
520                     updated.removeValues(r.first);
521                 }
522                         rem.addAll(removed);
523                         add.addAll(added);
524                         for (E e : updated.getKeys()) {
525                                 for (String s : updated.getValues(e)) {
526                                         mod.add(e, s);
527                                 }
528                         }
529                         syncDeletes();
530                         removed.clear();
531                         added.clear();
532                         updated.clear();
533                 }
534                 
535                 
536                 for (Pair<E, String> n : rem) {
537                         stopListening(n.first);
538                         removeActor(n.first);
539                         n.first.remove();
540                 }
541                 
542             for (Pair<E, String> n : add) {
543                 addActor(n.first);
544                 listen(n.first);
545             }
546                 
547                 for (E e : mod.getKeys()) {
548                         Set<String> ids = mod.getValues(e);
549                         if (ids.contains(G3D.URIs.hasPosition) || ids.contains(G3D.URIs.hasOrientation)) {
550                                 if (!propagation.contains(e))
551                                         propagation.add(e);
552                         }
553                 }
554
555                 if (propagation.size() > 0) {
556                         stack.clear();
557                         stack.addAll(propagation);
558                         propagation.clear();
559                         while (!stack.isEmpty()) {
560                                 E node = stack.pop();
561                                 if (propagation.contains(node))
562                                         continue;
563                                 propagation.add(node);
564                                 for (NodeListener l : node.getListeners()) {
565                                         if (l == this) {
566                                                 //changeTracking = false;
567                                                 //l.propertyChanged(node, G3D.URIs.hasPosition);
568                                                 //changeTracking = true;
569                                         } else {
570                                                 l.propertyChanged(node, G3D.URIs.hasWorldPosition);
571                                         }
572                                 }
573                                 if (node instanceof ParentNode) {
574                                         stack.addAll(((ParentNode<E>)node).getNodes());
575                                 }
576                         }
577                 }
578                 
579                 for (E e : mod.getKeys()) {
580                         Set<String> ids = mod.getValues(e);
581                         updateActor(e,ids);
582                 }
583
584                 for (Pair<E, String> n : rem) {
585                         for (NodeListener l : nodeListeners)
586                                 l.nodeRemoved(null, n.first, n.second);
587                 }
588                 for (Pair<E, String> n : add) {
589                         for (NodeListener l : nodeListeners)
590                                 l.nodeAdded(n.first.getParent(), n.first, n.second);
591                 }
592 //      for (Pair<E, String> n : mod) {
593 //          for (NodeListener l : nodeListeners)
594 //              l.propertyChanged(n.first, n.second);
595 //      }
596                 for (E e : mod.getKeys()) {
597                         for (NodeListener l : nodeListeners)
598                                 for (String s : mod.getValues(e))
599                                         l.propertyChanged(e, s);
600                 }
601                 
602                 synchronized (syncMutex) {
603                         if (added.isEmpty() && removed.isEmpty() && updated.getKeys().size() == 0)
604                                 rangeModified = false;
605                 }
606         }
607         
608         @SuppressWarnings("unchecked")
609         private void listen(INode node) {
610                 node.addListener(this);
611                 if (node instanceof ParentNode<?>) {
612                         ParentNode<INode> parentNode = (ParentNode<INode>)node;
613                         for (INode n : parentNode.getNodes())
614                                 listen(n);
615                 }
616         }
617         
618         private void stopListening(INode node) {
619                 node.removeListener(this);
620                 if (node instanceof ParentNode<?>) {
621                         @SuppressWarnings("unchecked")
622                         ParentNode<INode> parentNode = (ParentNode<INode>)node;
623                         for (INode n : parentNode.getNodes())
624                                 stopListening(n);
625                 }
626         }
627         
628         @SuppressWarnings("unchecked")
629         @Override
630         public void propertyChanged(INode node, String id) {
631                 //receiveUpdate((E)node, id, graphUpdates);
632                 receiveUpdate((E)node, id, graphModified.contains(node));
633                 
634         }
635         
636         @SuppressWarnings("unchecked")
637         @Override
638         public <T extends INode> void nodeAdded(ParentNode<T> node, INode child,
639                         String rel) {
640                 if (DEBUG) System.out.println("Node added " + child + " parent " + node);
641                 //receiveAdd((E)child, rel ,graphUpdates);
642                 receiveAdd((E)child, rel ,graphModified.contains(node));
643         }
644         
645         @SuppressWarnings("unchecked")
646         @Override
647         public <T extends INode> void nodeRemoved(ParentNode<T> node, INode child,
648                         String rel) {
649                 if (DEBUG) System.out.println("Node removed " + child + " parent " + node);
650                 //receiveRemove((E)child, rel, graphUpdates);
651                 receiveRemove((E)child, rel, graphModified.contains(node));
652                 
653                 //FIXME : 1. sometimes removed structural models cause ObjMap to add their children again.
654                 //           removing the listener here prevents corruption of visual model, but better fix is needed.
655                 //        2. detach causes nodeRemoved event, which then causes other critical events to be missed. Took out call: 
656                 //stopListening(child);
657         }
658         
659         @Override
660         public void delete() {
661                 if (undoRedoSupport != null)
662                         undoRedoSupport.cancel(this);
663                 
664                 changeTracking = false;
665                 view.removeListener(this);
666                 mapping.removeMappingListener(this);
667
668                 List<E> nodes = new ArrayList<E>(nodeToActor.getKeySize());
669                 nodes.addAll(nodeToActor.getKeys());
670                 for (E node : nodes) {
671                         node.removeListener(this);
672                         removeActor(node);
673                         node.cleanup();
674                 }
675                 for (vtkProp prop : actorToNode.keySet()) {
676                         if (prop.GetVTKId() != 0) 
677                                 prop.Delete();
678                 }
679                 actorToNode.clear();
680                 nodeToActor.clear();
681                 
682         }
683         
684         
685         private List<NodeListener> nodeListeners = new ArrayList<NodeListener>();
686         @Override
687         public void addListener(NodeListener listener) {
688                 nodeListeners.add(listener);
689                 
690         }
691         
692         @Override
693         public void removeListener(NodeListener listener) {
694                 nodeListeners.remove(listener);
695                 
696         }
697         
698         public IMapping<DBObject,INode> getMapping() {
699                 return mapping;
700         }
701         
702         
703 }