MouseInterface.hh 3.39 KB
Newer Older
Jan Möbius's avatar
 
Jan Möbius committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102
//=============================================================================
//
//                               OpenFlipper
//        Copyright (C) 2008 by Computer Graphics Group, RWTH Aachen
//                           www.openflipper.org
//
//-----------------------------------------------------------------------------
//
//                                License
//
//  OpenFlipper is free software: you can redistribute it and/or modify
//  it under the terms of the GNU Lesser General Public License as published by
//  the Free Software Foundation, either version 3 of the License, or
//  (at your option) any later version.
// 
//  OpenFlipper is distributed in the hope that it will be useful,
//  but WITHOUT ANY WARRANTY; without even the implied warranty of
//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//  GNU Lesser General Public License for more details.
// 
//  You should have received a copy of the GNU Lesser General Public License
//  along with OpenFlipper.  If not, see <http://www.gnu.org/licenses/>.
//
//-----------------------------------------------------------------------------
//
//   $Revision$
//   $Author$
//   $Date$
//
//=============================================================================




//
// C++ Interface: Basic Interface for mouse events
//
// Description: 
//
//
// Author: Jan Moebius <moebius@informatik.rwth-aachen.de>, (C) 2007



#ifndef MOUSEINTERFACE_HH 
#define MOUSEINTERFACE_HH 

 #include <QtGui>
 
/** \brief Interface for all plugins which have to react on mouse events 
  * 
  * When using mouse events in your plugins implement this interface. Remember that 
  * all plugins may get these signals. Therefore you hav to check if the current pickingMode
  * is active before doing anything. Only the slotMouseEventIdentify is independent of picking modes.
 */  
class MouseInterface {
  
  private slots :
    
    /**  \brief Wheel Event from Main App
      * 
      *  This slot is called if a wheel event occured in the Viewer and is extended by
      *  the current Mode set in the Viewer. You can add additional Picking Modes to
      *  the Viewer by calling examiner_widget_->addPickMode("Mode"). 
      *  This slot will only get called in pickingMode.
      *  @param _event Mousevent
      *  @param _mode Name of the current Picking Mode.
    */
    virtual void slotMouseWheelEvent(QWheelEvent * _event, const std::string & _mode) {};
    
    /**  \brief Mouse Event from Main App ( Picking Mode )
      * 
      *  This slot is called if a mouse event occured in the Viewer 
      *  This slot will only get called in pickingMode. 
      *  Right button clicks will not be passed to the plugins as this is reserved for
      *  the context Menu. 
      * 
      *  @param _event Mousevent
    */
    virtual void slotMouseEvent( QMouseEvent* _event ) {};
    
    /**  \brief Mouse Event from Main App ( Identify Mode )
      * 
      *  This slot is called if a mouse event occured in the Viewer 
      *  This slot will only get called in identifyMode. 
      *  Right button clicks will not be passed to the plugins as this is reserved for
      *  the context Menu. 
      * 
      *  @param _event Mousevent
    */    
    virtual void slotMouseEventIdentify() {};
    
  public : 
      
    /// Destructor
    virtual ~MouseInterface() {};
      
};

Q_DECLARE_INTERFACE(MouseInterface,"OpenFlipper.MouseInterface/1.0")
      
#endif // MOUSEINTERFACE_HH