GUIPlugin Class Reference

A plugin loaded within the gzclient on startup. More...

#include <GuiPlugin.hh>

Inherits QWidget, and PluginT< GUIPlugin >.

Inherited by CessnaGUIPlugin, and TimerGUIPlugin.

Public Types
typedef boost::shared_ptr < GUIPlugin >	TPtr
	plugin pointer type definition More...

Public Member Functions
	GUIPlugin ()
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...

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 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 plugin loaded within the gzclient on startup.

Member Typedef Documentation

typedef boost::shared_ptr<GUIPlugin > TPtr

inherited

plugin pointer type definition

Constructor & Destructor Documentation

GUIPlugin ( )

inline

References gazebo::GUI_PLUGIN, and PluginT< GUIPlugin >::type.

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]	_filename	the path to the shared library.
[in]	_name	short 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  )

inlinevirtual

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.

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:

• GuiPlugin.hh