vtk.rendering/src/vtk/rendering/vtkEventInterceptor.java

   1 package vtk.rendering;
   2
   3 import java.awt.event.KeyEvent;
   4 import java.awt.event.KeyListener;
   5 import java.awt.event.MouseEvent;
   6 import java.awt.event.MouseListener;
   7 import java.awt.event.MouseMotionListener;
   8 import java.awt.event.MouseWheelEvent;
   9
  10 /**
  11  * This interface defines what should be implemented to intercept interaction
  12  * events and create custom behavior.
  13  *
  14  * @see {@link MouseMotionListener} {@link MouseListener} {@link MouseWheelListener}
  15  *      {@link KeyListener}
  16  *
  17  * @author    Sebastien Jourdain - sebastien.jourdain@kitware.com, Kitware Inc 2012
  18  * @copyright This work was supported by CEA/CESTA
  19  *            Commissariat a l'Energie Atomique et aux Energies Alternatives,
  20  *            15 avenue des Sablieres, CS 60001, 33116 Le Barp, France.
  21  */
  22 public interface vtkEventInterceptor {
  23
  24   /**
  25    * @param e
  26    *            event
  27    * @return true if the event has been consumed and should not be forwarded
  28    *         to the vtkInteractor
  29    */
  30   boolean keyPressed(KeyEvent e);
  31
  32   /**
  33    * @param e
  34    *            event
  35    * @return true if the event has been consumed and should not be forwarded
  36    *         to the vtkInteractor
  37    */
  38   boolean keyReleased(KeyEvent e);
  39
  40   /**
  41    * @param e
  42    *            event
  43    * @return true if the event has been consumed and should not be forwarded
  44    *         to the vtkInteractor
  45    */
  46   boolean keyTyped(KeyEvent e);
  47
  48   /**
  49    * @param e
  50    *            event
  51    * @return true if the event has been consumed and should not be forwarded
  52    *         to the vtkInteractor
  53    */
  54   boolean mouseDragged(MouseEvent e);
  55
  56   /**
  57    * @param e
  58    *            event
  59    * @return true if the event has been consumed and should not be forwarded
  60    *         to the vtkInteractor
  61    */
  62   boolean mouseMoved(MouseEvent e);
  63
  64   /**
  65    * @param e
  66    *            event
  67    * @return true if the event has been consumed and should not be forwarded
  68    *         to the vtkInteractor
  69    */
  70   boolean mouseClicked(MouseEvent e);
  71
  72   /**
  73    * @param e
  74    *            event
  75    * @return true if the event has been consumed and should not be forwarded
  76    *         to the vtkInteractor
  77    */
  78   boolean mouseEntered(MouseEvent e);
  79
  80   /**
  81    * @param e
  82    *            event
  83    * @return true if the event has been consumed and should not be forwarded
  84    *         to the vtkInteractor
  85    */
  86   boolean mouseExited(MouseEvent e);
  87
  88   /**
  89    * @param e
  90    *            event
  91    * @return true if the event has been consumed and should not be forwarded
  92    *         to the vtkInteractor
  93    */
  94   boolean mousePressed(MouseEvent e);
  95
  96   /**
  97    * @param e
  98    *            event
  99    * @return true if the event has been consumed and should not be forwarded
 100    *         to the vtkInteractor
 101    */
 102   boolean mouseReleased(MouseEvent e);
 103
 104   /**
 105    * @param e
 106    *            event
 107    * @return true if the event has been consumed and should not be forwarded
 108    *         to the vtkInteractor
 109    */
 110   boolean mouseWheelMoved(MouseWheelEvent e);
 111 }