KeyboardGUIPlugin.hh
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2016 Open Source Robotics Foundation
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  *
16 */
17 #ifndef GAZEBO_PLUGINS_KEYBOARDGUIPLUGIN_HH_
18 #define GAZEBO_PLUGINS_KEYBOARDGUIPLUGIN_HH_
19 
20 #include <memory>
22 #include <gazebo/gui/GuiPlugin.hh>
23 
24 namespace gazebo
25 {
26  // Forward declare private data class
27  class KeyboardGUIPluginPrivate;
28 
31  class GZ_PLUGIN_VISIBLE KeyboardGUIPlugin : public GUIPlugin
32  {
33  Q_OBJECT
34 
36  public: KeyboardGUIPlugin();
37 
39  public: virtual ~KeyboardGUIPlugin();
40 
43  protected: void OnKeyPress(const gazebo::common::KeyEvent &_event);
44 
49  private: bool eventFilter(QObject *_obj, QEvent *_event);
50 
53  private: std::unique_ptr<KeyboardGUIPluginPrivate> dataPtr;
54  };
55 }
56 
57 #endif
Forward declarations for the common classes.
Definition: Animation.hh:26
A plugin loaded within the gzclient on startup.
Definition: GuiPlugin.hh:26
Generic description of a keyboard event.
Definition: KeyEvent.hh:32
A GUI plugin that captures key strokes from gzclient GUI and publishes over gz transport topic ~/keyb...
Definition: KeyboardGUIPlugin.hh:31