bundles/org.simantics.scenegraph/src/org/simantics/scenegraph/g2d/nodes/LinkNode.java

   1 /*******************************************************************************\r
   2  * Copyright (c) 2007, 2010 Association for Decentralized Information Management\r
   3  * in Industry THTH ry.\r
   4  * All rights reserved. This program and the accompanying materials\r
   5  * are made available under the terms of the Eclipse Public License v1.0\r
   6  * which accompanies this distribution, and is available at\r
   7  * http://www.eclipse.org/legal/epl-v10.html\r
   8  *\r
   9  * Contributors:\r
  10  *     VTT Technical Research Centre of Finland - initial API and implementation\r
  11  *******************************************************************************/\r
  12 package org.simantics.scenegraph.g2d.nodes;\r
  13 \r
  14 import java.awt.Graphics2D;\r
  15 import java.awt.geom.AffineTransform;\r
  16 import java.awt.geom.Rectangle2D;\r
  17 \r
  18 import org.simantics.scenegraph.ILookupService;\r
  19 import org.simantics.scenegraph.INode;\r
  20 import org.simantics.scenegraph.g2d.G2DParentNode;\r
  21 import org.simantics.scenegraph.g2d.IG2DNode;\r
  22 import org.simantics.scenegraph.utils.NodeUtil;\r
  23 \r
  24 /**\r
  25  * A node that only contains a String ID to link to another node in the scene\r
  26  * graph through {@link ILookupService}. In {@link #render(Graphics2D)},\r
  27  * <code>LinkNode</code> will try to lookup the node identified by the ID and\r
  28  * delegate the important method invocations to it.\r
  29  * \r
  30  * <p>\r
  31  * <b>CAUTION:</b> <em>this node must be used with care</em>! It can be used to\r
  32  * generate cyclic scene graphs which may cause rendering to crash due to\r
  33  * infinite recursion and in any case rendering will not work as intended. E.g.\r
  34  * a scene graph could have a {@link NavigationNode} under its root node and\r
  35  * under which a <code>LinkNode</code> could link back to the navigation node,\r
  36  * which would cause everything to be rendered twice and with double\r
  37  * transformations. As a safety measure against cyclic cases, this node contains\r
  38  * state that prevents it from being invoked recursively.\r
  39  * \r
  40  * <p>\r
  41  * <b>CAVEAT:</b> Nodes with internal state that is updated during rendering.\r
  42  * Such nodes should not be used with {@link LinkNode}.\r
  43  * \r
  44  * @author Tuukka Lehtonen\r
  45  * \r
  46  * @see ILookupService\r
  47  */\r
  48 public class LinkNode extends StateMaskNode {\r
  49 \r
  50     private static final long   serialVersionUID = -7465071303188585400L;\r
  51 \r
  52     /**\r
  53      * The ID of delegate node.\r
  54      */\r
  55     protected String delegateId;\r
  56 \r
  57     /**\r
  58      * <code>true</code> to only process the children of the delegate node and\r
  59      * not the node itself. <code>false</code> for normal behavior which is the\r
  60      * default.\r
  61      */\r
  62     protected boolean ignoreDelegate = false;\r
  63 \r
  64     /**\r
  65      * <code>true</code> to make this node responsible for removing the lookup\r
  66      * id mapping after this node is disposed of. The default value is\r
  67      * <code>false</code>.\r
  68      */\r
  69     protected boolean lookupIdOwner = false;\r
  70 \r
  71     @SyncField("delegateId")\r
  72     public void setDelegateId(String delegateId) {\r
  73         this.delegateId = delegateId;\r
  74     }\r
  75 \r
  76     @SyncField({"delegateId", "lookupIdOwner"})\r
  77     public void setDelegateId(String delegateId, boolean owner) {\r
  78         this.delegateId = delegateId;\r
  79         this.lookupIdOwner = owner;\r
  80     }\r
  81 \r
  82     @SyncField("ignoreDelegate")\r
  83     public void setIgnoreDelegate(boolean ignore) {\r
  84         this.ignoreDelegate = ignore;\r
  85     }\r
  86 \r
  87     @SyncField("lookupIdOwner")\r
  88     public void setLookupIdOwner(boolean idOwner) {\r
  89         this.lookupIdOwner = idOwner;\r
  90     }\r
  91 \r
  92     @Override\r
  93     public void cleanup() {\r
  94         if (lookupIdOwner)\r
  95             removeDelegateMapping();\r
  96         super.cleanup();\r
  97     }\r
  98 \r
  99     @Override\r
 100     public void render(Graphics2D g2d) {\r
 101         // Safety against cyclic cases.\r
 102         if (hasFlags(IN_RENDER))\r
 103             return;\r
 104 \r
 105         IG2DNode n = getDelegate2D();\r
 106         if (n == null)\r
 107             return;\r
 108         if (ignoreDelegate && !(n instanceof G2DParentNode))\r
 109             return;\r
 110 \r
 111         setFlags(IN_RENDER);\r
 112         AffineTransform oldTransform = null;\r
 113         if (transform != null && !transform.isIdentity()) {\r
 114             g2d.transform(transform);\r
 115             oldTransform = g2d.getTransform();\r
 116         }\r
 117         try {\r
 118             if (!ignoreDelegate) {\r
 119                 n.render(g2d);\r
 120             } else {\r
 121                 G2DParentNode parent = (G2DParentNode) n;\r
 122                 for (IG2DNode child : parent.getSortedNodes())\r
 123                     child.render(g2d);\r
 124             }\r
 125         } finally {\r
 126             if (oldTransform != null)\r
 127                 g2d.setTransform(oldTransform);\r
 128             clearFlags(IN_RENDER);\r
 129         }\r
 130     }\r
 131 \r
 132     @Override\r
 133     public Rectangle2D getBoundsInLocal() {\r
 134         // Safety against cyclic cases.\r
 135         if (hasFlags(IN_GET_BOUNDS))\r
 136             return new Rectangle2D.Double();\r
 137 \r
 138         IG2DNode n = getDelegate2D();\r
 139         if (n == null)\r
 140             return new Rectangle2D.Double();\r
 141 \r
 142         setFlags(IN_GET_BOUNDS);\r
 143         try {\r
 144             Rectangle2D bounds = n.getBoundsInLocal();\r
 145             if (transform != null && !transform.isIdentity())\r
 146                 bounds = transform.createTransformedShape(bounds).getBounds2D();\r
 147             return bounds;\r
 148         } finally {\r
 149             clearFlags(IN_GET_BOUNDS);\r
 150         }\r
 151     }\r
 152 \r
 153     protected IG2DNode getDelegate2D() {\r
 154         INode node = NodeUtil.lookup(this, delegateId);\r
 155         if (node instanceof IG2DNode) {\r
 156             return (IG2DNode) node;\r
 157         }\r
 158         return null;\r
 159     }\r
 160 \r
 161     public INode getDelegate() {\r
 162         INode node = NodeUtil.lookup(this, delegateId);\r
 163         if (node instanceof IG2DNode) {\r
 164             return (IG2DNode) node;\r
 165         }\r
 166         return null;\r
 167     }\r
 168 \r
 169     protected void removeDelegateMapping() {\r
 170         ILookupService lookup = NodeUtil.getLookupService(this);\r
 171         lookup.unmap(delegateId);\r
 172     }\r
 173 \r
 174     @Override\r
 175     public String toString() {\r
 176         return super.toString() + "[delegateId=" + delegateId + "]";\r
 177     }\r
 178 \r
 179 }