KeyInterface.hh 7.39 KB
Newer Older
1
/*===========================================================================*\
Jan Möbius's avatar
Jan Möbius committed
2
3
*                                                                            *
*                              OpenFlipper                                   *
Martin Schultz's avatar
Martin Schultz committed
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
 *           Copyright (c) 2001-2015, RWTH-Aachen University                 *
 *           Department of Computer Graphics and Multimedia                  *
 *                          All rights reserved.                             *
 *                            www.openflipper.org                            *
 *                                                                           *
 *---------------------------------------------------------------------------*
 * This file is part of OpenFlipper.                                         *
 *---------------------------------------------------------------------------*
 *                                                                           *
 * Redistribution and use in source and binary forms, with or without        *
 * modification, are permitted provided that the following conditions        *
 * are met:                                                                  *
 *                                                                           *
 * 1. Redistributions of source code must retain the above copyright notice, *
 *    this list of conditions and the following disclaimer.                  *
 *                                                                           *
 * 2. Redistributions in binary form must reproduce the above copyright      *
 *    notice, this list of conditions and the following disclaimer in the    *
 *    documentation and/or other materials provided with the distribution.   *
 *                                                                           *
 * 3. Neither the name of the copyright holder nor the names of its          *
 *    contributors may be used to endorse or promote products derived from   *
 *    this software without specific prior written permission.               *
 *                                                                           *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS       *
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED *
 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A           *
 * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER *
 * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,  *
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,       *
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR        *
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF    *
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING      *
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS        *
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.              *
Jan Möbius's avatar
Jan Möbius committed
39
*                                                                            *
40
41
42
\*===========================================================================*/

/*===========================================================================*\
Jan Möbius's avatar
Jan Möbius committed
43
44
45
46
47
*                                                                            *
*   $Revision$                                                       *
*   $LastChangedBy$                                                *
*   $Date$                     *
*                                                                            *
48
\*===========================================================================*/
Jan Möbius's avatar
 
Jan Möbius committed
49
50
51
52
53


#ifndef KEYINTERFACE_HH 
#define KEYINTERFACE_HH 

Matthias Möller's avatar
Matthias Möller committed
54
55
56

  #include <QtWidgets>

Jan Möbius's avatar
 
Jan Möbius committed
57
 
Jan Möbius's avatar
Jan Möbius committed
58
59
60
61
62
63
64
65
66
67
68
69
70
71


/** \file KeyInterface.hh
*
* Interface for receiving keyboard events inside your plugin.\ref keyInterfacePage
*/

/** \brief Keyboard Event Interface
 *
 * \ref keyInterfacePage "Detailed description"
 * \n
 *
 * Using this interface you can react on key events.
 */
Jan Möbius's avatar
 
Jan Möbius committed
72
class KeyInterface {
Dirk Wilden's avatar
Dirk Wilden committed
73
74
75
76
77
78
79
80
   signals:
      /**  \brief Register a key-combination for your plugin
       * 
       * To obtain key events from the viewer for a certain key-combination, you have
       * to register that combination first
       *
       * @param _key the key that should be registered
       * @param _modifiers the keyboard modifiers
Jan Möbius's avatar
Typos    
Jan Möbius committed
81
82
       * @param _description a short description about the functionality (Will be used in the Options Widget)
       * @param _multiUse can the key additionally be registered by another plugin (You could make a key exclusive by this)
Dirk Wilden's avatar
Dirk Wilden committed
83
       */
Jan Möbius's avatar
Jan Möbius committed
84
      virtual void registerKey(int _key, Qt::KeyboardModifiers _modifiers, QString _description, bool _multiUse = false) {};
Dirk Wilden's avatar
Dirk Wilden committed
85
86

   public slots :
Jan Möbius's avatar
 
Jan Möbius committed
87
88
89
      
      /**  \brief Key Event from Main App
       * 
Jan Möbius's avatar
Typos    
Jan Möbius committed
90
91
       * This slot is called if a key event occurred in the Viewer
       * @param _event Key event
Jan Möbius's avatar
 
Jan Möbius committed
92
      */
Jan Möbius's avatar
Jan Möbius committed
93
      virtual void slotKeyEvent( QKeyEvent* _event ) {};
Jan Möbius's avatar
 
Jan Möbius committed
94
95
96
      
      /**  \brief Key Release Event from Main App
       * 
Jan Möbius's avatar
Typos    
Jan Möbius committed
97
98
       * This slot is called if a key release event occurred in the Viewer
       * @param _event Key event
Jan Möbius's avatar
 
Jan Möbius committed
99
      */
Jan Möbius's avatar
Jan Möbius committed
100
      virtual void slotKeyReleaseEvent( QKeyEvent* _event ) {};
Jan Möbius's avatar
 
Jan Möbius committed
101
102
103
104
105
106
107
108
      
   public : 
       
      /// Destructor
      virtual ~KeyInterface() {};
      
};

Jan Möbius's avatar
Jan Möbius committed
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180

/** \page keyInterfacePage Key Interface
\image html keyInterface.png
\n

Using this interface you can react on key events. You first have to register
a key (or key combination) with KeyInterface::registerKey().
Note that the log widget will contain a warning if you register
a key twice or it is occupied by another plugin.

For each registered key your KeyInterface::slotKeyEvent() will be triggered when
the key was pressed and the slot KeyInterface::slotKeyReleaseEvent() when the key
was released. Both slots get the QKeyEvent and will contain all the modifiers
that were active when the event occurred.

In OpenFlippers options tab you can view all registered keys and reassign them.
The events will be mapped, such that the plugins still receive the right combination.
Therefore the mapping will be completely invisible to them.

See our tutorial \ref ex3 for an example of how to use mouse and keyboard events
within a plugin.

To use the KeyInterface:
<ul>
<li> include KeyInterface.hh in your plugins header file
<li> derive your plugin from the class KeyInterface
<li> add Q_INTERFACES(KeyInterface) to your plugin class
<li> Implement the required functions.
</ul>

\code

// In your plugin initialization register the keys you want to get.
void ExamplePlugin::initializePlugin() {

  // Register keys
  emit registerKey(Qt::Key_W,     Qt::NoModifier, "Rotate object down");
  emit registerKey(Qt::Key_A,     Qt::NoModifier, "Rotate object left");
  emit registerKey(Qt::Key_D,     Qt::NoModifier, "Rotate object right");
  emit registerKey(Qt::Key_S,     Qt::NoModifier, "Rotate object up");

}

// Called when one of the registered Keys is pressed.
void MouseAndKeyPlugin::slotKeyEvent( QKeyEvent* _event ) {

  // Check if it's really the right key
  if ( _event->modifiers() == Qt::NoModifier ) {

    // Switch pressed keys
    switch (_event->key()) {
      case Qt::Key_W:
        // Move forward
        break;
      case Qt::Key_A:
        // Move left
        break;
      case Qt::Key_D:
        // Move right
        break;
      case Qt::Key_S:
        // Move backward
        break;
      default:
        break;
    }

  }
}
\endcode
*/

Dirk Wilden's avatar
Dirk Wilden committed
181
Q_DECLARE_INTERFACE(KeyInterface,"OpenFlipper.KeyInterface/1.1")
Jan Möbius's avatar
 
Jan Möbius committed
182
183
      
#endif // KEYINTERFACE_HH