bundles/org.simantics.scenegraph/src/org/simantics/scenegraph/g2d/nodes/LocalDelegateNode.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.g2d.IG2DNode;\r
  20 \r
  21 /**\r
  22  * A node that delegates {@link #render(Graphics2D)} and\r
  23  * {@link #getBoundsInLocal()} methods to a delegate {@link IG2DNode} it\r
  24  * contains.\r
  25  * \r
  26  * <p>\r
  27  * <b>CAUTION:</b> <em>this node must be used with extreme care</em>! It can be\r
  28  * used to generate cyclic scene graphs which may cause rendering to crash due\r
  29  * to infinite recursion and in any case rendering will not work as intended.\r
  30  * E.g. a scene graph could have a {@link NavigationNode} under its root node\r
  31  * and under which a <code>LinkNode</code> could link back to the navigation\r
  32  * node, which would cause everything to be rendered twice and with double\r
  33  * transformations. As a safety measure against cyclic cases, this node contains\r
  34  * state that prevents it from being invoked recursively.\r
  35  * \r
  36  * <p>\r
  37  * <b>CAVEAT 1:</b> Nodes with internal state that is updated during rendering.\r
  38  * Such nodes should not be used with this.\r
  39  * \r
  40  * <p>\r
  41  * <b>CAVEAT 2:</b> Only intended for local rendering. Will not work with remote\r
  42  * rendering. For remote support, use {@link ILookupService} and\r
  43  * {@link LinkNode} instead.\r
  44  * \r
  45  * @author Tuukka Lehtonen\r
  46  * \r
  47  * @see LinkNode\r
  48  * @see ILookupService\r
  49  */\r
  50 public class LocalDelegateNode extends StateMaskNode {\r
  51 \r
  52     private static final long   serialVersionUID = -7465071303188585400L;\r
  53 \r
  54     /**\r
  55      * The delegate node.\r
  56      */\r
  57     IG2DNode delegate;\r
  58 \r
  59     /**\r
  60      * @param delegate\r
  61      */\r
  62     public void setDelegate(IG2DNode delegate) {\r
  63         this.delegate = delegate;\r
  64     }\r
  65 \r
  66     public IG2DNode getDelegate() {\r
  67         return delegate;\r
  68     }\r
  69 \r
  70     @Override\r
  71     public void render(Graphics2D g2d) {\r
  72         // Safety against cyclic cases.\r
  73         if (hasFlags(IN_RENDER))\r
  74             return;\r
  75 \r
  76         if (delegate == null)\r
  77             return;\r
  78 \r
  79         setFlags(IN_RENDER);\r
  80         AffineTransform oldTransform = null;\r
  81         if (transform != null && !transform.isIdentity()) {\r
  82             g2d.transform(transform);\r
  83             oldTransform = g2d.getTransform();\r
  84         }\r
  85         try {\r
  86             delegate.render(g2d);\r
  87         } finally {\r
  88             if (oldTransform != null)\r
  89                 g2d.setTransform(oldTransform);\r
  90             clearFlags(IN_RENDER);\r
  91         }\r
  92     }\r
  93 \r
  94     @Override\r
  95     public Rectangle2D getBoundsInLocal() {\r
  96         // Safety against cyclic cases.\r
  97         if (hasFlags(IN_GET_BOUNDS))\r
  98             return new Rectangle2D.Double();\r
  99 \r
 100         if (delegate == null)\r
 101             return new Rectangle2D.Double();\r
 102 \r
 103         setFlags(IN_GET_BOUNDS);\r
 104         try {\r
 105             Rectangle2D bounds = delegate.getBoundsInLocal();\r
 106             if (transform != null && !transform.isIdentity())\r
 107                 bounds = transform.createTransformedShape(bounds).getBounds2D();\r
 108             return bounds;\r
 109        } finally {\r
 110             clearFlags(IN_GET_BOUNDS);\r
 111         }\r
 112     }\r
 113 \r
 114 }