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 public void accept(IG2DNodeVisitor visitor) {
128 for (IG2DNode node : getSortedNodes()) {
129 if (node.validate()) {
130 node.accept(visitor);
137 * Return the IDs of the children of this node in ascending Z order. This
138 * method will always allocate a new result list and sort it. To get the IDs
139 * of the child nodes you need to use this method. Otherwise use
140 * {@link #getSortedNodes()} instead, it is faster more memory efficient.
142 * @return child node IDs in ascending Z order
144 public String[] getSortedNodesById() {
145 if (sortedChildrenIds != null)
146 return sortedChildrenIds;
147 if (children.isEmpty())
148 return EMPTY_STRING_ARRAY;
150 String[] sorted = null;
151 synchronized (children) {
152 if (sortedChildrenIds != null)
153 return sortedChildrenIds;
154 sorted = children.keySet().toArray(EMPTY_STRING_ARRAY);
155 Arrays.sort(sorted, new Comparator<String>() {
157 public int compare(String a, String b) {
158 int za = getNode(a).getZIndex();
159 int zb = getNode(b).getZIndex();
160 return za < zb ? -1 : (za == zb ? 0 : 1);
163 sortedChildrenIds = sorted;
168 public static final Comparator<IG2DNode> G2DNODE_Z_COMPARATOR = new Comparator<IG2DNode>() {
170 public int compare(IG2DNode a, IG2DNode b) {
171 int za = a.getZIndex();
172 int zb = b.getZIndex();
173 return za < zb ? -1 : (za == zb ? 0 : 1);
178 * @return child nodes in ascending Z order
180 public IG2DNode[] getSortedNodes() {
181 if (sortedChildren != null)
182 return sortedChildren;
183 if (children.isEmpty())
184 return EMPTY_NODE_ARRAY;
186 IG2DNode[] sorted = null;
187 synchronized (children) {
188 if (sortedChildren != null)
189 return sortedChildren;
190 sorted = children.values().toArray(EMPTY_NODE_ARRAY);
191 Arrays.sort(sorted, G2DNODE_Z_COMPARATOR);
192 sortedChildren = sorted;
198 public void cleanup() {
199 rootNodeCache = DISPOSED;
200 sortedChildren = null;
201 sortedChildrenIds = null;
202 transform = IdentityAffineTransform.INSTANCE;
207 public void repaint() {
208 INode parent = getParent();
209 while(parent != null && !(parent instanceof G2DSceneGraph))
210 parent = parent.getParent();
211 if(parent == null || ((G2DSceneGraph)parent).getRootPane() == null) return;
212 ((G2DSceneGraph)parent).getRootPane().repaint();
216 public void asyncRemoveNode(INode node) {
217 ParentNode<?> parent = getParent();
218 while(parent != null && parent.getParent() != null)
219 parent = parent.getParent();
222 parent.asyncRemoveNode(node); // Pass to root element
224 // This is root, should do something... (Actually G2DSceneGraph does something)
228 // Bounds and transformation
231 public AffineTransform getTransform() {
236 @PropertySetter("Transform")
237 @SyncField("transform")
238 public void setTransform(AffineTransform transform) {
239 assert(transform != null);
240 if (transform.isIdentity())
241 this.transform = IdentityAffineTransform.INSTANCE;
243 this.transform = transform;
247 * Return bounds transformed with local transformation
249 * @return transformed bounds
252 public Rectangle2D getBounds() {
253 Rectangle2D local = getBoundsInLocal();
256 // Optimize trivial identity transform case.
257 if (transform.isIdentity())
259 return transform.createTransformedShape(local).getBounds2D();
262 // Helper methods for bounds checking
265 public boolean contains(Point2D point) {
266 Rectangle2D bounds = getBounds();
267 if(bounds == null) return false;
268 return bounds.contains(point);
272 public boolean intersects(Rectangle2D b) {
275 Rectangle2D a = getBounds();
279 * Compared to Rectangle2D.intersects, this
280 * intersects closed (not open) shapes.
282 double ax = a.getX();
283 double ay = a.getY();
284 double aw = a.getWidth();
285 double ah = a.getHeight();
286 double bx = b.getX();
287 double by = b.getY();
288 double bw = b.getWidth();
289 double bh = b.getHeight();
290 return (ax + aw >= bx &&
297 public Point2D localToParent(Point2D point) {
298 return transform.transform(point, null);
302 public Rectangle2D localToParent(Rectangle2D rect) {
303 return transform.createTransformedShape(rect).getBounds2D();
307 public Point2D parentToLocal(Point2D point) {
308 AffineTransform inverse = null;
310 inverse = transform.createInverse();
311 return inverse.transform(point, null);
312 } catch (NoninvertibleTransformException e) {
313 e.printStackTrace(); // FIXME
319 public Rectangle2D parentToLocal(Rectangle2D rect) {
320 AffineTransform inverse = null;
322 inverse = transform.createInverse();
323 return inverse.createTransformedShape(rect).getBounds2D();
324 } catch (NoninvertibleTransformException e) {
325 e.printStackTrace(); // FIXME
331 public Rectangle2D getBoundsInLocal() {
332 return getBoundsInLocal(false);
336 public Rectangle2D getBoundsInLocal(boolean ignoreNulls) {
337 Iterator<IG2DNode> it = getNodes().iterator();
340 Rectangle2D bounds = null;
341 while(it.hasNext()) {
342 IG2DNode node = it.next();
343 Rectangle2D b = node.getBounds();
344 if(b == null && !ignoreNulls)
348 bounds = b.getFrame();
358 public Point2D localToControl(Point2D point) {
359 IG2DNode node = this;
360 while(node != null) {
361 node.getTransform().transform(point, null);
362 node = (G2DParentNode)node.getParent(); // FIXME: it should be G2DParentNode but you can never be sure
368 public Rectangle2D localToControl(Rectangle2D rect) {
370 IG2DNode node = this;
371 while(node != null) {
372 shape = node.getTransform().createTransformedShape(shape);
373 node = (G2DParentNode)node.getParent(); // FIXME: it should be G2DParentNode but you can never be sure
376 return shape.getBounds2D();
379 public Point2D controlToLocal(Point2D point) {
380 AffineTransform at = NodeUtil.getGlobalToLocalTransform(this, null);
383 return at.transform(point, null);
386 public Rectangle2D controlToLocal(Rectangle2D rect) {
387 AffineTransform at = NodeUtil.getGlobalToLocalTransform(this, null);
390 return GeometryUtils.transformRectangle(at, rect);
394 * Damn slow method for picking node
399 public IG2DNode pickNode(Point2D point) {
400 Point2D localpoint = parentToLocal(point);
401 IG2DNode[] nodes = getSortedNodes();
403 for(int i = nodes.length-1; i >= 0; i--) {
404 IG2DNode n = nodes[i]; // Reverse order..
405 if(n instanceof G2DParentNode) {
406 IG2DNode node = ((G2DParentNode)n).pickNode(localpoint);
409 } else if(n.contains(localpoint)) {
417 public String toString() {
418 return super.toString() + " [z=" + z + ", transform=" + transform + "]";
422 * TODO: not sure if this is a good idea at all.
424 * @see org.simantics.scenegraph.utils.InitValueSupport#initValues()
427 public void initValues() {
428 for (IG2DNode node : getSortedNodes()) {
429 if (node instanceof InitValueSupport) {
430 ((InitValueSupport) node).initValues();
436 * @see org.simantics.scenegraph.g2d.IG2DNode#getRootNode()
438 public G2DSceneGraph getRootNode2D() {
439 ParentNode<?> root = getRootNode();
440 return (G2DSceneGraph) root;
444 public boolean hasFocus() {
445 return getFocusNode() == this;
449 public IG2DNode getFocusNode() {
450 return getRootNode2D().getFocusNode();
454 public void setFocusNode(IG2DNode node) {
455 getRootNode2D().setFocusNode(node);
458 protected NodeEventHandler getEventHandler() {
459 return NodeUtil.getNodeEventHandler(this);
462 protected void addEventHandler(IEventHandler handler) {
463 getEventHandler().add(handler);
466 protected void removeEventHandler(IEventHandler handler) {
467 getEventHandler().remove(handler);
471 public int getEventMask() {
476 public boolean handleEvent(Event e) {
477 int eventType = EventTypes.toType(e);
479 case EventTypes.Command:
480 return handleCommand((CommandEvent) e);
482 case EventTypes.FocusGained:
483 case EventTypes.FocusLost:
484 return handleFocusEvent((FocusEvent) e);
486 case EventTypes.KeyPressed:
487 return keyPressed((KeyPressedEvent) e);
488 case EventTypes.KeyReleased:
489 return keyReleased((KeyReleasedEvent) e);
491 case EventTypes.MouseButtonPressed:
492 return mouseButtonPressed((MouseButtonPressedEvent) e);
493 case EventTypes.MouseButtonReleased:
494 return mouseButtonReleased((MouseButtonReleasedEvent) e);
495 case EventTypes.MouseClick:
496 return mouseClicked((MouseClickEvent) e);
497 case EventTypes.MouseDoubleClick:
498 return mouseDoubleClicked((MouseDoubleClickedEvent) e);
499 case EventTypes.MouseMoved:
500 return mouseMoved((MouseMovedEvent) e);
501 case EventTypes.MouseDragBegin:
502 return mouseDragged((MouseDragBegin) e);
503 case EventTypes.MouseEnter:
504 return mouseEntered((MouseEnterEvent) e);
505 case EventTypes.MouseExit:
506 return mouseExited((MouseExitEvent) e);
507 case EventTypes.MouseWheel:
508 return mouseWheelMoved((MouseWheelMovedEvent) e);
510 case EventTypes.Time:
511 return handleTimeEvent((TimeEvent) e);
516 protected boolean keyReleased(KeyReleasedEvent e) {
520 protected boolean keyPressed(KeyPressedEvent e) {
524 protected boolean handleCommand(CommandEvent e) {
528 protected boolean handleFocusEvent(FocusEvent e) {
532 protected boolean handleKeyEvent(KeyEvent e) {
536 protected boolean mouseButtonPressed(MouseButtonPressedEvent e) {
540 protected boolean mouseButtonReleased(MouseButtonReleasedEvent e) {
544 protected boolean mouseClicked(MouseClickEvent e) {
548 protected boolean mouseDoubleClicked(MouseDoubleClickedEvent e) {
552 protected boolean mouseMoved(MouseMovedEvent e) {
556 protected boolean mouseDragged(MouseDragBegin e) {
560 protected boolean mouseEntered(MouseEnterEvent e) {
564 protected boolean mouseExited(MouseExitEvent e) {
568 protected boolean mouseWheelMoved(MouseWheelMovedEvent e) {
572 protected boolean handleTimeEvent(TimeEvent e) {
576 protected void setCursor(int cursorType) {
577 Container rootPane = NodeUtil.findRootPane(this);
578 if (rootPane != null)
579 rootPane.setCursor(Cursor.getPredefinedCursor(cursorType));
582 protected void setCursor(Cursor cursor) {
583 Container rootPane = NodeUtil.findRootPane(this);
584 if (rootPane != null)
585 rootPane.setCursor(cursor);
589 public Function1<Object, Boolean> getPropertyFunction(String propertyName) {
590 return ScenegraphUtils.getMethodPropertyFunction(AWTThread.getThreadAccess(), this, propertyName);
594 public <T> T getProperty(String propertyName) {
599 public void setPropertyCallback(Function2<String, Object, Boolean> callback) {
602 public void synchronizeTransform(double[] data) {
603 this.setTransform(new AffineTransform(data));