PickingInterface.hh 5.93 KB
Newer Older
1
/*===========================================================================*\
Jan Möbius's avatar
Jan Möbius committed
2 3
*                                                                            *
*                              OpenFlipper                                   *
Jan Möbius's avatar
Jan Möbius committed
4
*      Copyright (C) 2001-2011 by Computer Graphics Group, RWTH Aachen       *
Jan Möbius's avatar
Jan Möbius committed
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
*                           www.openflipper.org                              *
*                                                                            *
*--------------------------------------------------------------------------- *
*  This file is part of OpenFlipper.                                         *
*                                                                            *
*  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 with the               *
*  following exceptions:                                                     *
*                                                                            *
*  If other files instantiate templates or use macros                        *
*  or inline functions from this file, or you compile this file and          *
*  link it with other files to produce an executable, this file does         *
*  not by itself cause the resulting executable to be covered by the         *
*  GNU Lesser General Public License. This exception does not however        *
*  invalidate any other reasons why the executable file might be             *
*  covered by the GNU Lesser General Public License.                         *
*                                                                            *
*  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 LesserGeneral Public           *
*  License along with OpenFlipper. If not,                                   *
*  see <http://www.gnu.org/licenses/>.                                       *
*                                                                            *
33 34 35
\*===========================================================================*/

/*===========================================================================*\
Jan Möbius's avatar
Jan Möbius committed
36 37 38 39 40
*                                                                            *
*   $Revision$                                                       *
*   $LastChangedBy$                                                *
*   $Date$                     *
*                                                                            *
41
\*===========================================================================*/
Jan Möbius's avatar
 
Jan Möbius committed
42

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

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

Jan Möbius's avatar
 
Jan Möbius committed
50
 /**
Mike Kremer's avatar
Mike Kremer committed
51 52
  * \brief Allow access to picking functions.
  *
53 54 55
  * Interface Class which allows access to picking functions.
  *
  * Read tutorial \ref ex3 for an example of how to use mouse picking.
Jan Möbius's avatar
 
Jan Möbius committed
56 57 58
 */
class PickingInterface {
   signals :
Jan Möbius's avatar
 
Jan Möbius committed
59 60
      /** \brief Add a new picking mode to the examiner
       *
Jan Möbius's avatar
 
Jan Möbius committed
61 62
       * @param _mode Identifier of Picking mode or "Separator" to add a Separator
      */
Dirk Wilden's avatar
Dirk Wilden committed
63
      virtual void addPickMode( const std::string /*_mode*/) {};
Jan Möbius's avatar
 
Jan Möbius committed
64

Jan Möbius's avatar
 
Jan Möbius committed
65
      /** \brief Add a new picking mode to the examiner which will be invisible
Jan Möbius's avatar
 
Jan Möbius committed
66
       *
Jan Möbius's avatar
 
Jan Möbius committed
67 68 69
       * 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
70
       *
Jan Möbius's avatar
 
Jan Möbius committed
71 72
       * @param _mode Identifier of Picking mode or "Separator" to add a Separator
      */
Jan Möbius's avatar
 
Jan Möbius committed
73 74
      virtual void addHiddenPickMode( const std::string /*_mode*/ ) {};

Dirk Wilden's avatar
Dirk Wilden committed
75
      /** \brief Set the cursor of the given PickMode
Jan Möbius's avatar
 
Jan Möbius committed
76
       *
Dirk Wilden's avatar
Dirk Wilden committed
77
       * Set the cursor that should be used inside the pickMode
Jan Möbius's avatar
 
Jan Möbius committed
78
       *
Dirk Wilden's avatar
Dirk Wilden committed
79 80
       * @param _mode Identifier of Picking mode
       * @param _cursor the new cursor
Jan Möbius's avatar
 
Jan Möbius committed
81
      */
Dirk Wilden's avatar
Dirk Wilden committed
82 83 84
      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
85
       *
Dirk Wilden's avatar
Dirk Wilden committed
86 87
       * 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
88
       *
Dirk Wilden's avatar
Dirk Wilden committed
89 90
       * @param _mode Identifier of Picking mode
       * @param _mouseTracking new state of mouseTracking
Jan Möbius's avatar
 
Jan Möbius committed
91
      */
Dirk Wilden's avatar
Dirk Wilden committed
92 93
      virtual void setPickModeMouseTracking( const std::string /*_mode*/ , bool /*_mouseTracking*/ ) {};

Jan Möbius's avatar
Dennis:  
Jan Möbius committed
94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110
      /** \brief Set the additinal toolbar of the given PickMode
       *
       * Set the additional toolbar that should be shown in the pickMode
       *
       * @param _mode Identifier of Picking mode
       * @param _toolbar the toolbar
      */
      virtual void setPickModeToolbar( const std::string /*_mode*/ , QToolBar * /*_toolbar*/ ) {};

      /** \brief Removes the additinal toolbar of the given PickMode
       *
       * Set the additional toolbar that should be shown in the pickMode
       *
       * @param _mode Identifier of Picking mode
      */
      virtual void removePickModeToolbar( const std::string /*_mode*/ ) {};

111 112
     
  private slots:
Jan Möbius's avatar
 
Jan Möbius committed
113
      /**  \brief The pickingMode has changed
Jan Möbius's avatar
 
Jan Möbius committed
114
       *
Jan Möbius's avatar
 
Jan Möbius committed
115 116 117
       * 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
118
      virtual void slotPickModeChanged( const std::string& /*_mode*/) {};
Jan Möbius's avatar
 
Jan Möbius committed
119 120 121

   public :

Jan Möbius's avatar
 
Jan Möbius committed
122 123
      /// Destructor
      virtual ~PickingInterface() {};
Jan Möbius's avatar
 
Jan Möbius committed
124

Jan Möbius's avatar
 
Jan Möbius committed
125 126
};

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

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