bundles/org.simantics.diagram/src/org/simantics/diagram/participant/ConnectionEditingSupport.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.diagram.participant;\r
  13 \r
  14 import static org.simantics.g2d.diagram.handler.PickRequest.PickFilter.FILTER_CONNECTIONS;\r
  15 import static org.simantics.g2d.diagram.handler.PickRequest.PickFilter.FILTER_CONNECTION_EDGES;\r
  16 import static org.simantics.g2d.diagram.handler.PickRequest.PickFilter.FILTER_NODES;\r
  17 \r
  18 import java.awt.Shape;\r
  19 import java.awt.geom.AffineTransform;\r
  20 import java.awt.geom.Line2D;\r
  21 import java.awt.geom.Point2D;\r
  22 import java.util.ArrayList;\r
  23 import java.util.Collection;\r
  24 import java.util.Collections;\r
  25 import java.util.Comparator;\r
  26 import java.util.List;\r
  27 import java.util.Set;\r
  28 import java.util.concurrent.atomic.AtomicReference;\r
  29 \r
  30 import org.simantics.db.Resource;\r
  31 import org.simantics.db.WriteGraph;\r
  32 import org.simantics.db.common.request.WriteRequest;\r
  33 import org.simantics.db.exception.DatabaseException;\r
  34 import org.simantics.diagram.content.ConnectionUtil;\r
  35 import org.simantics.diagram.content.EdgeResource;\r
  36 import org.simantics.diagram.stubs.DiagramResource;\r
  37 import org.simantics.diagram.ui.DiagramModelHints;\r
  38 import org.simantics.g2d.canvas.ICanvasContext;\r
  39 import org.simantics.g2d.canvas.impl.DependencyReflection.Dependency;\r
  40 import org.simantics.g2d.diagram.DiagramHints;\r
  41 import org.simantics.g2d.diagram.IDiagram;\r
  42 import org.simantics.g2d.diagram.handler.DataElementMap;\r
  43 import org.simantics.g2d.diagram.handler.PickContext;\r
  44 import org.simantics.g2d.diagram.handler.PickRequest;\r
  45 import org.simantics.g2d.diagram.handler.PickRequest.PickPolicy;\r
  46 import org.simantics.g2d.diagram.handler.PickRequest.PickSorter;\r
  47 import org.simantics.g2d.diagram.participant.AbstractDiagramParticipant;\r
  48 import org.simantics.g2d.diagram.participant.Selection;\r
  49 import org.simantics.g2d.diagram.participant.pointertool.AbstractMode;\r
  50 import org.simantics.g2d.diagram.participant.pointertool.PointerInteractor;\r
  51 import org.simantics.g2d.diagram.participant.pointertool.TranslateMode;\r
  52 import org.simantics.g2d.element.ElementUtils;\r
  53 import org.simantics.g2d.element.IElement;\r
  54 import org.simantics.g2d.element.handler.Children;\r
  55 import org.simantics.g2d.participant.TransformUtil;\r
  56 import org.simantics.g2d.participant.WorkbenchStatusLine;\r
  57 import org.simantics.scenegraph.g2d.events.MouseEvent;\r
  58 import org.simantics.scenegraph.g2d.events.EventHandlerReflection.EventHandler;\r
  59 import org.simantics.scenegraph.g2d.events.MouseEvent.MouseButtonPressedEvent;\r
  60 import org.simantics.scenegraph.g2d.events.MouseEvent.MouseButtonReleasedEvent;\r
  61 import org.simantics.scenegraph.g2d.events.MouseEvent.MouseDragBegin;\r
  62 import org.simantics.scenegraph.g2d.events.MouseEvent.MouseMovedEvent;\r
  63 import org.simantics.scenegraph.g2d.snap.ISnapAdvisor;\r
  64 import org.simantics.ui.SimanticsUI;\r
  65 import org.simantics.utils.datastructures.hints.HintListenerAdapter;\r
  66 import org.simantics.utils.datastructures.hints.IHintContext.Key;\r
  67 import org.simantics.utils.datastructures.hints.IHintListener;\r
  68 import org.simantics.utils.datastructures.hints.IHintObservable;\r
  69 import org.simantics.utils.ui.ErrorLogger;\r
  70 \r
  71 /**\r
  72  * @author Tuukka Lehtonen\r
  73  */\r
  74 public class ConnectionEditingSupport extends AbstractDiagramParticipant {\r
  75 \r
  76     private static final boolean DEBUG = false;\r
  77 \r
  78     private static final int TOOL_PRIORITY = 100;\r
  79 \r
  80     @Dependency PointerInteractor pi;\r
  81     @Dependency PickContext pickContext;\r
  82     @Dependency Selection selection;\r
  83     @Dependency WorkbenchStatusLine statusLine;\r
  84 \r
  85     private static final PickSorter NODES_LAST = new PickSorter() {\r
  86         @Override\r
  87         public void sort(List<IElement> elements) {\r
  88             Collections.sort(elements, new Comparator<IElement>() {\r
  89                 @Override\r
  90                 public int compare(IElement e1, IElement e2) {\r
  91                     boolean is1 = FILTER_NODES.accept(e1);\r
  92                     boolean is2 = FILTER_NODES.accept(e2);\r
  93                     if (!is1 && is2)\r
  94                         return -1;\r
  95                     if (is1 && !is2)\r
  96                         return 1;\r
  97                     return 0;\r
  98                 }\r
  99             });\r
 100         }\r
 101     };\r
 102 \r
 103     private boolean routePointsEnabled() {\r
 104         return Boolean.TRUE.equals(diagram.getHint(DiagramHints.KEY_ALLOW_ROUTE_POINTS));\r
 105     }\r
 106 \r
 107     @EventHandler(priority = TOOL_PRIORITY)\r
 108     public boolean handleMouse(MouseEvent e) {\r
 109         if (!routePointsEnabled())\r
 110             return false;\r
 111         if (e instanceof MouseButtonPressedEvent)\r
 112             return handlePress((MouseButtonPressedEvent) e);\r
 113         return false;\r
 114     }\r
 115 \r
 116     private boolean handlePress(MouseButtonPressedEvent me) {\r
 117         if (me.button != MouseEvent.LEFT_BUTTON || me.hasAnyModifier(MouseEvent.ALL_MODIFIERS_MASK))\r
 118             return false;\r
 119 \r
 120         //System.out.println("button pressed: " + me);\r
 121 \r
 122         Shape shape = pi.getCanvasPickShape(me.controlPosition);\r
 123         if (shape == null)\r
 124             return false;\r
 125 \r
 126         PickRequest req = new PickRequest(shape);\r
 127         req.pickPolicy = PickPolicy.PICK_INTERSECTING_OBJECTS;\r
 128         req.pickFilter = null;\r
 129         req.pickSorter = NODES_LAST;\r
 130 \r
 131         List<IElement> pick = new ArrayList<IElement>();\r
 132         pickContext.pick(diagram, req, pick);\r
 133 \r
 134         if (pick.isEmpty())\r
 135             return false;\r
 136 \r
 137         //System.out.println("selection pick returns " + pick);\r
 138 \r
 139         // If current mouse selection contains only a connection edge or\r
 140         // complete connection and pick result contains the same connection or\r
 141         // edge as the first hit, start dragging new route point.\r
 142         Set<IElement> sel = selection.getSelection(me.mouseId);\r
 143         if (!Collections.disjoint(pick, sel)) {\r
 144             if (sel.size() == 1) {\r
 145                 IElement e = sel.iterator().next();\r
 146                 if (FILTER_CONNECTIONS.accept(e) || FILTER_CONNECTION_EDGES.accept(e)) {\r
 147                     IElement edge = findSingleConnectionEdge(pick, e);\r
 148                     if (edge != null) {\r
 149                         getContext().add(new ConnectionRoutingMode(me.mouseId, edge));\r
 150                         return true;\r
 151                     }\r
 152                 }\r
 153             }\r
 154             return false;\r
 155         }\r
 156 \r
 157         IElement edge = findSingleConnectionEdge(pick, null);\r
 158         if (edge != null) {\r
 159             getContext().add(new ConnectionRoutingMode(me.mouseId, edge));\r
 160             return true;\r
 161         }\r
 162 \r
 163         return false;\r
 164     }\r
 165 \r
 166     /**\r
 167      * @param pick\r
 168      * @param selected\r
 169      * @return\r
 170      */\r
 171     private IElement findSingleConnectionEdge(List<IElement> pick, IElement selected) {\r
 172         for (int i = pick.size() - 1; i >= 0; --i) {\r
 173             IElement p = pick.get(i);\r
 174             boolean pickedSelected = selected == null ? true : p == selected;\r
 175             if (FILTER_NODES.accept(p))\r
 176                 return null;\r
 177             if (pickedSelected && FILTER_CONNECTION_EDGES.accept(p)) {\r
 178                 return p;\r
 179             }\r
 180         }\r
 181         for (int i = pick.size() - 1; i >= 0; --i) {\r
 182             IElement p = pick.get(i);\r
 183             boolean pickedSelected = selected == null ? true : p == selected;\r
 184             if (FILTER_CONNECTIONS.accept(p)) {\r
 185                 Children ch = p.getElementClass().getAtMostOneItemOfClass(Children.class);\r
 186                 if (ch == null)\r
 187                     return null;\r
 188 \r
 189                 Collection<IElement> children = ch.getChildren(p, null);\r
 190                 int childCount = children.size();\r
 191                 if (childCount == 1) {\r
 192                     for (IElement child : children) {\r
 193                         if (pickedSelected && FILTER_CONNECTION_EDGES.accept(child))\r
 194                             return child;\r
 195                     }\r
 196                 } else if (childCount > 1) {\r
 197                     for (IElement child : children) {\r
 198                         if (pickedSelected && FILTER_CONNECTION_EDGES.accept(child) && pick.contains(child))\r
 199                             return child;\r
 200                     }\r
 201                 }\r
 202             }\r
 203         }\r
 204         return null;\r
 205     }\r
 206 \r
 207     static class ConnectionRoutingMode extends AbstractMode {\r
 208 \r
 209         @Dependency TransformUtil tr;\r
 210         @Dependency Selection sel;\r
 211 \r
 212         private boolean dragging;\r
 213         private final IElement edge;\r
 214 \r
 215         public ConnectionRoutingMode(int mouseId, IElement edge) {\r
 216             super(mouseId);\r
 217             if (DEBUG)\r
 218                 System.out.println("Start routing mode (" + mouseId + ")");\r
 219             this.edge = edge;\r
 220         }\r
 221 \r
 222         @Override\r
 223         public void addedToContext(ICanvasContext ctx) {\r
 224             super.addedToContext(ctx);\r
 225             if (DEBUG)\r
 226                 System.out.println(this + " added");\r
 227         }\r
 228 \r
 229         @Override\r
 230         public void removedFromContext(ICanvasContext ctx) {\r
 231             if (DEBUG)\r
 232                 System.out.println(this + " removed");\r
 233             super.removedFromContext(ctx);\r
 234         }\r
 235 \r
 236         @Override\r
 237         protected void onDiagramSet(IDiagram newDiagram, IDiagram oldDiagram) {\r
 238             if (oldDiagram != null) {\r
 239                 oldDiagram.removeKeyHintListener(DiagramModelHints.KEY_DIAGRAM_CONTENTS_UPDATED, diagramHintListener);\r
 240             }\r
 241             if (newDiagram != null) {\r
 242                 newDiagram.addKeyHintListener(DiagramModelHints.KEY_DIAGRAM_CONTENTS_UPDATED, diagramHintListener);\r
 243             }\r
 244         }\r
 245 \r
 246         @EventHandler(priority = TOOL_PRIORITY + 10)\r
 247         public boolean handleMouse(MouseEvent e) {\r
 248             if (!isModeMouse(e))\r
 249                 return false;\r
 250 \r
 251             //System.out.println("mouse event: " + e);\r
 252 \r
 253             if (e instanceof MouseMovedEvent)\r
 254                 return handleMove((MouseMovedEvent) e);\r
 255             if (e instanceof MouseDragBegin)\r
 256                 return handleDrag((MouseDragBegin) e);\r
 257             if (e instanceof MouseButtonReleasedEvent)\r
 258                 return handleRelease((MouseButtonReleasedEvent) e);\r
 259 \r
 260             // Ignore all other events\r
 261             return true;\r
 262         }\r
 263 \r
 264         private boolean handleDrag(MouseDragBegin e) {\r
 265             // Mark dragging as started.\r
 266             dragging = true;\r
 267             splitConnection(e.startCanvasPos, tr.controlToCanvas(e.controlPosition, null));\r
 268             return true;\r
 269         }\r
 270 \r
 271         private boolean handleMove(MouseMovedEvent e) {\r
 272             if (!dragging)\r
 273                 return true;\r
 274             if (DEBUG)\r
 275                 System.out.println("routing move: " + e);\r
 276             return false;\r
 277         }\r
 278 \r
 279         private boolean handleRelease(MouseButtonReleasedEvent e) {\r
 280 //            setDirty();\r
 281             remove();\r
 282             return false;\r
 283         }\r
 284 \r
 285         boolean splitConnection(final Point2D startingPos, Point2D currentPos) {\r
 286             final IDiagram diagram = ElementUtils.peekDiagram(edge);\r
 287             if (diagram == null)\r
 288                 return false;\r
 289             final EdgeResource segment = (EdgeResource) ElementUtils.getObject(edge);\r
 290             if (segment == null)\r
 291                 return false;\r
 292 \r
 293             Point2D snapPos = new Point2D.Double(startingPos.getX(), startingPos.getY());\r
 294             ISnapAdvisor snap = getHint(DiagramHints.SNAP_ADVISOR);\r
 295             if (snap != null)\r
 296                 snap.snap(snapPos);\r
 297 \r
 298             final AffineTransform splitPos = AffineTransform.getTranslateInstance(snapPos.getX(), snapPos.getY());\r
 299             final AtomicReference<Resource> newBp = new AtomicReference<Resource>();\r
 300 \r
 301             try {\r
 302                 SimanticsUI.getSession().syncRequest(new WriteRequest() {\r
 303                     @Override\r
 304                     public void perform(WriteGraph graph) throws DatabaseException {\r
 305                         DiagramResource DIA = DiagramResource.getInstance(graph);\r
 306 \r
 307                         // Split the edge with a new branch point\r
 308                         ConnectionUtil cu = new ConnectionUtil(graph);\r
 309                         Resource bp = cu.split(segment, splitPos);\r
 310 \r
 311                         Line2D nearestLine = ConnectionUtil.resolveNearestEdgeLineSegment(startingPos, edge);\r
 312                         if (nearestLine != null) {\r
 313                             double angle = Math.atan2(\r
 314                                     Math.abs(nearestLine.getY2() - nearestLine.getY1()),\r
 315                                     Math.abs(nearestLine.getX2() - nearestLine.getX1())\r
 316                             );\r
 317 \r
 318                             if (angle >= 0 && angle < Math.PI / 4) {\r
 319                                 graph.claim(bp, DIA.Horizontal, bp);\r
 320                             } else if (angle > Math.PI / 4 && angle <= Math.PI / 2) {\r
 321                                 graph.claim(bp, DIA.Vertical, bp);\r
 322                             }\r
 323                         }\r
 324 \r
 325                         newBp.set(bp);\r
 326                     }\r
 327 \r
 328                 });\r
 329 \r
 330                 dragData.set(new DragData(Collections.singleton(newBp.get()), startingPos, currentPos));\r
 331 \r
 332             } catch (DatabaseException e) {\r
 333                 ErrorLogger.defaultLogError(e);\r
 334             }\r
 335 \r
 336             return false;\r
 337         }\r
 338 \r
 339         static class DragData {\r
 340             Set<?> data;\r
 341             Point2D startingPoint;\r
 342             Point2D currentPoint;\r
 343             public DragData(Set<?> data, Point2D startingPoint, Point2D currentPoint) {\r
 344                 this.data = data;\r
 345                 this.startingPoint = startingPoint;\r
 346                 this.currentPoint = currentPoint;\r
 347             }\r
 348         }\r
 349 \r
 350         private final AtomicReference<DragData> dragData = new AtomicReference<DragData>();\r
 351 \r
 352         IHintListener diagramHintListener = new HintListenerAdapter() {\r
 353             @Override\r
 354             public void hintChanged(IHintObservable sender, Key key, Object oldValue, Object newValue) {\r
 355                 if (isRemoved())\r
 356                     return;\r
 357                 if (key == DiagramModelHints.KEY_DIAGRAM_CONTENTS_UPDATED) {\r
 358                     final DragData data = dragData.getAndSet(null);\r
 359                     if (data != null) {\r
 360                         asyncExec(new Runnable() {\r
 361                             @Override\r
 362                             public void run() {\r
 363                                 // Safety first.\r
 364                                 if (isRemoved())\r
 365                                     return;\r
 366                                 setDiagramSelectionToData(data);\r
 367                             }\r
 368                         });\r
 369                     }\r
 370                 }\r
 371             }\r
 372 \r
 373             private void setDiagramSelectionToData(final DragData data) {\r
 374                 DataElementMap dem = diagram.getDiagramClass().getAtMostOneItemOfClass(DataElementMap.class);\r
 375                 if (dem != null) {\r
 376                     final Collection<IElement> newSelection = new ArrayList<IElement>(data.data.size());\r
 377                     for (Object datum : data.data) {\r
 378                         IElement element = dem.getElement(diagram, datum);\r
 379                         if (element != null) {\r
 380                             newSelection.add(element);\r
 381                         }\r
 382                     }\r
 383 \r
 384                     if (!newSelection.isEmpty()) {\r
 385                         sel.setSelection(0, newSelection);\r
 386                         getContext().add( new TranslateMode(data.startingPoint, data.currentPoint, getMouseId(), newSelection) );\r
 387                         remove();\r
 388                     }\r
 389                 }\r
 390             }\r
 391         };\r
 392 \r
 393     }\r
 394 \r
 395 }\r