PickingInterface.hh 6.06 KB
Newer Older
1
2
3
/*===========================================================================*\
 *                                                                           *
 *                              OpenFlipper                                  *
Jan Möbius's avatar
Jan Möbius committed
4
 *      Copyright (C) 2001-2010 by Computer Graphics Group, RWTH Aachen      *
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
 *                           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/>.                                      *
 *                                                                           *
\*===========================================================================*/

/*===========================================================================*\
 *                                                                           *
 *   $Revision$                                                         *
 *   $Author$                                                      *
 *   $Date$                   *
 *                                                                           *
\*===========================================================================*/
Jan Möbius's avatar
 
Jan Möbius committed
42
43
44
45
46
47
48




//
// C++ Interface: PickingInterface
//
Jan Möbius's avatar
 
Jan Möbius committed
49
// Description:
Jan Möbius's avatar
 
Jan Möbius committed
50
51
52
53
54
//
//
// Author: Jan Moebius <jan_moebius@web.de>, (C) 2007
//

Jan Möbius's avatar
 
Jan Möbius committed
55
56
#ifndef PICKINGINTERFACE_HH
#define PICKINGINTERFACE_HH
Jan Möbius's avatar
 
Jan Möbius committed
57
58
59
60

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

Jan Möbius's avatar
 
Jan Möbius committed
62
 /**
Mike Kremer's avatar
Mike Kremer committed
63
64
  * \brief Allow access to picking functions.
  *
65
66
67
  * 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
68
69
70
 */
class PickingInterface {
   signals :
Jan Möbius's avatar
 
Jan Möbius committed
71
72
      /** \brief Add a new picking mode to the examiner
       *
Jan Möbius's avatar
 
Jan Möbius committed
73
74
       * @param _mode Identifier of Picking mode or "Separator" to add a Separator
      */
Dirk Wilden's avatar
Dirk Wilden committed
75
      virtual void addPickMode( const std::string /*_mode*/) {};
Jan Möbius's avatar
 
Jan Möbius committed
76

Jan Möbius's avatar
 
Jan Möbius committed
77
      /** \brief Add a new picking mode to the examiner which will be invisible
Jan Möbius's avatar
 
Jan Möbius committed
78
       *
Jan Möbius's avatar
 
Jan Möbius committed
79
80
81
       * 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
82
       *
Jan Möbius's avatar
 
Jan Möbius committed
83
84
       * @param _mode Identifier of Picking mode or "Separator" to add a Separator
      */
Jan Möbius's avatar
 
Jan Möbius committed
85
86
      virtual void addHiddenPickMode( const std::string /*_mode*/ ) {};

Dirk Wilden's avatar
Dirk Wilden committed
87
      /** \brief Set the cursor of the given PickMode
Jan Möbius's avatar
 
Jan Möbius committed
88
       *
Dirk Wilden's avatar
Dirk Wilden committed
89
       * Set the cursor that should be used inside the pickMode
Jan Möbius's avatar
 
Jan Möbius committed
90
       *
Dirk Wilden's avatar
Dirk Wilden committed
91
92
       * @param _mode Identifier of Picking mode
       * @param _cursor the new cursor
Jan Möbius's avatar
 
Jan Möbius committed
93
      */
Dirk Wilden's avatar
Dirk Wilden committed
94
95
96
      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
97
       *
Dirk Wilden's avatar
Dirk Wilden committed
98
99
       * 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
100
       *
Dirk Wilden's avatar
Dirk Wilden committed
101
102
       * @param _mode Identifier of Picking mode
       * @param _mouseTracking new state of mouseTracking
Jan Möbius's avatar
 
Jan Möbius committed
103
      */
Dirk Wilden's avatar
Dirk Wilden committed
104
105
      virtual void setPickModeMouseTracking( const std::string /*_mode*/ , bool /*_mouseTracking*/ ) {};

Jan Möbius's avatar
Dennis:  
Jan Möbius committed
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
      /** \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*/ ) {};

123
124
     
  private slots:
Jan Möbius's avatar
 
Jan Möbius committed
125
      /**  \brief The pickingMode has changed
Jan Möbius's avatar
 
Jan Möbius committed
126
       *
Jan Möbius's avatar
 
Jan Möbius committed
127
128
129
       * 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
130
      virtual void slotPickModeChanged( const std::string& /*_mode*/) {};
Jan Möbius's avatar
 
Jan Möbius committed
131
132
133

   public :

Jan Möbius's avatar
 
Jan Möbius committed
134
135
      /// Destructor
      virtual ~PickingInterface() {};
Jan Möbius's avatar
 
Jan Möbius committed
136

Jan Möbius's avatar
 
Jan Möbius committed
137
138
};

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

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