]> gerrit.simantics Code Review - simantics/platform.git/blobdiff - bundles/org.simantics.scenegraph/src/org/simantics/scenegraph/g2d/nodes/LinkNode.java
Fixed all line endings of the repository
[simantics/platform.git] / bundles / org.simantics.scenegraph / src / org / simantics / scenegraph / g2d / nodes / LinkNode.java
index 3527fec03fad5cf8f2f048655f605fe56e97fc9e..50d50ecd2f3fe48e2d8b9f894149c7585880bd13 100644 (file)
-/*******************************************************************************\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.INode;\r
-import org.simantics.scenegraph.g2d.G2DParentNode;\r
-import org.simantics.scenegraph.g2d.IG2DNode;\r
-import org.simantics.scenegraph.utils.NodeUtil;\r
-\r
-/**\r
- * A node that only contains a String ID to link to another node in the scene\r
- * graph through {@link ILookupService}. In {@link #render(Graphics2D)},\r
- * <code>LinkNode</code> will try to lookup the node identified by the ID and\r
- * delegate the important method invocations to it.\r
- * \r
- * <p>\r
- * <b>CAUTION:</b> <em>this node must be used with care</em>! It can be used to\r
- * generate cyclic scene graphs which may cause rendering to crash due to\r
- * infinite recursion and in any case rendering will not work as intended. E.g.\r
- * a scene graph could have a {@link NavigationNode} under its root node and\r
- * under which a <code>LinkNode</code> could link back to the navigation node,\r
- * 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:</b> Nodes with internal state that is updated during rendering.\r
- * Such nodes should not be used with {@link LinkNode}.\r
- * \r
- * @author Tuukka Lehtonen\r
- * \r
- * @see ILookupService\r
- */\r
-public class LinkNode extends StateMaskNode {\r
-\r
-    private static final long   serialVersionUID = -7465071303188585400L;\r
-\r
-    /**\r
-     * The ID of delegate node.\r
-     */\r
-    protected String delegateId;\r
-\r
-    /**\r
-     * <code>true</code> to only process the children of the delegate node and\r
-     * not the node itself. <code>false</code> for normal behavior which is the\r
-     * default.\r
-     */\r
-    protected boolean ignoreDelegate = false;\r
-\r
-    /**\r
-     * <code>true</code> to make this node responsible for removing the lookup\r
-     * id mapping after this node is disposed of. The default value is\r
-     * <code>false</code>.\r
-     */\r
-    protected boolean lookupIdOwner = false;\r
-\r
-    @SyncField("delegateId")\r
-    public void setDelegateId(String delegateId) {\r
-        this.delegateId = delegateId;\r
-    }\r
-\r
-    @SyncField({"delegateId", "lookupIdOwner"})\r
-    public void setDelegateId(String delegateId, boolean owner) {\r
-        this.delegateId = delegateId;\r
-        this.lookupIdOwner = owner;\r
-    }\r
-\r
-    @SyncField("ignoreDelegate")\r
-    public void setIgnoreDelegate(boolean ignore) {\r
-        this.ignoreDelegate = ignore;\r
-    }\r
-\r
-    @SyncField("lookupIdOwner")\r
-    public void setLookupIdOwner(boolean idOwner) {\r
-        this.lookupIdOwner = idOwner;\r
-    }\r
-\r
-    @Override\r
-    public void cleanup() {\r
-        if (lookupIdOwner)\r
-            removeDelegateMapping();\r
-        super.cleanup();\r
-    }\r
-\r
-    @Override\r
-    public void render(Graphics2D g2d) {\r
-        // Safety against cyclic cases.\r
-        if (hasFlags(IN_RENDER))\r
-            return;\r
-\r
-        IG2DNode n = getDelegate2D();\r
-        if (n == null)\r
-            return;\r
-        if (ignoreDelegate && !(n instanceof G2DParentNode))\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
-            if (!ignoreDelegate) {\r
-                n.render(g2d);\r
-            } else {\r
-                G2DParentNode parent = (G2DParentNode) n;\r
-                for (IG2DNode child : parent.getSortedNodes())\r
-                    child.render(g2d);\r
-            }\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
-        IG2DNode n = getDelegate2D();\r
-        if (n == null)\r
-            return new Rectangle2D.Double();\r
-\r
-        setFlags(IN_GET_BOUNDS);\r
-        try {\r
-            Rectangle2D bounds = n.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
-    protected IG2DNode getDelegate2D() {\r
-        INode node = NodeUtil.lookup(this, delegateId);\r
-        if (node instanceof IG2DNode) {\r
-            return (IG2DNode) node;\r
-        }\r
-        return null;\r
-    }\r
-\r
-    public INode getDelegate() {\r
-        INode node = NodeUtil.lookup(this, delegateId);\r
-        if (node instanceof IG2DNode) {\r
-            return (IG2DNode) node;\r
-        }\r
-        return null;\r
-    }\r
-\r
-    protected void removeDelegateMapping() {\r
-        ILookupService lookup = NodeUtil.getLookupService(this);\r
-        lookup.unmap(delegateId);\r
-    }\r
-\r
-    @Override\r
-    public String toString() {\r
-        return super.toString() + "[delegateId=" + delegateId + "]";\r
-    }\r
-\r
+/*******************************************************************************
+ * Copyright (c) 2007, 2010 Association for Decentralized Information Management
+ * in Industry THTH ry.
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v1.0
+ * which accompanies this distribution, and is available at
+ * http://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ *     VTT Technical Research Centre of Finland - initial API and implementation
+ *******************************************************************************/
+package org.simantics.scenegraph.g2d.nodes;
+
+import java.awt.Graphics2D;
+import java.awt.geom.AffineTransform;
+import java.awt.geom.Rectangle2D;
+
+import org.simantics.scenegraph.ILookupService;
+import org.simantics.scenegraph.INode;
+import org.simantics.scenegraph.g2d.G2DParentNode;
+import org.simantics.scenegraph.g2d.IG2DNode;
+import org.simantics.scenegraph.utils.NodeUtil;
+
+/**
+ * A node that only contains a String ID to link to another node in the scene
+ * graph through {@link ILookupService}. In {@link #render(Graphics2D)},
+ * <code>LinkNode</code> will try to lookup the node identified by the ID and
+ * delegate the important method invocations to it.
+ * 
+ * <p>
+ * <b>CAUTION:</b> <em>this node must be used with care</em>! It can be used to
+ * generate cyclic scene graphs which may cause rendering to crash due to
+ * infinite recursion and in any case rendering will not work as intended. E.g.
+ * a scene graph could have a {@link NavigationNode} under its root node and
+ * under which a <code>LinkNode</code> could link back to the navigation node,
+ * which would cause everything to be rendered twice and with double
+ * transformations. As a safety measure against cyclic cases, this node contains
+ * state that prevents it from being invoked recursively.
+ * 
+ * <p>
+ * <b>CAVEAT:</b> Nodes with internal state that is updated during rendering.
+ * Such nodes should not be used with {@link LinkNode}.
+ * 
+ * @author Tuukka Lehtonen
+ * 
+ * @see ILookupService
+ */
+public class LinkNode extends StateMaskNode {
+
+    private static final long   serialVersionUID = -7465071303188585400L;
+
+    /**
+     * The ID of delegate node.
+     */
+    protected String delegateId;
+
+    /**
+     * <code>true</code> to only process the children of the delegate node and
+     * not the node itself. <code>false</code> for normal behavior which is the
+     * default.
+     */
+    protected boolean ignoreDelegate = false;
+
+    /**
+     * <code>true</code> to make this node responsible for removing the lookup
+     * id mapping after this node is disposed of. The default value is
+     * <code>false</code>.
+     */
+    protected boolean lookupIdOwner = false;
+
+    @SyncField("delegateId")
+    public void setDelegateId(String delegateId) {
+        this.delegateId = delegateId;
+    }
+
+    @SyncField({"delegateId", "lookupIdOwner"})
+    public void setDelegateId(String delegateId, boolean owner) {
+        this.delegateId = delegateId;
+        this.lookupIdOwner = owner;
+    }
+
+    @SyncField("ignoreDelegate")
+    public void setIgnoreDelegate(boolean ignore) {
+        this.ignoreDelegate = ignore;
+    }
+
+    @SyncField("lookupIdOwner")
+    public void setLookupIdOwner(boolean idOwner) {
+        this.lookupIdOwner = idOwner;
+    }
+
+    @Override
+    public void cleanup() {
+        if (lookupIdOwner)
+            removeDelegateMapping();
+        super.cleanup();
+    }
+
+    @Override
+    public void render(Graphics2D g2d) {
+        // Safety against cyclic cases.
+        if (hasFlags(IN_RENDER))
+            return;
+
+        IG2DNode n = getDelegate2D();
+        if (n == null)
+            return;
+        if (ignoreDelegate && !(n instanceof G2DParentNode))
+            return;
+
+        setFlags(IN_RENDER);
+        AffineTransform oldTransform = null;
+        if (transform != null && !transform.isIdentity()) {
+            g2d.transform(transform);
+            oldTransform = g2d.getTransform();
+        }
+        try {
+            if (!ignoreDelegate) {
+                n.render(g2d);
+            } else {
+                G2DParentNode parent = (G2DParentNode) n;
+                for (IG2DNode child : parent.getSortedNodes())
+                    child.render(g2d);
+            }
+        } finally {
+            if (oldTransform != null)
+                g2d.setTransform(oldTransform);
+            clearFlags(IN_RENDER);
+        }
+    }
+
+    @Override
+    public Rectangle2D getBoundsInLocal() {
+        // Safety against cyclic cases.
+        if (hasFlags(IN_GET_BOUNDS))
+            return new Rectangle2D.Double();
+
+        IG2DNode n = getDelegate2D();
+        if (n == null)
+            return new Rectangle2D.Double();
+
+        setFlags(IN_GET_BOUNDS);
+        try {
+            Rectangle2D bounds = n.getBoundsInLocal();
+            if (transform != null && !transform.isIdentity())
+                bounds = transform.createTransformedShape(bounds).getBounds2D();
+            return bounds;
+        } finally {
+            clearFlags(IN_GET_BOUNDS);
+        }
+    }
+
+    protected IG2DNode getDelegate2D() {
+        INode node = NodeUtil.lookup(this, delegateId);
+        if (node instanceof IG2DNode) {
+            return (IG2DNode) node;
+        }
+        return null;
+    }
+
+    public INode getDelegate() {
+        INode node = NodeUtil.lookup(this, delegateId);
+        if (node instanceof IG2DNode) {
+            return (IG2DNode) node;
+        }
+        return null;
+    }
+
+    protected void removeDelegateMapping() {
+        ILookupService lookup = NodeUtil.getLookupService(this);
+        lookup.unmap(delegateId);
+    }
+
+    @Override
+    public String toString() {
+        return super.toString() + "[delegateId=" + delegateId + "]";
+    }
+
 }
\ No newline at end of file