1 /*******************************************************************************
2 * Copyright (c) 2012, 2013 Association for Decentralized Information Management in
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
10 * VTT Technical Research Centre of Finland - initial API and implementation
11 *******************************************************************************/
12 package org.simantics.g3d.vtk.common;
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;
25 import java.util.Stack;
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;
56 public abstract class AbstractVTKNodeMap<DBObject,E extends INode> implements VTKNodeMap<DBObject,E>, IMappingListener, RenderListener, NodeListener, UndoRedoSupport.ChangeListener{
58 private static final boolean DEBUG = true;
60 private static final Logger LOGGER = LoggerFactory.getLogger(AbstractVTKNodeMap.class);
62 protected Session session;
63 protected IMapping<DBObject, INode> mapping;
64 protected VtkView view;
66 private MapList<E, vtkProp> nodeToActor = new MapList<E, vtkProp>();
67 private Map<vtkProp,E> actorToNode = new HashMap<vtkProp, E>();
69 protected ParentNode<E> rootNode;
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;
80 this.rootNode = rootNode;
81 view.addListener(this);
82 mapping.addMappingListener(this);
83 rootNode.addListener(this);
85 undoRedoSupport = session.getService(UndoRedoSupport.class);
86 undoRedoSupport.subscribe(this);
88 UndoContext undoContext = undoRedoSupport.getUndoContext(session);
89 undoOpCount = undoContext.getAll().size();
90 redoOpCount = undoContext.getRedoList().size();
91 } catch(DatabaseException e) {
96 protected abstract void addActor(E node);
97 protected abstract void removeActor(E node);
98 protected abstract void updateActor(E node,Set<String> ids);
100 public void repaint() {
104 public void populate() {
105 for (E node : rootNode.getNodes()) {
106 receiveAdd(node, node.getParentRel(),true);
112 public E getNode(vtkProp prop) {
113 return actorToNode.get(prop);
116 @SuppressWarnings("unchecked")
118 public Collection<vtkProp> getRenderObjects(INode node) {
119 return nodeToActor.getValues((E) node);
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);
129 protected void removeMap(E node) {
130 Collection<vtkProp> coll = nodeToActor.getValuesUnsafe(node);
131 if (coll.size() > 0) {
133 for (vtkProp p : coll) {
134 actorToNode.remove(p);
135 if (p.GetVTKId() != 0) {
136 view.getRenderer().RemoveActor(p);
142 nodeToActor.remove(node);
146 public ParentNode<E> getRootNode() {
147 return (ParentNode<E>)rootNode;
153 public boolean isChangeTracking() {
154 return changeTracking;
158 public void setChangeTracking(boolean enabled) {
159 changeTracking = enabled;
162 private boolean changeTracking = true;
164 protected Object syncMutex = new Object();
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>();
171 private boolean rangeModified = false;
173 public boolean isRangeModified() {
174 return rangeModified;
178 public void onChanged() {
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) {
189 if (!runUndo && rcount > 0)
193 undoOpCount = ucount;
194 redoOpCount = rcount;
196 if (DEBUG) System.out.println("Undo " + runUndo + " Redo " + runRedo);
197 } catch (DatabaseException e) {
198 // TODO Auto-generated catch block
206 public void updateRenderObjectsFor(E node) {
207 List<vtkProp> toDelete = new ArrayList<vtkProp>();
209 for (vtkProp prop : nodeToActor.getValues(node)) {
210 if (prop.GetVTKId() != 0) {
211 view.getRenderer().RemoveActor(prop);
215 actorToNode.remove(prop);
218 nodeToActor.remove(node);
219 Collection<vtkProp> coll = getActors(node);
221 for (vtkProp prop : coll) {
222 nodeToActor.add(node,prop);
223 actorToNode.put(prop, node);
224 toDelete.remove(prop);
227 for (vtkProp p : toDelete)
231 protected abstract Collection<vtkProp> getActors(E node);
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))
241 if (changeTracking) {
242 mapping.rangeModified((E)node.getParent());
243 mapping.rangeModified((E)node);
245 added.add(new Pair<E, String>(node, id));
246 rangeModified = true;
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))
259 if (changeTracking && !db) {
260 mapping.rangeModified((E)node);
261 mapping.rangeModified((E)node.getParent());
263 removed.add(new Pair<E, String>(node, id));
264 rangeModified = true;
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))
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;
285 private boolean graphUpdates = false;
286 private Set<E> graphModified = new HashSet<E>();
288 private boolean requestCommit = false;
289 private String commitMessage = null;
292 public void commit(String message) {
293 requestCommit = true;
294 commitMessage = message;
297 protected void doCommit() {
298 IProgressService service = PlatformUI.getWorkbench().getProgressService();
300 service.busyCursorWhile(monitor -> {
302 session.syncRequest(new WriteRequest() {
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;
314 } catch (DatabaseException e) {
315 ExceptionUtils.logAndShowError("Cannot commit editor changes", e);
318 } catch (InvocationTargetException | InterruptedException e) {
319 LOGGER.error("Unexpected exception", e);
323 protected void commit(WriteGraph graph) throws DatabaseException {
324 synchronized(syncMutex) {
325 if (DEBUG) System.out.println("Commit");
327 mapping.updateDomain(graph);
328 graphUpdates = false;
330 if (DEBUG) System.out.println("Commit done");
337 public void domainModified() {
340 if (DEBUG)System.out.println("domainModified");
341 session.asyncRequest(new UniqueRead<Object>() {
343 public Object perform(ReadGraph graph) throws DatabaseException {
346 }, new SyncProcedure<Object>() {
348 public void execute(ReadGraph graph, Object result) throws DatabaseException {
349 // Perform all updates to the model in a single query thread
354 public void exception(ReadGraph graph, Throwable throwable) throws DatabaseException {
355 LOGGER.error("Failed to update pipeline changes" + throwable);
360 protected void reset(ReadGraph graph) throws MappingException {
361 if (DEBUG) System.out.println("Reset");
364 mapping.getRangeModified().clear();
365 for (DBObject o : mapping.getDomain())
366 mapping.domainModified(o);
367 mapping.updateRange(graph);
368 graphModified.clear();
369 graphUpdates = false;
372 private boolean useFullSyncWithUndo = false;
374 protected void update(ReadGraph graph) throws DatabaseException {
375 if (DEBUG) System.out.println("Graph update start");
377 if (runUndo && useFullSyncWithUndo) {
378 synchronized (syncMutex) {
382 synchronized (syncMutex) {
384 for (DBObject domainObject : mapping.getDomainModified()) {
385 @SuppressWarnings("unchecked")
386 E rangeObject = (E) mapping.get(domainObject);
387 if (rangeObject != null)
388 graphModified.add(rangeObject);
393 mapping.updateRange(graph);
395 synchronized (syncMutex) {
396 graphModified.clear();
401 graphUpdates = false;
404 if (mapping.isRangeModified() && !runUndo && !runRedo)
405 commit((String)null);
407 if (DEBUG) System.out.println("Graph update done");
411 public void rangeModified() {
412 //System.out.println("rangeModified");
417 public void postRender() {
419 // 1. Commit has been requested
420 // 2. There are no pending changes that should be processed in preRender()
421 if (requestCommit && !rangeModified) { // FIXME : not thread safe.
422 requestCommit = false;
427 // Reusable containers for data synchronisation
428 List<Pair<E, String>> rem = new ArrayList<Pair<E,String>>(); // Removed objects
429 List<Pair<E, String>> add = new ArrayList<Pair<E,String>>(); // Added objects
430 MapSet<E, String> mod = new MapSet.Hash<E, String>(); // Modified objects
431 Set<E> propagation = new HashSet<E>(); // Objects with propagated changes
432 Stack<E> stack = new Stack<E>(); // Stack for handling propagation
433 Set<E> delete = Collections.synchronizedSet(new HashSet<E>()); // Objects to be completely deleted
434 Set<E> deleteUC = new HashSet<E>();
437 public synchronized void preRender() {
443 * When objects are removed (either from Java or Graph), after remove processing the Java objects remain in mapping cache.
444 * This causes problems with Undo and Redo, which cause re-using the removed objects from mapping cache.
446 * This code here synchronizes removed and added objects to collect deletable objects. (a deletable object is one which is removed but not added).
449 protected void syncDeletes() {
451 for (Pair<E, String> n : removed) {
452 deleteUC.add(n.first);
454 for (Pair<E, String> n : added) {
455 deleteUC.remove(n.first);
457 if (DEBUG && deleteUC.size() > 0) {
458 System.out.println("Delete sync");
460 System.out.println(debugString(n));
463 delete.addAll(deleteUC);
468 * Clears deletable objects from mapping cache.
470 protected void clearDeletes() {
471 if (DEBUG && delete.size() > 0) System.out.println("Delete");
473 if (DEBUG) System.out.println(debugString(n));
474 mapping.getRange().remove(n);
480 protected String debugString(E n) {
481 return n + "@" + Integer.toHexString(n.hashCode());
484 protected boolean filterChange(List<Pair<E,String>> list,E n) {
485 for (int i = list.size()-1; i >= 0; i--) {
486 if (list.get(i).first == n) {
494 @SuppressWarnings("unchecked")
495 protected void updateCycle() {
502 synchronized (syncMutex) {
503 // Check for overlapping additions and deletions, prevent deleting objects that are also added and vice versa.
504 Deque<E> stack = new ArrayDeque<E>();
505 for (Pair<E, String> n : added) {
508 while (!stack.isEmpty()) {
510 boolean conflict = filterChange(removed, n);
512 if (DEBUG) System.out.println("Prevent removing " + n);
513 //filterChange(added, n)
514 if (filterChange(added, n))
515 if (DEBUG) System.out.println("Prevent adding " + n);
517 if (n instanceof ParentNode) {
518 ParentNode<INode> pn = (ParentNode<INode>)n;
519 for (INode cn : pn.getNodes()) {
524 // Do not process updates for removed nodes.
525 for (Pair<E, String> r : removed) {
526 updated.removeValues(r.first);
530 for (E e : updated.getKeys()) {
531 for (String s : updated.getValues(e)) {
542 for (Pair<E, String> n : rem) {
543 stopListening(n.first);
544 removeActor(n.first);
548 for (Pair<E, String> n : add) {
553 for (E e : mod.getKeys()) {
554 Set<String> ids = mod.getValues(e);
555 if (ids.contains(G3D.URIs.hasPosition) || ids.contains(G3D.URIs.hasOrientation)) {
556 if (!propagation.contains(e))
561 if (propagation.size() > 0) {
563 stack.addAll(propagation);
565 while (!stack.isEmpty()) {
566 E node = stack.pop();
567 if (propagation.contains(node))
569 propagation.add(node);
570 for (NodeListener l : node.getListeners()) {
572 //changeTracking = false;
573 //l.propertyChanged(node, G3D.URIs.hasPosition);
574 //changeTracking = true;
576 l.propertyChanged(node, G3D.URIs.hasWorldPosition);
579 if (node instanceof ParentNode) {
580 stack.addAll(((ParentNode<E>)node).getNodes());
585 for (E e : mod.getKeys()) {
586 Set<String> ids = mod.getValues(e);
590 for (Pair<E, String> n : rem) {
591 for (NodeListener l : nodeListeners)
592 l.nodeRemoved(null, n.first, n.second);
594 for (Pair<E, String> n : add) {
595 for (NodeListener l : nodeListeners)
596 l.nodeAdded(n.first.getParent(), n.first, n.second);
598 // for (Pair<E, String> n : mod) {
599 // for (NodeListener l : nodeListeners)
600 // l.propertyChanged(n.first, n.second);
602 for (E e : mod.getKeys()) {
603 for (NodeListener l : nodeListeners)
604 for (String s : mod.getValues(e))
605 l.propertyChanged(e, s);
608 synchronized (syncMutex) {
609 if (added.isEmpty() && removed.isEmpty() && updated.getKeys().size() == 0)
610 rangeModified = false;
614 @SuppressWarnings("unchecked")
615 private void listen(INode node) {
616 node.addListener(this);
617 if (node instanceof ParentNode<?>) {
618 ParentNode<INode> parentNode = (ParentNode<INode>)node;
619 for (INode n : parentNode.getNodes())
624 private void stopListening(INode node) {
625 node.removeListener(this);
626 if (node instanceof ParentNode<?>) {
627 @SuppressWarnings("unchecked")
628 ParentNode<INode> parentNode = (ParentNode<INode>)node;
629 for (INode n : parentNode.getNodes())
634 @SuppressWarnings("unchecked")
636 public void propertyChanged(INode node, String id) {
637 //receiveUpdate((E)node, id, graphUpdates);
638 receiveUpdate((E)node, id, graphModified.contains(node));
642 @SuppressWarnings("unchecked")
644 public <T extends INode> void nodeAdded(ParentNode<T> node, INode child,
646 if (DEBUG) System.out.println("Node added " + child + " parent " + node);
647 //receiveAdd((E)child, rel ,graphUpdates);
648 receiveAdd((E)child, rel ,graphModified.contains(node));
651 @SuppressWarnings("unchecked")
653 public <T extends INode> void nodeRemoved(ParentNode<T> node, INode child,
655 if (DEBUG) System.out.println("Node removed " + child + " parent " + node);
656 //receiveRemove((E)child, rel, graphUpdates);
657 receiveRemove((E)child, rel, graphModified.contains(node));
659 //FIXME : 1. sometimes removed structural models cause ObjMap to add their children again.
660 // removing the listener here prevents corruption of visual model, but better fix is needed.
661 // 2. detach causes nodeRemoved event, which then causes other critical events to be missed. Took out call:
662 //stopListening(child);
666 public void delete() {
667 if (undoRedoSupport != null)
668 undoRedoSupport.cancel(this);
670 changeTracking = false;
671 view.removeListener(this);
672 mapping.removeMappingListener(this);
674 List<E> nodes = new ArrayList<E>(nodeToActor.getKeySize());
675 nodes.addAll(nodeToActor.getKeys());
676 for (E node : nodes) {
677 node.removeListener(this);
681 for (vtkProp prop : actorToNode.keySet()) {
682 if (prop.GetVTKId() != 0)
691 private List<NodeListener> nodeListeners = new ArrayList<NodeListener>();
693 public void addListener(NodeListener listener) {
694 nodeListeners.add(listener);
699 public void removeListener(NodeListener listener) {
700 nodeListeners.remove(listener);
704 public IMapping<DBObject,INode> getMapping() {