Migrated source code from Simantics SVN

[simantics/platform.git] / bundles / org.simantics.scenegraph / src / org / simantics / scenegraph / g2d / nodes / LocalDelegateNode.java

diff --git a/bundles/org.simantics.scenegraph/src/org/simantics/scenegraph/g2d/nodes/LocalDelegateNode.java b/bundles/org.simantics.scenegraph/src/org/simantics/scenegraph/g2d/nodes/LocalDelegateNode.java
new file mode 100644 (file)
index 0000000..9b98449
--- /dev/null
+++ b/bundles/org.simantics.scenegraph/src/org/simantics/scenegraph/g2d/nodes/LocalDelegateNode.java
@@ -0,0 +1,114 @@
+/*******************************************************************************\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.nodes;\r
+\r
+import java.awt.Graphics2D;\r
+import java.awt.geom.AffineTransform;\r
+import java.awt.geom.Rectangle2D;\r
+\r
+import org.simantics.scenegraph.ILookupService;\r
+import org.simantics.scenegraph.g2d.IG2DNode;\r
+\r
+/**\r
+ * A node that delegates {@link #render(Graphics2D)} and\r
+ * {@link #getBoundsInLocal()} methods to a delegate {@link IG2DNode} it\r
+ * contains.\r
+ * \r
+ * <p>\r
+ * <b>CAUTION:</b> <em>this node must be used with extreme care</em>! It can be\r
+ * used to generate cyclic scene graphs which may cause rendering to crash due\r
+ * to infinite recursion and in any case rendering will not work as intended.\r
+ * E.g. a scene graph could have a {@link NavigationNode} under its root node\r
+ * and under which a <code>LinkNode</code> could link back to the navigation\r
+ * node, which would cause everything to be rendered twice and with double\r
+ * transformations. As a safety measure against cyclic cases, this node contains\r
+ * state that prevents it from being invoked recursively.\r
+ * \r
+ * <p>\r
+ * <b>CAVEAT 1:</b> Nodes with internal state that is updated during rendering.\r
+ * Such nodes should not be used with this.\r
+ * \r
+ * <p>\r
+ * <b>CAVEAT 2:</b> Only intended for local rendering. Will not work with remote\r
+ * rendering. For remote support, use {@link ILookupService} and\r
+ * {@link LinkNode} instead.\r
+ * \r
+ * @author Tuukka Lehtonen\r
+ * \r
+ * @see LinkNode\r
+ * @see ILookupService\r
+ */\r
+public class LocalDelegateNode extends StateMaskNode {\r
+\r
+    private static final long   serialVersionUID = -7465071303188585400L;\r
+\r
+    /**\r
+     * The delegate node.\r
+     */\r
+    IG2DNode delegate;\r
+\r
+    /**\r
+     * @param delegate\r
+     */\r
+    public void setDelegate(IG2DNode delegate) {\r
+        this.delegate = delegate;\r
+    }\r
+\r
+    public IG2DNode getDelegate() {\r
+        return delegate;\r
+    }\r
+\r
+    @Override\r
+    public void render(Graphics2D g2d) {\r
+        // Safety against cyclic cases.\r
+        if (hasFlags(IN_RENDER))\r
+            return;\r
+\r
+        if (delegate == null)\r
+            return;\r
+\r
+        setFlags(IN_RENDER);\r
+        AffineTransform oldTransform = null;\r
+        if (transform != null && !transform.isIdentity()) {\r
+            g2d.transform(transform);\r
+            oldTransform = g2d.getTransform();\r
+        }\r
+        try {\r
+            delegate.render(g2d);\r
+        } finally {\r
+            if (oldTransform != null)\r
+                g2d.setTransform(oldTransform);\r
+            clearFlags(IN_RENDER);\r
+        }\r
+    }\r
+\r
+    @Override\r
+    public Rectangle2D getBoundsInLocal() {\r
+        // Safety against cyclic cases.\r
+        if (hasFlags(IN_GET_BOUNDS))\r
+            return new Rectangle2D.Double();\r
+\r
+        if (delegate == null)\r
+            return new Rectangle2D.Double();\r
+\r
+        setFlags(IN_GET_BOUNDS);\r
+        try {\r
+            Rectangle2D bounds = delegate.getBoundsInLocal();\r
+            if (transform != null && !transform.isIdentity())\r
+                bounds = transform.createTransformedShape(bounds).getBounds2D();\r
+            return bounds;\r
+       } finally {\r
+            clearFlags(IN_GET_BOUNDS);\r
+        }\r
+    }\r
+\r
+}
\ No newline at end of file