1 package org.simantics.g3d.scl;
3 import java.util.ArrayList;
4 import java.util.Collection;
5 import java.util.Collections;
6 import java.util.HashSet;
9 import java.util.Stack;
11 import org.simantics.db.ReadGraph;
12 import org.simantics.db.Session;
13 import org.simantics.db.WriteGraph;
14 import org.simantics.db.common.request.ReadRequest;
15 import org.simantics.db.common.request.WriteRequest;
16 import org.simantics.db.exception.DatabaseException;
17 import org.simantics.db.layer0.util.Layer0Utils;
18 import org.simantics.g3d.ontology.G3D;
19 import org.simantics.g3d.scenegraph.NodeMap;
20 import org.simantics.g3d.scenegraph.base.INode;
21 import org.simantics.g3d.scenegraph.base.NodeListener;
22 import org.simantics.g3d.scenegraph.base.ParentNode;
23 import org.simantics.objmap.exceptions.MappingException;
24 import org.simantics.objmap.graph.IMapping;
25 import org.simantics.objmap.graph.IMappingListener;
26 import org.simantics.utils.datastructures.MapSet;
27 import org.simantics.utils.datastructures.Pair;
30 * NodeMap implementation used with SCL scripts.
32 * In practice, there are no visible objects to synchronize.
35 * This implementation is Copy-paste of AbstractVTKNodeMap with VTK references removed.
36 * There may be more sensible way to do this.
43 public abstract class ScriptNodeMap<E extends INode> implements NodeMap<Object,E>, IMappingListener, NodeListener {
45 private static final boolean DEBUG = false;
47 protected Session session;
48 protected IMapping<Object,E> mapping;
50 protected ParentNode<E> rootNode;
52 protected Set<E> nodes = new HashSet<E>();
54 private boolean dirty = false;
56 public ScriptNodeMap(Session session, IMapping<Object,E> mapping, ParentNode<E> rootNode) {
57 this.session = session;
58 this.mapping = mapping;
59 this.rootNode = rootNode;
60 mapping.addMappingListener(this);
61 rootNode.addListener(this);
66 protected abstract void addActor(E node);
67 protected abstract void removeActor(E node);
68 protected abstract void updateActor(E node,Set<String> ids);
70 public void repaint() {
74 public void populate() {
75 for (E node : rootNode.getNodes()) {
76 receiveAdd(node, node.getParentRel(),true);
82 public E getNode(Object o) {
86 @SuppressWarnings("unchecked")
88 public Collection<Object> getRenderObjects(INode node) {
89 return Collections.EMPTY_LIST;
92 @SuppressWarnings("unchecked")
94 public ParentNode<E> getRootNode() {
95 return (ParentNode<E>)rootNode;
101 public boolean isChangeTracking() {
102 return changeTracking;
106 public void setChangeTracking(boolean enabled) {
107 changeTracking = enabled;
110 private boolean changeTracking = true;
112 protected Object syncMutex = new Object();
115 private List<Pair<E,String>> added = new ArrayList<Pair<E,String>>();
116 private List<Pair<E,String>> removed = new ArrayList<Pair<E,String>>();
117 private MapSet<E, String> updated = new MapSet.Hash<E, String>();
119 private boolean rangeModified = false;
121 @SuppressWarnings("unchecked")
123 public void updateRenderObjectsFor(E node) {
128 @SuppressWarnings("unchecked")
129 private void receiveAdd(E node, String id, boolean db) {
130 if (DEBUG) System.out.println("receiveAdd " + debugString(node) + " " + id + " " + db);
131 synchronized (syncMutex) {
132 for (Pair<E, String> n : added) {
133 if (n.first.equals(node))
136 if (changeTracking) {
137 mapping.rangeModified((E)node.getParent());
139 added.add(new Pair<E, String>(node, id));
140 rangeModified = true;
145 @SuppressWarnings("unchecked")
146 private void receiveRemove(E node, String id, boolean db) {
147 if (DEBUG) System.out.println("receiveRemove " + debugString(node) + " " + id + " " + db);
148 synchronized (syncMutex) {
149 for (Pair<E, String> n : removed) {
150 if (n.first.equals(node))
153 if (changeTracking && !db)
154 mapping.rangeModified((E)node.getParent());
155 removed.add(new Pair<E, String>(node, id));
156 rangeModified = true;
161 @SuppressWarnings("unchecked")
162 private void receiveUpdate(E node, String id, boolean db) {
163 if (DEBUG) System.out.println("receiveUpdate " + debugString(node) + " " + id + " " + db);
164 synchronized (syncMutex) {
165 // for (Pair<E, String> n : updated) {
166 // if (n.first.equals(node))
169 if (changeTracking && !db)
170 mapping.rangeModified(node);
171 //updated.add(new Pair<E, String>(node, id));
172 updated.add(node, id);
173 rangeModified = true;
178 private boolean graphUpdates = false;
179 private Set<E> graphModified = new HashSet<E>();
181 private boolean requestCommit = false;
182 private String commitMessage = null;
185 public void commit(String message) {
186 requestCommit = true;
187 commitMessage = message;
190 protected void doCommit() throws DatabaseException {
191 session.syncRequest(new WriteRequest() {
194 public void perform(WriteGraph graph) throws DatabaseException {
195 if (DEBUG) System.out.println("Commit " + commitMessage);
196 if (commitMessage != null) {
197 Layer0Utils.addCommentMetadata(graph, commitMessage);
198 graph.markUndoPoint();
199 commitMessage = null;
207 protected void commit(WriteGraph graph) throws DatabaseException {
208 synchronized(syncMutex) {
209 if (DEBUG) System.out.println("Commit");
211 mapping.updateDomain(graph);
212 graphUpdates = false;
214 if (DEBUG) System.out.println("Commit done");
221 public void domainModified() {
224 if (DEBUG)System.out.println("domainModified");
225 // FIXME : this is called by IMapping id DB thread
227 // session.asyncRequest(new ReadRequest() {
229 // @SuppressWarnings("unchecked")
231 // public void run(ReadGraph graph) throws DatabaseException {
238 protected void reset(ReadGraph graph) throws MappingException {
239 if (DEBUG) System.out.println("Reset");
240 synchronized (syncMutex) {
242 mapping.getRangeModified().clear();
243 for (Object o : mapping.getDomain())
244 mapping.domainModified(o);
245 mapping.updateRange(graph);
246 graphModified.clear();
247 graphUpdates = false;
251 protected void update(ReadGraph graph) throws DatabaseException {
252 if (DEBUG) System.out.println("Graph update start");
253 synchronized (syncMutex) {
255 for (Object domainObject : mapping.getDomainModified()) {
256 E rangeObject = mapping.get(domainObject);
257 if (rangeObject != null)
258 graphModified.add(rangeObject);
260 mapping.updateRange(graph);
261 graphModified.clear();
264 graphUpdates = false;
268 //if (mapping.isRangeModified() && !runUndo) // FIXME : redo?
269 if (mapping.isRangeModified())
270 commit((String)null);
271 if (DEBUG) System.out.println("Graph update done");
275 public void rangeModified() {
276 //System.out.println("rangeModified");
280 public void update() throws DatabaseException{
286 if (requestCommit && !rangeModified) { // FIXME : not thread safe.
287 requestCommit = false;
290 session.syncRequest(new ReadRequest() {
291 @SuppressWarnings("unchecked")
293 public void run(ReadGraph graph) throws DatabaseException {
302 // Reusable containers for data synchronisation
303 List<Pair<E, String>> rem = new ArrayList<Pair<E,String>>(); // Removed objects
304 List<Pair<E, String>> add = new ArrayList<Pair<E,String>>(); // Added objects
305 MapSet<E, String> mod = new MapSet.Hash<E, String>(); // Modified objects
306 Set<E> propagation = new HashSet<E>(); // Objects with propagated changes
307 Stack<E> stack = new Stack<E>(); // Stack for handling propagation
308 Set<E> delete = Collections.synchronizedSet(new HashSet<E>()); // Objects to be completely deleted
309 Set<E> deleteUC = new HashSet<E>();
314 * When objects are removed (either from Java or Graph), after remove processing the Java objects remain in mapping cache.
315 * This causes problems with Undo and Redo, whcih the end up re-using the removed objects from mapping cache.
317 * This code here synchronizes removed and added objects to collect deletable objects. (a deletable object is one which is removed but not added).
320 protected void syncDeletes() {
322 for (Pair<E, String> n : removed) {
323 deleteUC.add(n.first);
325 for (Pair<E, String> n : added) {
326 deleteUC.remove(n.first);
328 if (DEBUG && deleteUC.size() > 0) {
329 System.out.println("Delete sync");
331 System.out.println(debugString(n));
334 delete.addAll(deleteUC);
339 * Clears deletable objects from mapping cache.
341 protected void clearDeletes() {
342 if (DEBUG && delete.size() > 0) System.out.println("Delete");
344 if (DEBUG) System.out.println(debugString(n));
345 mapping.getRange().remove(n);
350 protected String debugString(E n) {
351 return n + "@" + Integer.toHexString(n.hashCode());
354 @SuppressWarnings("unchecked")
355 protected void updateCycle() {
362 synchronized (syncMutex) {
365 for (E e : updated.getKeys()) {
366 for (String s : updated.getValues(e)) {
376 for (Pair<E, String> n : rem) {
377 stopListening(n.first);
378 removeActor(n.first);
381 for (Pair<E, String> n : add) {
386 for (E e : mod.getKeys()) {
387 Set<String> ids = mod.getValues(e);
388 if (ids.contains(G3D.URIs.hasPosition) || ids.contains(G3D.URIs.hasOrientation)) {
389 if (!propagation.contains(e))
394 if (propagation.size() > 0) {
396 stack.addAll(propagation);
398 while (!stack.isEmpty()) {
399 E node = stack.pop();
400 if (propagation.contains(node))
402 propagation.add(node);
403 for (NodeListener l : node.getListeners()) {
405 //changeTracking = false;
406 //l.propertyChanged(node, G3D.URIs.hasPosition);
407 //changeTracking = true;
409 l.propertyChanged(node, G3D.URIs.hasWorldPosition);
412 if (node instanceof ParentNode) {
413 stack.addAll(((ParentNode<E>)node).getNodes());
418 // synchronized (syncMutex) {
419 // rem.addAll(removed);
420 // add.addAll(added);
421 // //mod.addAll(updated);
422 // for (E e : updated.getKeys()) {
423 // for (String s : updated.getValues(e))
432 for (E e : mod.getKeys()) {
433 Set<String> ids = mod.getValues(e);
438 for (Pair<E, String> n : rem) {
439 for (NodeListener l : nodeListeners)
440 l.nodeRemoved(null, n.first, n.second);
442 for (Pair<E, String> n : add) {
443 for (NodeListener l : nodeListeners)
444 l.nodeAdded(n.first.getParent(), n.first, n.second);
446 // for (Pair<E, String> n : mod) {
447 // for (NodeListener l : nodeListeners)
448 // l.propertyChanged(n.first, n.second);
450 for (E e : mod.getKeys()) {
451 for (NodeListener l : nodeListeners)
452 for (String s : mod.getValues(e))
453 l.propertyChanged(e, s);
456 synchronized (syncMutex) {
457 if (added.isEmpty() && removed.isEmpty() && updated.getKeys().size() == 0)
458 rangeModified = false;
462 @SuppressWarnings("unchecked")
463 private void listen(INode node) {
464 node.addListener(this);
465 if (node instanceof ParentNode<?>) {
466 ParentNode<INode> parentNode = (ParentNode<INode>)node;
467 for (INode n : parentNode.getNodes())
472 private void stopListening(INode node) {
473 node.removeListener(this);
474 if (node instanceof ParentNode<?>) {
475 @SuppressWarnings("unchecked")
476 ParentNode<INode> parentNode = (ParentNode<INode>)node;
477 for (INode n : parentNode.getNodes())
482 @SuppressWarnings("unchecked")
484 public void propertyChanged(INode node, String id) {
485 //receiveUpdate((E)node, id, graphUpdates);
486 receiveUpdate((E)node, id, graphModified.contains(node));
490 @SuppressWarnings("unchecked")
492 public <T extends INode> void nodeAdded(ParentNode<T> node, INode child,
494 if (DEBUG) System.out.println("Node added " + child + " parent " + node);
495 //receiveAdd((E)child, rel ,graphUpdates);
496 receiveAdd((E)child, rel ,graphModified.contains(node));
500 @SuppressWarnings("unchecked")
502 public <T extends INode> void nodeRemoved(ParentNode<T> node, INode child,
504 if (DEBUG) System.out.println("Node removed " + child + " parent " + node);
505 //receiveRemove((E)child, rel, graphUpdates);
506 receiveRemove((E)child, rel, graphModified.contains(node));
508 //FIXME : sometimes removed structural models cause ObjMap to add their children again.
509 // removing the listener here prevents corruption of visual model, but better fix is needed.
510 stopListening(child);
514 public void delete() {
516 changeTracking = false;
517 mapping.removeMappingListener(this);
519 for (E node : nodes) {
520 node.removeListener(this);
528 private List<NodeListener> nodeListeners = new ArrayList<NodeListener>();
530 public void addListener(NodeListener listener) {
531 nodeListeners.add(listener);
536 public void removeListener(NodeListener listener) {
537 nodeListeners.remove(listener);
541 public IMapping<Object,E> getMapping() {