A plugin loaded within the gzclient on startup. More...
#include <GuiPlugin.hh>
Public Member Functions | |
| GUIPlugin () | |
| virtual void | Load (sdf::ElementPtr) |
| Load function. More... | |
 Public Member Functions inherited from gazebo::PluginT< GUIPlugin > | |
| PluginT () | |
| Constructor. More... | |
| virtual | ~PluginT () |
| 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... | |
Additional Inherited Members | |
| Public Types inherited from gazebo::PluginT< GUIPlugin > | |
| typedef boost::shared_ptr < GUIPlugin > | TPtr |
| plugin pointer type definition More... | |
| Static Public Member Functions inherited from gazebo::PluginT< GUIPlugin > | |
| 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 inherited from gazebo::PluginT< GUIPlugin > | |
| std::string | filename |
| Path to the shared library file. More... | |
| std::string | handleName |
| Short name. More... | |
| PluginType | type |
| Type of plugin. More... | |
A plugin loaded within the gzclient on startup.
|
inline |
References gazebo::GUI_PLUGIN.
|
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.
| [in] | _sdf | Pointer the the SDF element of the plugin. This is the plugin SDF, <plugin ...>, and its children. |
Reimplemented in gazebo::TimerGUIPlugin.