1 /*******************************************************************************
2 * Copyright (c) 2007, 2011 Association for Decentralized Information Management
4 * All rights reserved. This program and the accompanying materials
5 * are made available under the terms of the Eclipse Public License v1.0
6 * which accompanies this distribution, and is available at
7 * http://www.eclipse.org/legal/epl-v10.html
10 * VTT Technical Research Centre of Finland - initial API and implementation
11 *******************************************************************************/
12 package org.simantics.scenegraph.g2d;
14 import java.awt.Container;
15 import java.awt.Cursor;
16 import java.awt.Graphics2D;
17 import java.awt.Shape;
18 import java.awt.geom.AffineTransform;
19 import java.awt.geom.NoninvertibleTransformException;
20 import java.awt.geom.Point2D;
21 import java.awt.geom.Rectangle2D;
22 import java.util.Arrays;
23 import java.util.Comparator;
24 import java.util.Iterator;
26 import org.simantics.scenegraph.INode;
27 import org.simantics.scenegraph.LoaderNode;
28 import org.simantics.scenegraph.ParentNode;
29 import org.simantics.scenegraph.ScenegraphUtils;
30 import org.simantics.scenegraph.g2d.events.Event;
31 import org.simantics.scenegraph.g2d.events.EventTypes;
32 import org.simantics.scenegraph.g2d.events.FocusEvent;
33 import org.simantics.scenegraph.g2d.events.IEventHandler;
34 import org.simantics.scenegraph.g2d.events.KeyEvent;
35 import org.simantics.scenegraph.g2d.events.KeyEvent.KeyPressedEvent;
36 import org.simantics.scenegraph.g2d.events.KeyEvent.KeyReleasedEvent;
37 import org.simantics.scenegraph.g2d.events.MouseEvent.MouseButtonPressedEvent;
38 import org.simantics.scenegraph.g2d.events.MouseEvent.MouseButtonReleasedEvent;
39 import org.simantics.scenegraph.g2d.events.MouseEvent.MouseClickEvent;
40 import org.simantics.scenegraph.g2d.events.MouseEvent.MouseDoubleClickedEvent;
41 import org.simantics.scenegraph.g2d.events.MouseEvent.MouseDragBegin;
42 import org.simantics.scenegraph.g2d.events.MouseEvent.MouseEnterEvent;
43 import org.simantics.scenegraph.g2d.events.MouseEvent.MouseExitEvent;
44 import org.simantics.scenegraph.g2d.events.MouseEvent.MouseMovedEvent;
45 import org.simantics.scenegraph.g2d.events.MouseEvent.MouseWheelMovedEvent;
46 import org.simantics.scenegraph.g2d.events.NodeEventHandler;
47 import org.simantics.scenegraph.g2d.events.TimeEvent;
48 import org.simantics.scenegraph.g2d.events.command.CommandEvent;
49 import org.simantics.scenegraph.utils.GeometryUtils;
50 import org.simantics.scenegraph.utils.InitValueSupport;
51 import org.simantics.scenegraph.utils.NodeUtil;
52 import org.simantics.scl.runtime.function.Function1;
53 import org.simantics.scl.runtime.function.Function2;
54 import org.simantics.utils.threads.AWTThread;
57 * @author Tuukka Lehtonen
59 public class G2DParentNode extends ParentNode<IG2DNode> implements IG2DNode, InitValueSupport, LoaderNode {
61 private static final long serialVersionUID = 4966823616578337420L;
63 protected static final IG2DNode[] EMPTY_NODE_ARRAY = {};
64 protected static final String[] EMPTY_STRING_ARRAY = {};
66 private transient volatile String[] sortedChildrenIds = null;
67 private transient volatile IG2DNode[] sortedChildren = null;
69 protected AffineTransform transform = IdentityAffineTransform.INSTANCE;
72 * Z-index of this node. Default value is 0.
76 public void invalidateChildOrder() {
77 sortedChildrenIds = null;
78 sortedChildren = null;
82 protected void childrenChanged() {
83 invalidateChildOrder();
88 public void setZIndex(int z) {
90 G2DParentNode parent = (G2DParentNode) getParent();
92 parent.invalidateChildOrder();
98 public int getZIndex() {
103 public boolean validate() {
108 public void render(Graphics2D g2d) {
109 AffineTransform ot = null;
110 if (!transform.isIdentity()) {
111 ot = g2d.getTransform();
112 g2d.transform(transform);
115 for (IG2DNode node : getSortedNodes()) {
116 if (node.validate()) {
122 g2d.setTransform(ot);
126 * Return the IDs of the children of this node in ascending Z order. This
127 * method will always allocate a new result list and sort it. To get the IDs
128 * of the child nodes you need to use this method. Otherwise use
129 * {@link #getSortedNodes()} instead, it is faster more memory efficient.
131 * @return child node IDs in ascending Z order
133 public String[] getSortedNodesById() {
134 if (sortedChildrenIds != null)
135 return sortedChildrenIds;
136 if (children.isEmpty())
137 return EMPTY_STRING_ARRAY;
139 String[] sorted = null;
140 synchronized (children) {
141 if (sortedChildrenIds != null)
142 return sortedChildrenIds;
143 sorted = children.keySet().toArray(EMPTY_STRING_ARRAY);
144 Arrays.sort(sorted, new Comparator<String>() {
146 public int compare(String a, String b) {
147 int za = getNode(a).getZIndex();
148 int zb = getNode(b).getZIndex();
149 return za < zb ? -1 : (za == zb ? 0 : 1);
152 sortedChildrenIds = sorted;
157 public static final Comparator<IG2DNode> G2DNODE_Z_COMPARATOR = new Comparator<IG2DNode>() {
159 public int compare(IG2DNode a, IG2DNode b) {
160 int za = a.getZIndex();
161 int zb = b.getZIndex();
162 return za < zb ? -1 : (za == zb ? 0 : 1);
167 * @return child nodes in ascending Z order
169 public IG2DNode[] getSortedNodes() {
170 if (sortedChildren != null)
171 return sortedChildren;
172 if (children.isEmpty())
173 return EMPTY_NODE_ARRAY;
175 IG2DNode[] sorted = null;
176 synchronized (children) {
177 if (sortedChildren != null)
178 return sortedChildren;
179 sorted = children.values().toArray(EMPTY_NODE_ARRAY);
180 Arrays.sort(sorted, G2DNODE_Z_COMPARATOR);
181 sortedChildren = sorted;
187 public void cleanup() {
188 rootNodeCache = DISPOSED;
189 sortedChildren = null;
190 sortedChildrenIds = null;
191 transform = IdentityAffineTransform.INSTANCE;
196 public void repaint() {
197 INode parent = getParent();
198 while(parent != null && !(parent instanceof G2DSceneGraph))
199 parent = parent.getParent();
200 if(parent == null || ((G2DSceneGraph)parent).getRootPane() == null) return;
201 ((G2DSceneGraph)parent).getRootPane().repaint();
205 public void asyncRemoveNode(INode node) {
206 ParentNode<?> parent = getParent();
207 while(parent != null && parent.getParent() != null)
208 parent = parent.getParent();
211 parent.asyncRemoveNode(node); // Pass to root element
213 // This is root, should do something... (Actually G2DSceneGraph does something)
217 // Bounds and transformation
220 public AffineTransform getTransform() {
225 @PropertySetter("Transform")
226 @SyncField("transform")
227 public void setTransform(AffineTransform transform) {
228 assert(transform != null);
229 if (transform.isIdentity())
230 this.transform = IdentityAffineTransform.INSTANCE;
232 this.transform = transform;
236 * Return bounds transformed with local transformation
238 * @return transformed bounds
241 public Rectangle2D getBounds() {
242 Rectangle2D local = getBoundsInLocal();
245 // Optimize trivial identity transform case.
246 if (transform.isIdentity())
248 return transform.createTransformedShape(local).getBounds2D();
251 // Helper methods for bounds checking
254 public boolean contains(Point2D point) {
255 Rectangle2D bounds = getBounds();
256 if(bounds == null) return false;
257 return bounds.contains(point);
261 public boolean intersects(Rectangle2D b) {
264 Rectangle2D a = getBounds();
268 * Compared to Rectangle2D.intersects, this
269 * intersects closed (not open) shapes.
271 double ax = a.getX();
272 double ay = a.getY();
273 double aw = a.getWidth();
274 double ah = a.getHeight();
275 double bx = b.getX();
276 double by = b.getY();
277 double bw = b.getWidth();
278 double bh = b.getHeight();
279 return (ax + aw >= bx &&
286 public Point2D localToParent(Point2D point) {
287 return transform.transform(point, null);
291 public Rectangle2D localToParent(Rectangle2D rect) {
292 return transform.createTransformedShape(rect).getBounds2D();
296 public Point2D parentToLocal(Point2D point) {
297 AffineTransform inverse = null;
299 inverse = transform.createInverse();
300 return inverse.transform(point, null);
301 } catch (NoninvertibleTransformException e) {
302 e.printStackTrace(); // FIXME
308 public Rectangle2D parentToLocal(Rectangle2D rect) {
309 AffineTransform inverse = null;
311 inverse = transform.createInverse();
312 return inverse.createTransformedShape(rect).getBounds2D();
313 } catch (NoninvertibleTransformException e) {
314 e.printStackTrace(); // FIXME
320 public Rectangle2D getBoundsInLocal() {
321 return getBoundsInLocal(false);
325 public Rectangle2D getBoundsInLocal(boolean ignoreNulls) {
326 Iterator<IG2DNode> it = getNodes().iterator();
329 Rectangle2D bounds = null;
330 while(it.hasNext()) {
331 IG2DNode node = it.next();
332 Rectangle2D b = node.getBounds();
333 if(b == null && !ignoreNulls)
337 bounds = b.getFrame();
347 public Point2D localToControl(Point2D point) {
348 IG2DNode node = this;
349 while(node != null) {
350 node.getTransform().transform(point, null);
351 node = (G2DParentNode)node.getParent(); // FIXME: it should be G2DParentNode but you can never be sure
357 public Rectangle2D localToControl(Rectangle2D rect) {
359 IG2DNode node = this;
360 while(node != null) {
361 shape = node.getTransform().createTransformedShape(shape);
362 node = (G2DParentNode)node.getParent(); // FIXME: it should be G2DParentNode but you can never be sure
365 return shape.getBounds2D();
368 public Point2D controlToLocal(Point2D point) {
369 AffineTransform at = NodeUtil.getGlobalToLocalTransform(this, null);
372 return at.transform(point, null);
375 public Rectangle2D controlToLocal(Rectangle2D rect) {
376 AffineTransform at = NodeUtil.getGlobalToLocalTransform(this, null);
379 return GeometryUtils.transformRectangle(at, rect);
383 * Damn slow method for picking node
388 public IG2DNode pickNode(Point2D point) {
389 Point2D localpoint = parentToLocal(point);
390 IG2DNode[] nodes = getSortedNodes();
392 for(int i = nodes.length-1; i >= 0; i--) {
393 IG2DNode n = nodes[i]; // Reverse order..
394 if(n instanceof G2DParentNode) {
395 IG2DNode node = ((G2DParentNode)n).pickNode(localpoint);
398 } else if(n.contains(localpoint)) {
406 public String toString() {
407 return super.toString() + " [z=" + z + ", transform=" + transform + "]";
411 * TODO: not sure if this is a good idea at all.
413 * @see org.simantics.scenegraph.utils.InitValueSupport#initValues()
416 public void initValues() {
417 for (IG2DNode node : getSortedNodes()) {
418 if (node instanceof InitValueSupport) {
419 ((InitValueSupport) node).initValues();
425 * @see org.simantics.scenegraph.g2d.IG2DNode#getRootNode()
427 public G2DSceneGraph getRootNode2D() {
428 ParentNode<?> root = getRootNode();
429 return (G2DSceneGraph) root;
433 public boolean hasFocus() {
434 return getFocusNode() == this;
438 public IG2DNode getFocusNode() {
439 return getRootNode2D().getFocusNode();
443 public void setFocusNode(IG2DNode node) {
444 getRootNode2D().setFocusNode(node);
447 protected NodeEventHandler getEventHandler() {
448 return NodeUtil.getNodeEventHandler(this);
451 protected void addEventHandler(IEventHandler handler) {
452 getEventHandler().add(handler);
455 protected void removeEventHandler(IEventHandler handler) {
456 getEventHandler().remove(handler);
460 public int getEventMask() {
465 public boolean handleEvent(Event e) {
466 int eventType = EventTypes.toType(e);
468 case EventTypes.Command:
469 return handleCommand((CommandEvent) e);
471 case EventTypes.FocusGained:
472 case EventTypes.FocusLost:
473 return handleFocusEvent((FocusEvent) e);
475 case EventTypes.KeyPressed:
476 return keyPressed((KeyPressedEvent) e);
477 case EventTypes.KeyReleased:
478 return keyReleased((KeyReleasedEvent) e);
480 case EventTypes.MouseButtonPressed:
481 return mouseButtonPressed((MouseButtonPressedEvent) e);
482 case EventTypes.MouseButtonReleased:
483 return mouseButtonReleased((MouseButtonReleasedEvent) e);
484 case EventTypes.MouseClick:
485 return mouseClicked((MouseClickEvent) e);
486 case EventTypes.MouseDoubleClick:
487 return mouseDoubleClicked((MouseDoubleClickedEvent) e);
488 case EventTypes.MouseMoved:
489 return mouseMoved((MouseMovedEvent) e);
490 case EventTypes.MouseDragBegin:
491 return mouseDragged((MouseDragBegin) e);
492 case EventTypes.MouseEnter:
493 return mouseEntered((MouseEnterEvent) e);
494 case EventTypes.MouseExit:
495 return mouseExited((MouseExitEvent) e);
496 case EventTypes.MouseWheel:
497 return mouseWheelMoved((MouseWheelMovedEvent) e);
499 case EventTypes.Time:
500 return handleTimeEvent((TimeEvent) e);
505 protected boolean keyReleased(KeyReleasedEvent e) {
509 protected boolean keyPressed(KeyPressedEvent e) {
513 protected boolean handleCommand(CommandEvent e) {
517 protected boolean handleFocusEvent(FocusEvent e) {
521 protected boolean handleKeyEvent(KeyEvent e) {
525 protected boolean mouseButtonPressed(MouseButtonPressedEvent e) {
529 protected boolean mouseButtonReleased(MouseButtonReleasedEvent e) {
533 protected boolean mouseClicked(MouseClickEvent e) {
537 protected boolean mouseDoubleClicked(MouseDoubleClickedEvent e) {
541 protected boolean mouseMoved(MouseMovedEvent e) {
545 protected boolean mouseDragged(MouseDragBegin e) {
549 protected boolean mouseEntered(MouseEnterEvent e) {
553 protected boolean mouseExited(MouseExitEvent e) {
557 protected boolean mouseWheelMoved(MouseWheelMovedEvent e) {
561 protected boolean handleTimeEvent(TimeEvent e) {
565 protected void setCursor(int cursorType) {
566 Container rootPane = NodeUtil.findRootPane(this);
567 if (rootPane != null)
568 rootPane.setCursor(Cursor.getPredefinedCursor(cursorType));
571 protected void setCursor(Cursor cursor) {
572 Container rootPane = NodeUtil.findRootPane(this);
573 if (rootPane != null)
574 rootPane.setCursor(cursor);
578 public Function1<Object, Boolean> getPropertyFunction(String propertyName) {
579 return ScenegraphUtils.getMethodPropertyFunction(AWTThread.getThreadAccess(), this, propertyName);
583 public <T> T getProperty(String propertyName) {
588 public void setPropertyCallback(Function2<String, Object, Boolean> callback) {
591 public void synchronizeTransform(double[] data) {
592 this.setTransform(new AffineTransform(data));