PickingInterface.hh 3.48 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
//=============================================================================
//
//                               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.
Jan Möbius's avatar
 
Jan Möbius committed
15
//
Jan Möbius's avatar
 
Jan Möbius committed
16 17 18 19
//  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.
Jan Möbius's avatar
 
Jan Möbius committed
20
//
Jan Möbius's avatar
 
Jan Möbius committed
21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37
//  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: PickingInterface
//
Jan Möbius's avatar
 
Jan Möbius committed
38
// Description:
Jan Möbius's avatar
 
Jan Möbius committed
39 40 41 42 43
//
//
// Author: Jan Moebius <jan_moebius@web.de>, (C) 2007
//

Jan Möbius's avatar
 
Jan Möbius committed
44 45
#ifndef PICKINGINTERFACE_HH
#define PICKINGINTERFACE_HH
Jan Möbius's avatar
 
Jan Möbius committed
46 47 48 49

 #include <QtGui>
 #include <QMenuBar>
 #include <OpenFlipper/common/Types.hh>
Jan Möbius's avatar
 
Jan Möbius committed
50

Jan Möbius's avatar
 
Jan Möbius committed
51 52 53 54 55
 /**
  *  Interface Class which allows access to picking functions
 */
class PickingInterface {
   signals :
Jan Möbius's avatar
 
Jan Möbius committed
56 57
      /** \brief Add a new picking mode to the examiner
       *
Jan Möbius's avatar
 
Jan Möbius committed
58 59
       * @param _mode Identifier of Picking mode or "Separator" to add a Separator
      */
Dirk Wilden's avatar
Dirk Wilden committed
60
      virtual void addPickMode( const std::string /*_mode*/) {};
Jan Möbius's avatar
 
Jan Möbius committed
61

Jan Möbius's avatar
 
Jan Möbius committed
62
      /** \brief Add a new picking mode to the examiner which will be invisible
Jan Möbius's avatar
 
Jan Möbius committed
63
       *
Jan Möbius's avatar
 
Jan Möbius committed
64 65 66
       * The added PickMode will not appear in the context menus Picking menu.
       * You have to provide a button or menuentry yourself if you want to switch to
       * the picking mode provided here.
Jan Möbius's avatar
 
Jan Möbius committed
67
       *
Jan Möbius's avatar
 
Jan Möbius committed
68 69
       * @param _mode Identifier of Picking mode or "Separator" to add a Separator
      */
Jan Möbius's avatar
 
Jan Möbius committed
70 71
      virtual void addHiddenPickMode( const std::string /*_mode*/ ) {};

Dirk Wilden's avatar
Dirk Wilden committed
72
      /** \brief Set the cursor of the given PickMode
Jan Möbius's avatar
 
Jan Möbius committed
73
       *
Dirk Wilden's avatar
Dirk Wilden committed
74
       * Set the cursor that should be used inside the pickMode
Jan Möbius's avatar
 
Jan Möbius committed
75
       *
Dirk Wilden's avatar
Dirk Wilden committed
76 77
       * @param _mode Identifier of Picking mode
       * @param _cursor the new cursor
Jan Möbius's avatar
 
Jan Möbius committed
78
      */
Dirk Wilden's avatar
Dirk Wilden committed
79 80 81
      virtual void setPickModeCursor( const std::string /*_mode*/ , QCursor /*_cursor*/ ) {};

      /** \brief Set mouse tracking for the given PickMode
Jan Möbius's avatar
 
Jan Möbius committed
82
       *
Dirk Wilden's avatar
Dirk Wilden committed
83 84
       * Enable mouseTracking for the given PickMode. When MouseTracking is enabled
       * you receive mouseMove events also when no button is pressed (via MouseInterface)
Jan Möbius's avatar
 
Jan Möbius committed
85
       *
Dirk Wilden's avatar
Dirk Wilden committed
86 87
       * @param _mode Identifier of Picking mode
       * @param _mouseTracking new state of mouseTracking
Jan Möbius's avatar
 
Jan Möbius committed
88
      */
Dirk Wilden's avatar
Dirk Wilden committed
89 90
      virtual void setPickModeMouseTracking( const std::string /*_mode*/ , bool /*_mouseTracking*/ ) {};

Jan Möbius's avatar
 
Jan Möbius committed
91
      /**  \brief The pickingMode has changed
Jan Möbius's avatar
 
Jan Möbius committed
92
       *
Jan Möbius's avatar
 
Jan Möbius committed
93 94 95
       * This slot is called if the user changes the current picking mode
       * @param _mode Identifier of Picking mode
      */
Dirk Wilden's avatar
Dirk Wilden committed
96
      virtual void slotPickModeChanged( const std::string& /*_mode*/) {};
Jan Möbius's avatar
 
Jan Möbius committed
97 98 99

   public :

Jan Möbius's avatar
 
Jan Möbius committed
100 101
      /// Destructor
      virtual ~PickingInterface() {};
Jan Möbius's avatar
 
Jan Möbius committed
102

Jan Möbius's avatar
 
Jan Möbius committed
103 104
};

Dirk Wilden's avatar
Dirk Wilden committed
105
Q_DECLARE_INTERFACE(PickingInterface,"OpenFlipper.PickingInterface/1.1")
Jan Möbius's avatar
 
Jan Möbius committed
106

Jan Möbius's avatar
 
Jan Möbius committed
107
#endif // PICKINGINTERFACE_HH