gov/nasa/worldwind/awt/AWTInputHandler.java

   1 /*
   2 Copyright (C) 2001, 2006 United States Government
   3 as represented by the Administrator of the
   4 National Aeronautics and Space Administration.
   5 All Rights Reserved.
   6 */
   7 package gov.nasa.worldwind.awt;
   8
   9 import gov.nasa.worldwind.WorldWindow;
  10 import gov.nasa.worldwind.avlist.*;
  11 import gov.nasa.worldwind.event.*;
  12 import gov.nasa.worldwind.pick.*;
  13 import gov.nasa.worldwind.util.Logging;
  14
  15 import javax.swing.event.*;
  16 import java.awt.*;
  17 import java.awt.event.*;
  18
  19 /**
  20  * @author tag
  21  * @version $Id: AWTInputHandler.java 2520 2007-08-07 15:39:39Z tgaskins $
  22  */
  23 public class AWTInputHandler extends AVListImpl
  24     implements KeyListener, MouseListener, MouseMotionListener, MouseWheelListener, FocusListener, InputHandler
  25 {
  26     private WorldWindow wwd = null;
  27     private final EventListenerList eventListeners = new EventListenerList();
  28     private java.awt.Point mousePoint = new java.awt.Point();
  29     private PickedObjectList hoverObjects;
  30     private PickedObjectList objectsAtButtonPress;
  31     private boolean isHovering = false;
  32     private boolean isDragging = false;
  33     private javax.swing.Timer hoverTimer = new javax.swing.Timer(600, new ActionListener()
  34     {
  35         public void actionPerformed(ActionEvent actionEvent)
  36         {
  37             if (AWTInputHandler.this.pickMatches(AWTInputHandler.this.hoverObjects))
  38             {
  39                 AWTInputHandler.this.isHovering = true;
  40                 AWTInputHandler.this.callSelectListeners(new SelectEvent(AWTInputHandler.this.wwd,
  41                     SelectEvent.HOVER, mousePoint, AWTInputHandler.this.hoverObjects));
  42                 AWTInputHandler.this.hoverTimer.stop();
  43             }
  44         }
  45     });
  46     // Delegate handler for View.
  47     private final OrbitViewInputBroker viewInputBroker = new OrbitViewInputBroker();
  48
  49     public void setEventSource(WorldWindow newWorldWindow)
  50     {
  51         if (newWorldWindow != null && !(newWorldWindow instanceof Component))
  52         {
  53             String message = Logging.getMessage("Awt.AWTInputHandler.EventSourceNotAComponent");
  54             Logging.logger().finer(message);
  55             throw new IllegalArgumentException(message);
  56         }
  57
  58         if (newWorldWindow == this.wwd)
  59             return;
  60
  61         if (this.wwd != null)
  62         {
  63             Component c = (Component) this.wwd;
  64             c.removeKeyListener(this);
  65             c.removeMouseMotionListener(this);
  66             c.removeMouseListener(this);
  67             c.removeMouseWheelListener(this);
  68             c.removeFocusListener(this);
  69         }
  70
  71         this.wwd = newWorldWindow;
  72         this.viewInputBroker.setWorldWindow(this.wwd);
  73
  74         if (this.wwd == null)
  75             return;
  76
  77         Component c = (java.awt.Component) this.wwd;
  78         c.addKeyListener(this);
  79         c.addMouseMotionListener(this);
  80         c.addMouseListener(this);
  81         c.addMouseWheelListener(this);
  82         c.addFocusListener(this);
  83
  84         this.wwd.addSelectListener(new SelectListener()
  85         {
  86             public void selected(SelectEvent event)
  87             {
  88                 if (event.getEventAction().equals(SelectEvent.ROLLOVER))
  89                     doHover(true);
  90             }
  91         });
  92     }
  93
  94     public WorldWindow getEventSource()
  95     {
  96         return this.wwd;
  97     }
  98
  99     public void setHoverDelay(int delay)
 100     {
 101         this.hoverTimer.setDelay(delay);
 102     }
 103
 104     public int getHoverDelay()
 105     {
 106         return this.hoverTimer.getDelay();
 107     }
 108
 109     public boolean isSmoothViewChanges()
 110     {
 111         return this.viewInputBroker.isSmoothViewChanges();
 112     }
 113
 114     public void setSmoothViewChanges(boolean smoothViewChanges)
 115     {
 116         this.viewInputBroker.setSmoothViewChanges(smoothViewChanges);
 117     }
 118
 119     public boolean isLockViewHeading()
 120     {
 121         return this.viewInputBroker.isLockHeading();
 122     }
 123
 124     public void setLockViewHeading(boolean lockHeading)
 125     {
 126         this.viewInputBroker.setLockHeading(lockHeading);
 127     }
 128
 129     protected WorldWindow getWorldWindow()
 130     {
 131         return wwd;
 132     }
 133
 134     protected Point getMousePoint()
 135     {
 136         return mousePoint;
 137     }
 138
 139     protected void setMousePoint(Point mousePoint)
 140     {
 141         this.mousePoint = mousePoint;
 142     }
 143
 144     protected boolean isHovering()
 145     {
 146         return isHovering;
 147     }
 148
 149     protected void setHovering(boolean hovering)
 150     {
 151         isHovering = hovering;
 152     }
 153
 154     protected boolean isDragging()
 155     {
 156         return isDragging;
 157     }
 158
 159     protected void setDragging(boolean dragging)
 160     {
 161         isDragging = dragging;
 162     }
 163
 164     protected PickedObjectList getHoverObjects()
 165     {
 166         return hoverObjects;
 167     }
 168
 169     protected void setHoverObjects(PickedObjectList hoverObjects)
 170     {
 171         this.hoverObjects = hoverObjects;
 172     }
 173
 174     protected PickedObjectList getObjectsAtButtonPress()
 175     {
 176         return objectsAtButtonPress;
 177     }
 178
 179     protected void setObjectsAtButtonPress(PickedObjectList objectsAtButtonPress)
 180     {
 181         this.objectsAtButtonPress = objectsAtButtonPress;
 182     }
 183
 184     protected OrbitViewInputBroker getViewInputBroker()
 185     {
 186         return viewInputBroker;
 187     }
 188
 189     public void keyTyped(KeyEvent keyEvent)
 190     {
 191         if (this.wwd == null) // include this test to ensure any derived implementation performs it
 192             return;
 193
 194         if (keyEvent == null)
 195             return;
 196
 197         this.viewInputBroker.keyTyped(keyEvent);
 198     }
 199
 200     public void keyPressed(KeyEvent keyEvent)
 201     {
 202         if (this.wwd == null) // include this test to ensure any derived implementation performs it
 203             return;
 204
 205         if (keyEvent == null)
 206             return;
 207
 208         this.viewInputBroker.keyPressed(keyEvent);
 209     }
 210
 211     public void keyReleased(KeyEvent keyEvent)
 212     {
 213         if (this.wwd == null) // include this test to ensure any derived implementation performs it
 214             return;
 215
 216         if (keyEvent == null)
 217             return;
 218
 219         this.viewInputBroker.keyReleased(keyEvent);
 220     }
 221
 222     public void mouseClicked(final MouseEvent mouseEvent)
 223     {
 224         if (this.wwd == null) // include this test to ensure any derived implementation performs it
 225             return;
 226
 227         if (this.wwd.getView() == null)
 228             return;
 229
 230         if (mouseEvent == null)
 231             return;
 232
 233         PickedObjectList pickedObjects = this.wwd.getObjectsAtCurrentPosition();
 234         if (pickedObjects != null && pickedObjects.getTopPickedObject() != null
 235             && !pickedObjects.getTopPickedObject().isTerrain())
 236         {
 237             // Something is under the cursor, so it's deemed "selected".
 238             if (MouseEvent.BUTTON1 == mouseEvent.getButton())
 239             {
 240                 if (mouseEvent.getClickCount() % 2 == 1)
 241                 {
 242                     this.callSelectListeners(new SelectEvent(this.wwd, SelectEvent.LEFT_CLICK,
 243                         mouseEvent, pickedObjects));
 244                 }
 245                 else
 246                 {
 247                     this.callSelectListeners(new SelectEvent(this.wwd, SelectEvent.LEFT_DOUBLE_CLICK,
 248                         mouseEvent, pickedObjects));
 249                 }
 250             }
 251             else if (MouseEvent.BUTTON3 == mouseEvent.getButton())
 252             {
 253                 this.callSelectListeners(new SelectEvent(this.wwd, SelectEvent.RIGHT_CLICK,
 254                     mouseEvent, pickedObjects));
 255             }
 256
 257             this.wwd.getView().firePropertyChange(AVKey.VIEW, null, this.wwd.getView());
 258         }
 259         else
 260         {
 261             this.viewInputBroker.mouseClicked(mouseEvent);
 262         }
 263     }
 264
 265     public void mousePressed(MouseEvent mouseEvent)
 266     {
 267         if (this.wwd == null) // include this test to ensure any derived implementation performs it
 268             return;
 269
 270         if (mouseEvent == null)
 271             return;
 272
 273         this.mousePoint = mouseEvent.getPoint();
 274         this.cancelHover();
 275         this.cancelDrag();
 276
 277         this.objectsAtButtonPress = this.wwd.getObjectsAtCurrentPosition();
 278         if (this.objectsAtButtonPress != null && objectsAtButtonPress.getTopPickedObject() != null
 279             && !this.objectsAtButtonPress.getTopPickedObject().isTerrain())
 280         {
 281             // Something is under the cursor, so it's deemed "selected".
 282             if (MouseEvent.BUTTON1 == mouseEvent.getButton())
 283             {
 284                 this.callSelectListeners(new SelectEvent(this.wwd, SelectEvent.LEFT_PRESS,
 285                     mouseEvent, this.objectsAtButtonPress));
 286             }
 287             else if (MouseEvent.BUTTON3 == mouseEvent.getButton())
 288             {
 289                 this.callSelectListeners(new SelectEvent(this.wwd, SelectEvent.RIGHT_PRESS,
 290                     mouseEvent, this.objectsAtButtonPress));
 291             }
 292
 293             this.wwd.getView().firePropertyChange(AVKey.VIEW, null, this.wwd.getView());
 294         }
 295         else
 296         {
 297             this.viewInputBroker.mousePressed(mouseEvent);
 298         }
 299     }
 300
 301     public void mouseReleased(MouseEvent mouseEvent)
 302     {
 303         if (this.wwd == null) // include this test to ensure any derived implementation performs it
 304             return;
 305
 306         if (mouseEvent == null)
 307             return;
 308
 309         this.mousePoint = mouseEvent.getPoint();
 310         this.viewInputBroker.mouseReleased(mouseEvent);
 311         this.doHover(true);
 312         this.cancelDrag();
 313     }
 314
 315     public void mouseEntered(MouseEvent mouseEvent)
 316     {
 317         if (this.wwd == null) // include this test to ensure any derived implementation performs it
 318             return;
 319
 320         if (mouseEvent == null)
 321             return;
 322
 323         this.viewInputBroker.mouseEntered(mouseEvent);
 324         this.cancelHover();
 325         this.cancelDrag();
 326     }
 327
 328     public void mouseExited(MouseEvent mouseEvent)
 329     {
 330         if (this.wwd == null) // include this test to ensure any derived implementation performs it
 331             return;
 332
 333         if (mouseEvent == null)
 334             return;
 335
 336         this.viewInputBroker.mouseExited(mouseEvent);
 337         this.cancelHover();
 338         this.cancelDrag();
 339     }
 340
 341     public void mouseDragged(MouseEvent mouseEvent)
 342     {
 343         if (this.wwd == null) // include this test to ensure any derived implementation performs it
 344             return;
 345
 346         if (mouseEvent == null)
 347             return;
 348
 349         Point prevMousePoint = this.mousePoint;
 350         this.mousePoint = mouseEvent.getPoint();
 351
 352         if (MouseEvent.BUTTON1_DOWN_MASK == mouseEvent.getModifiersEx())
 353         {
 354             PickedObjectList pickedObjects = this.objectsAtButtonPress;
 355             if (this.isDragging
 356                 || (pickedObjects != null && pickedObjects.getTopPickedObject() != null
 357                 && !pickedObjects.getTopPickedObject().isTerrain()))
 358             {
 359                 this.isDragging = true;
 360                 this.callSelectListeners(new DragSelectEvent(this.wwd, SelectEvent.DRAG, mouseEvent, pickedObjects,
 361                     prevMousePoint));
 362             }
 363         }
 364
 365         if (!this.isDragging)
 366         {
 367             this.viewInputBroker.mouseDragged(mouseEvent);
 368         }
 369
 370         // Redraw to update the current position and selection.
 371         if (this.wwd.getSceneController() != null)
 372         {
 373             this.wwd.getSceneController().setPickPoint(mouseEvent.getPoint());
 374             this.wwd.redrawNow();
 375         }
 376     }
 377
 378     public void mouseMoved(MouseEvent mouseEvent)
 379     {
 380         if (this.wwd == null) // include this test to ensure any derived implementation performs it
 381             return;
 382
 383         if (mouseEvent == null)
 384             return;
 385
 386         this.mousePoint = mouseEvent.getPoint();
 387         this.viewInputBroker.mouseMoved(mouseEvent);
 388
 389         // Redraw to update the current position and selection.
 390         if (this.wwd.getSceneController() != null)
 391         {
 392             this.wwd.getSceneController().setPickPoint(mouseEvent.getPoint());
 393             this.wwd.redrawNow();
 394         }
 395     }
 396
 397     public void mouseWheelMoved(MouseWheelEvent mouseWheelEvent)
 398     {
 399         if (this.wwd == null) // include this test to ensure any derived implementation performs it
 400             return;
 401
 402         if (mouseWheelEvent == null)
 403             return;
 404
 405         this.viewInputBroker.mouseWheelMoved(mouseWheelEvent);
 406     }
 407
 408     public void focusGained(FocusEvent focusEvent)
 409     {
 410         if (this.wwd == null) // include this test to ensure any derived implementation performs it
 411             return;
 412
 413         if (focusEvent == null)
 414             return;
 415
 416         this.viewInputBroker.focusGained(focusEvent);
 417     }
 418
 419     public void focusLost(FocusEvent focusEvent)
 420     {
 421         if (this.wwd == null) // include this test to ensure any derived implementation performs it
 422             return;
 423
 424         if (focusEvent == null)
 425             return;
 426
 427         this.viewInputBroker.focusLost(focusEvent);
 428     }
 429
 430     protected boolean isPickListEmpty(PickedObjectList pickList)
 431     {
 432         return pickList == null || pickList.size() < 1;
 433     }
 434
 435     protected void doHover(boolean reset)
 436     {
 437         PickedObjectList pickedObjects = this.wwd.getObjectsAtCurrentPosition();
 438         if (!(this.isPickListEmpty(this.hoverObjects) || this.isPickListEmpty(pickedObjects)))
 439         {
 440             PickedObject hover = this.hoverObjects.getTopPickedObject();
 441             PickedObject last = pickedObjects.getTopPickedObject();
 442
 443             if (hover != null && last != null && hover.getObject().equals(last.getObject()))
 444             {
 445                 return; // object picked is the hover object. don't do anything but wait for the timer to expire.
 446             }
 447         }
 448
 449         this.cancelHover();
 450
 451         if (!reset)
 452             return;
 453
 454         if ((pickedObjects != null)
 455             && (pickedObjects.getTopObject() != null)
 456             && pickedObjects.getTopPickedObject().isTerrain())
 457             return;
 458
 459         this.hoverObjects = pickedObjects;
 460         this.hoverTimer.restart();
 461     }
 462
 463     private void cancelHover()
 464     {
 465         if (this.isHovering)
 466         {
 467             this.callSelectListeners(new SelectEvent(this.wwd, SelectEvent.HOVER, this.mousePoint, null));
 468         }
 469
 470         this.isHovering = false;
 471         this.hoverObjects = null;
 472         this.hoverTimer.stop();
 473     }
 474
 475     protected boolean pickMatches(PickedObjectList pickedObjects)
 476     {
 477         if (this.isPickListEmpty(this.wwd.getObjectsAtCurrentPosition()) || this.isPickListEmpty(pickedObjects))
 478             return false;
 479
 480         PickedObject lastTop = this.wwd.getObjectsAtCurrentPosition().getTopPickedObject();
 481
 482         if (null != lastTop && lastTop.isTerrain())
 483             return false;
 484
 485         PickedObject newTop = pickedObjects.getTopPickedObject();
 486         //noinspection SimplifiableIfStatement
 487         if (lastTop == null || newTop == null || lastTop.getObject() == null || newTop.getObject() == null)
 488             return false;
 489
 490         return lastTop.getObject().equals(newTop.getObject());
 491     }
 492
 493     protected void cancelDrag()
 494     {
 495         if (this.isDragging)
 496         {
 497             this.callSelectListeners(new DragSelectEvent(this.wwd, SelectEvent.DRAG_END, null,
 498                 this.objectsAtButtonPress, this.mousePoint));
 499         }
 500
 501         this.isDragging = false;
 502     }
 503
 504     public void addSelectListener(SelectListener listener)
 505     {
 506         this.eventListeners.add(SelectListener.class, listener);
 507     }
 508
 509     public void removeSelectListener(SelectListener listener)
 510     {
 511         this.eventListeners.remove(SelectListener.class, listener);
 512     }
 513
 514     protected void callSelectListeners(SelectEvent event)
 515     {
 516         for (SelectListener listener : this.eventListeners.getListeners(SelectListener.class))
 517         {
 518             listener.selected(event);
 519         }
 520     }
 521 }