KeyboardGUIPlugin Class Reference

A GUI plugin that captures key strokes from gzclient GUI and publishes over gz transport topic ~/keyboard/keypress More...

#include <KeyboardGUIPlugin.hh>

Inherits GUIPlugin.

Public Types

typedef boost::shared_ptr< GUIPluginTPtr
 plugin pointer type definition More...
 

Public Member Functions

 KeyboardGUIPlugin ()
 Constructor. More...
 
virtual ~KeyboardGUIPlugin ()
 Destructor. More...
 
std::string GetFilename () const
 Get the name of the handler. More...
 
std::string GetHandle () const
 Get the short name of the handler. More...
 
PluginType GetType () const
 Returns the type of the plugin. More...
 
virtual void Load (sdf::ElementPtr)
 Load function. More...
 
virtual void paintEvent (QPaintEvent *)
 

Static Public Member Functions

static TPtr Create (const std::string &_filename, const std::string &_name)
 a class method that creates a plugin from a file name. More...
 

Protected Member Functions

void OnKeyPress (const gazebo::common::KeyEvent &_event)
 Callback for a key press event. More...
 

Protected Attributes

std::string filename
 Path to the shared library file. More...
 
std::string handleName
 Short name. More...
 
PluginType type
 Type of plugin. More...
 

Detailed Description

A GUI plugin that captures key strokes from gzclient GUI and publishes over gz transport topic ~/keyboard/keypress

Member Typedef Documentation

typedef boost::shared_ptr<GUIPlugin > TPtr
inherited

plugin pointer type definition

Constructor & Destructor Documentation

Constructor.

virtual ~KeyboardGUIPlugin ( )
virtual

Destructor.

Member Function Documentation

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]_filenamethe path to the shared library.
[in]_nameshort name of the plugin
Returns
Shared Pointer to this class type
std::string GetFilename ( ) const
inlineinherited

Get the name of the handler.

std::string GetHandle ( ) const
inlineinherited

Get the short name of the handler.

PluginType GetType ( ) const
inlineinherited

Returns the type of the plugin.

Returns
type of the plugin
virtual void Load ( sdf::ElementPtr  )
inlinevirtualinherited

Load function.

Called when a plugin is first created. This function should not be blocking. This function will be called with an empty sdf element when a GUI plugin is loaded via a gui.ini file or via a command line argument.

Parameters
[in]_sdfPointer the the SDF element of the plugin. This is the plugin SDF, <plugin ...>, and its children. It will be an empty element when loaded from INI file or command line argument.

Reimplemented in TimerGUIPlugin, and LookAtDemoPlugin.

void OnKeyPress ( const gazebo::common::KeyEvent _event)
protected

Callback for a key press event.

Parameters
[in]_eventKey event
virtual void paintEvent ( QPaintEvent *  )
inlinevirtualinherited

Member Data Documentation

std::string filename
protectedinherited

Path to the shared library file.

std::string handleName
protectedinherited

Short name.

PluginType type
protectedinherited

Type of plugin.

Referenced by GUIPlugin::GUIPlugin().


The documentation for this class was generated from the following file: