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< GUIPlugin >	TPtr
	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	LoadParam (const sdf::ElementPtr &_sdf, const std::string &_name, V &_target, V _defaultValue=V()) const
	Load parameter value from _sdf and store it to the given reference, using the supplied default value if the element in _sdf is not found. More...
void	LoadParam (sdf::ElementPtr &_sdf, const std::string &_name, std::string &_target, const char *_defaultValue) const
	Load parameter value from _sdf and store it to the given reference, using the supplied default value if the element in _sdf is not found. More...
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

TPtr

typedef boost::shared_ptr<GUIPlugin > TPtr

inherited

plugin pointer type definition

Constructor & Destructor Documentation

KeyboardGUIPlugin()

KeyboardGUIPlugin

(

)

Constructor.

~KeyboardGUIPlugin()

virtual ~KeyboardGUIPlugin ( )

virtual

Destructor.

Member Function Documentation

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()

PluginType GetType ( ) const

inlineinherited

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 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]

_sdf

Pointer 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.

LoadParam() [1/2]

void LoadParam ( const sdf::ElementPtr &  _sdf, const std::string &  _name, V &  _target, V  _defaultValue = V()  ) const

inlineprotectedinherited

Load parameter value from _sdf and store it to the given reference, using the supplied default value if the element in _sdf is not found.

A message is written using gzmsg reporting whether the default value was used or not.

Parameters

[in]	_sdf	The SDF element of the plugin.
[in]	_name	Name of a tag inside the SDF.
[out]	_target	The reference to store the param value to.
[in]	_defaultValue	The default value.

LoadParam() [2/2]

void LoadParam ( sdf::ElementPtr &  _sdf, const std::string &  _name, std::string &  _target, const char *  _defaultValue  ) const

inlineprotectedinherited

Load parameter value from _sdf and store it to the given reference, using the supplied default value if the element in _sdf is not found.

A message is written using gzmsg reporting whether the default value was used or not. String specialization to allow accepting const char* values for std::string parameters.

Parameters

[in]	_sdf	The SDF element of the plugin.
[in]	_name	Name of a tag inside the SDF.
[out]	_target	The reference to store the param value to.
[in]	_defaultValue	The default value.

OnKeyPress()

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

protected

Callback for a key press event.

Parameters

[in]

_event

Key event

paintEvent()

virtual void paintEvent ( QPaintEvent *  )

inlinevirtualinherited

Member Data Documentation

filename

std::string filename

protectedinherited

Path to the shared library file.

handleName

std::string handleName

protectedinherited

Short name.

type

PluginType type

protectedinherited

Type of plugin.

Referenced by GUIPlugin::GUIPlugin().

---

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

• KeyboardGUIPlugin.hh