--- /dev/null
+/*******************************************************************************\r
+ * Copyright (c) 2007, 2010 Association for Decentralized Information Management\r
+ * in Industry THTH ry.\r
+ * All rights reserved. This program and the accompanying materials\r
+ * are made available under the terms of the Eclipse Public License v1.0\r
+ * which accompanies this distribution, and is available at\r
+ * http://www.eclipse.org/legal/epl-v10.html\r
+ *\r
+ * Contributors:\r
+ * VTT Technical Research Centre of Finland - initial API and implementation\r
+ *******************************************************************************/\r
+package org.simantics.scenegraph.g2d;
+
+import java.awt.Component;\r
+import java.awt.Container;\r
+import java.awt.Graphics2D;\r
+import java.util.ArrayDeque;\r
+import java.util.Deque;\r
+import java.util.HashMap;\r
+import java.util.HashSet;\r
+import java.util.Map;\r
+import java.util.Set;\r
+import java.util.logging.Level;\r
+import java.util.logging.Logger;\r
+\r
+import javax.swing.JComponent;\r
+import javax.swing.RepaintManager;\r
+\r
+import org.simantics.scenegraph.ILookupService;\r
+import org.simantics.scenegraph.INode;\r
+import org.simantics.scenegraph.LookupService;\r
+import org.simantics.scenegraph.ParentNode;\r
+import org.simantics.scenegraph.g2d.events.EventDelegator;\r
+import org.simantics.scenegraph.g2d.events.INodeEventHandlerProvider;\r
+import org.simantics.scenegraph.g2d.events.NodeEventHandler;\r
+\r
+/**\r
+ * The root node of a 2D scene graph.\r
+ * \r
+ * Implements {@link ILookupService} according to the reference implementation\r
+ * {@link LookupService}.\r
+ * \r
+ * @author J-P Laine\r
+ */\r
+@SuppressWarnings("deprecation")\r
+public class G2DSceneGraph extends G2DParentNode implements ILookupService, INodeEventHandlerProvider {\r
+\r
+ private static final long serialVersionUID = -7066146333849901429L;\r
+ \r
+ public static final String IGNORE_FOCUS = "ignoreFocus";\r
+\r
+ protected transient Container rootPane = null;\r
+ // TODO: swing dependency in here might not be a good idea\r
+
+ // This variable is actually used in remote use, when rendering is not performed locally\r
+ private transient final Object treeLock = new Object();\r
+\r
+ private HashMap<Object, Integer> pending = new HashMap<Object, Integer>();\r
+ private HashMap<String, Object> globalProperties = new HashMap<String, Object>();\r
+\r
+ /**\r
+ * For preventing duplicates on the nodesToRemove queue.\r
+ */\r
+ protected transient Set<INode> nodesToRemoveSet = new HashSet<INode>();\r
+ protected Deque<INode> nodesToRemove = new ArrayDeque<INode>();\r
+\r
+ private transient EventDelegator eventDelegator = new EventDelegator(this);\r
+ private transient NodeEventHandler eventHandler = new NodeEventHandler(this);\r
+\r
+ /**\r
+ * The node that has input focus in the scene graph. The input node will\r
+ * receive key and command events.\r
+ */\r
+ private transient IG2DNode focusNode;\r
+\r
+ /**\r
+ * The custom repaint manager of this scene graph.\r
+ */\r
+ private transient G2DRepaintManager repaintManager;\r
+\r
+ /**\r
+ * Returns the event delegator, that is responsible for delegating events to nodes in the sg tree\r
+ * \r
+ * @return EventDelegator instance, always not null\r
+ */\r
+ public EventDelegator getEventDelegator() {\r
+ return eventDelegator;\r
+ }\r
+\r
+ /**\r
+ * Returns the node event handler, that is responsible for delegating events\r
+ * to nodes in the sg tree.\r
+ * \r
+ * @return NodeEventHandler instance for this scene graph, always non-null\r
+ */\r
+ public NodeEventHandler getEventHandler() {\r
+ return eventHandler;\r
+ }\r
+\r
+ public void setFocusNode(IG2DNode focusNode) {\r
+ this.focusNode = focusNode;\r
+ }\r
+\r
+ public IG2DNode getFocusNode() {\r
+ return focusNode;\r
+ }\r
+
+ @Override
+ public void render(Graphics2D g2d) {
+ performCleanup();\r
+ Component rootPane = getRootPane();\r
+ if (rootPane != null)\r
+ g2d.setRenderingHint(G2DRenderingHints.KEY_COMPONENT, rootPane);\r
+ synchronized(treeLock) {
+ super.render(g2d);
+ }
+ }\r
+\r
+ /**\r
+ * Util method for executing updates to scenegraph tree\r
+ * NOTE: You should really consider performance issues when using this\r
+ * \r
+ * @param r Runnable to be executed while rendering is not performed\r
+ */\r
+ public void syncExec(Runnable r) {\r
+ synchronized(treeLock) {\r
+ r.run();\r
+ }\r
+ }
+\r
+ /**\r
+ * Set rootpane for swing components. This is used as parent for the components created by ComponentNode.\r
+ * \r
+ * @param rootPane Component that is used as a parent for the swing component (This shouldn't be visible)\r
+ */
+ public void setRootPane(JComponent rootPane) {
+ synchronized (RepaintManager.class) {\r
+ RepaintManager old = RepaintManager.currentManager(rootPane);
+ old = findProperRepaintManager(old);\r
+ this.repaintManager = new G2DRepaintManager(rootPane.getClass(), old);\r
+ RepaintManager.setCurrentManager(repaintManager);\r
+ }\r
+ this.rootPane = rootPane;
+ }\r
+\r
+ /**\r
+ * Set rootpane for swing components. This is used as parent for the components created by ComponentNode.\r
+ * Supports separate component that is responsible for repainting the scenegraph.\r
+ * \r
+ * @param rootPane Component that is used as a parent for the swing component (This shouldn't be visible)\r
+ * @param paintContext Component that is responsible for repainting the scenegraph\r
+ */
+ public void setRootPane(Container rootPane, Component paintContext) {\r
+ synchronized (RepaintManager.class) {\r
+ RepaintManager old = RepaintManager.currentManager(paintContext);\r
+ old = findProperRepaintManager(old);\r
+ this.repaintManager = new G2DRepaintManager(paintContext.getClass(), old);\r
+ RepaintManager.setCurrentManager(repaintManager);\r
+ }\r
+ this.rootPane = rootPane;\r
+ eventHandler.setRootPane(rootPane);\r
+ }\r
+
+ private RepaintManager findProperRepaintManager(RepaintManager old) {\r
+ while (old instanceof G2DRepaintManager) {\r
+ G2DRepaintManager g2drm = (G2DRepaintManager) old;\r
+ old = g2drm.getDelegate();\r
+ }\r
+ return old;\r
+ }\r
+\r
+ public G2DRepaintManager getRepaintManager() {\r
+ return repaintManager;\r
+ }\r
+\r
+ /**
+ * Put the node to the remove queue
+ */
+ @Override
+ public void asyncRemoveNode(INode node) {
+ synchronized(nodesToRemove) {\r
+ // Prevent nodes from winding up twice on the nodesToRemove queue\r
+ if (nodesToRemoveSet.add(node)) {
+ nodesToRemove.add(node); // This is performed when called inside the render\r
+ }
+ }
+ }
+
+ /**
+ * Perform the actual removal of the nodes in the nodesToRemove list
+ */
+ public void performCleanup() {
+ synchronized(nodesToRemove) {
+ while(nodesToRemove.size() > 0) {
+ INode node = nodesToRemove.removeFirst();
+ ParentNode<?> parent = node.getParent();\r
+ // This works around issue #2071\r
+ if (parent != null)
+ parent.removeNode(node);
+ }\r
+ if (!nodesToRemoveSet.isEmpty())\r
+ nodesToRemoveSet.clear();\r
+ }
+ }
+\r
+ @Override\r
+ public void cleanup() {\r
+ super.cleanup();\r
+ nodesToRemove.clear();\r
+ nodesToRemove = null;\r
+ nodesToRemoveSet.clear();\r
+ nodesToRemoveSet = null;\r
+ eventHandler.dispose();\r
+ eventHandler = null;\r
+ eventDelegator.dispose();\r
+ eventDelegator = null;\r
+ }\r
+
+ public Container getRootPane() {
+ return (Container) this.rootPane;
+ }\r
+\r
+ @Override
+ public String toString() {
+ return super.toString() + " [root pane=" + rootPane + "]";
+ }
+
+ @Override\r
+ public ParentNode<?> getRootNode() {\r
+ // This is a root node!\r
+ return this;\r
+ }\r
+\r
+ // ILookupService implementation\r
+\r
+ private final Object lookupLock = new Object();\r
+ private final Map<String, INode> toNode = new HashMap<String, INode>();\r
+ private final Map<INode, String> toId = new HashMap<INode, String>();\r
+\r
+ transient Logger logger = Logger.getLogger(getClass().getName());\r
+\r
+ @Override\r
+ public INode map(String id, INode node) {\r
+ if (id == null)\r
+ throw new NullPointerException("null id");\r
+ if (node == null)\r
+ throw new NullPointerException("null node");\r
+\r
+ INode oldNode;\r
+ String oldId;\r
+ synchronized (lookupLock) {\r
+ oldNode = toNode.put(id, node);\r
+ oldId = toId.put(node, id);\r
+\r
+ // Keep the mapping a consistent bijection:\r
+ // If ID => INode mapping is removed, the INode => ID mappings must\r
+ // removed also.\r
+\r
+ if (oldNode != null && !oldNode.equals(node)) {\r
+ String removedId = toId.remove(oldNode);\r
+ if (!id.equals(removedId))\r
+ toNode.remove(removedId);\r
+ }\r
+ if (oldId != null && !oldId.equals(id)) {\r
+ INode removedNode = toNode.remove(oldId);\r
+ if (removedNode != node)\r
+ toId.remove(removedNode);\r
+ }\r
+ }\r
+ if (logger.isLoggable(Level.FINER))\r
+ logger.fine("map(" + id + ", " + node + ")");\r
+ if (oldNode != null || oldId != null) {\r
+ if (logger.isLoggable(Level.FINE)) {\r
+ logger.info("replaced mappings for ID " + oldId + " and node " + oldNode);\r
+ }\r
+ }\r
+ return oldNode;\r
+ }\r
+\r
+ @Override\r
+ public INode unmap(String id) {\r
+ INode node;\r
+ String mappedId;\r
+ synchronized (lookupLock) {\r
+ node = toNode.remove(id);\r
+ if (node == null)\r
+ return null;\r
+ mappedId = toId.remove(node);\r
+ }\r
+ if (logger.isLoggable(Level.FINER))\r
+ logger.fine("unmap(" + id + "): " + node);\r
+ if (mappedId != null && !mappedId.equals(id)) {\r
+ if (logger.isLoggable(Level.WARNING))\r
+ logger.log(Level.WARNING, "mapping was out-of-sync: " + id + " => " + node + " & " + mappedId + " => " + node, new Exception("trace"));\r
+ }\r
+ return node;\r
+ }\r
+\r
+ @Override\r
+ public String unmap(INode node) {\r
+ String id;\r
+ INode mappedNode;\r
+ synchronized (lookupLock) {\r
+ id = toId.remove(node);\r
+ if (node == null)\r
+ return null;\r
+ mappedNode = toNode.remove(id);\r
+ }\r
+ if (logger.isLoggable(Level.FINER))\r
+ logger.fine("unmap(" + node + "): " + id);\r
+ if (mappedNode != null && node != mappedNode) {\r
+ if (logger.isLoggable(Level.WARNING))\r
+ logger.log(Level.WARNING, "mapping was out-of-sync: " + node + " => " + id + " & " + id + " => " + mappedNode, new Exception("trace"));\r
+ }\r
+ return id;\r
+ }\r
+\r
+ @Override\r
+ public INode lookupNode(String id) {\r
+ synchronized (lookupLock) {\r
+ return toNode.get(id);\r
+ }\r
+ }\r
+\r
+ @Override\r
+ public String lookupId(INode node) {\r
+ synchronized (lookupLock) {\r
+ return toId.get(node);\r
+ }\r
+ }\r
+\r
+ public boolean isPending() {\r
+ return !pending.isEmpty();\r
+ }\r
+\r
+ synchronized public void increasePending(Object object) {\r
+ Integer ref = pending.get(object);\r
+ if (ref == null) pending.put(object, 1);\r
+ else pending.put(object, ref+1);\r
+ }\r
+\r
+ synchronized public void setPending(Object object) {\r
+ pending.put(object, 1);\r
+ }\r
+\r
+ synchronized public void clearPending(Object object) {\r
+ pending.remove(object);\r
+ }\r
+\r
+ synchronized public void decreasePending(Object object) {\r
+ Integer ref = pending.get(object);\r
+ if (ref == null) {\r
+ return;\r
+ //throw new IllegalStateException("Ref count in unregister was 0 for " + object);\r
+ }\r
+ if (ref > 1) pending.put(object, ref-1);\r
+ else if (ref==1) pending.remove(object);\r
+ else {\r
+ return;\r
+ //throw new IllegalStateException("Ref count in unregister was 0 for " + object);\r
+ }\r
+ }\r
+ \r
+ synchronized public void setGlobalProperty(String key, Object value) {\r
+ globalProperties.put(key, value);\r
+ }\r
+ \r
+ @SuppressWarnings("unchecked")\r
+ synchronized public <T> T getGlobalProperty(String key, T defaultValue) {\r
+ T t = (T)globalProperties.get(key);\r
+ if(t == null) return defaultValue;\r
+ return t;\r
+ }\r
+\r
+}
Code Review / simantics / platform.git / blobdiff