A GUI plugin that captures key strokes from gzclient GUI and publishes over gz transport topic ~/keyboard/keypress
More...
#include <KeyboardGUIPlugin.hh>
Inherits GUIPlugin.
|
static TPtr | Create (const std::string &_filename, const std::string &_name) |
| a class method that creates a plugin from a file name. More...
|
|
A GUI plugin that captures key strokes from gzclient GUI and publishes over gz transport topic ~/keyboard/keypress
◆ TPtr
plugin pointer type definition
◆ KeyboardGUIPlugin()
◆ ~KeyboardGUIPlugin()
◆ Create()
static TPtr Create |
( |
const std::string & |
_filename, |
|
|
const std::string & |
_name |
|
) |
| |
|
inlinestaticinherited |
a class method that creates a plugin from a file name.
It locates the shared library and loads it dynamically.
- Parameters
-
[in] | _filename | the path to the shared library. |
[in] | _name | short name of the plugin |
- Returns
- Shared Pointer to this class type
◆ GetFilename()
std::string GetFilename |
( |
| ) |
const |
|
inlineinherited |
Get the name of the handler.
◆ GetHandle()
std::string GetHandle |
( |
| ) |
const |
|
inlineinherited |
Get the short name of the handler.
◆ GetType()
Returns the type of the plugin.
- Returns
- type of the plugin
◆ Load()
virtual void Load |
( |
sdf::ElementPtr |
| ) |
|
|
inlinevirtualinherited |
Load function.
Called when a plugin is first created. This function should not be blocking. This function is only called when a GUI plugin is loaded from an SDF file. This function is not called when a GUI plugin is loaded via a gui.ini file.
- Parameters
-
[in] | _sdf | Pointer the the SDF element of the plugin. This is the plugin SDF, <plugin ...>, and its children. |
Reimplemented in TimerGUIPlugin, and LookAtDemoPlugin.
◆ OnKeyPress()
Callback for a key press event.
- Parameters
-
◆ filename
Path to the shared library file.
◆ handleName
◆ type
The documentation for this class was generated from the following file: