A plugin with access to physics::World. More...
#include <common/common.hh>
Inherits PluginT< WorldPlugin >.
Inherited by ArrangePlugin, RazerHydra, RubblePlugin, SimEventsPlugin, TransporterPlugin, and WindPlugin.
Public Types | |
typedef boost::shared_ptr < WorldPlugin > | TPtr |
plugin pointer type definition More... | |
Public Member Functions | |
WorldPlugin () | |
Constructor. More... | |
virtual | ~WorldPlugin () |
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 | Init () |
virtual void | Load (physics::WorldPtr _world, sdf::ElementPtr _sdf)=0 |
Load function. More... | |
virtual void | Reset () |
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... | |
A plugin with access to physics::World.
See reference.
|
inherited |
plugin pointer type definition
|
inline |
Constructor.
References PluginT< WorldPlugin >::type, and gazebo::WORLD_PLUGIN.
|
inlinevirtual |
Destructor.
|
inlinestaticinherited |
a class method that creates a plugin from a file name.
It locates the shared library and loads it dynamically.
[in] | _filename | the path to the shared library. |
[in] | _name | short name of the plugin |
|
inlineinherited |
Get the name of the handler.
|
inlineinherited |
Get the short name of the handler.
|
inlineinherited |
Returns the type of the plugin.
|
inlinevirtual |
Reimplemented in ArrangePlugin, SimEventsPlugin, and RubblePlugin.
|
pure virtual |
Load function.
Called when a Plugin is first created, and after the World has been loaded. This function should not be blocking.
[in] | _world | Pointer the World |
[in] | _sdf | Pointer the the SDF element of the plugin. |
Implemented in TransporterPlugin, WindPlugin, ArrangePlugin, RazerHydra, SimEventsPlugin, and RubblePlugin.
|
inlinevirtual |
Reimplemented in ArrangePlugin.
|
protectedinherited |
Path to the shared library file.
|
protectedinherited |
Short name.
|
protectedinherited |
Type of plugin.
Referenced by WorldPlugin::WorldPlugin().