A plugin with access to physics::World. More...
#include <common/common.hh>
Public Member Functions | |
| WorldPlugin () | |
| Constructor. More... | |
| virtual | ~WorldPlugin () |
| Destructor. More... | |
| virtual void | Init () |
| virtual void | Load (physics::WorldPtr _world, sdf::ElementPtr _sdf)=0 |
| Load function. More... | |
| virtual void | Reset () |
 Public Member Functions inherited from gazebo::PluginT< WorldPlugin > | |
| 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< WorldPlugin > | |
| typedef boost::shared_ptr < WorldPlugin > | TPtr |
| plugin pointer type definition More... | |
| Static Public Member Functions inherited from gazebo::PluginT< WorldPlugin > | |
| 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< WorldPlugin > | |
| 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.
|
inline |
Constructor.
References gazebo::PluginT< WorldPlugin >::type, and gazebo::WORLD_PLUGIN.
|
inlinevirtual |
Destructor.
|
inlinevirtual |
Reimplemented in gazebo::ArrangePlugin, gazebo::SimEventsPlugin, and gazebo::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 gazebo::TransporterPlugin, gazebo::ArrangePlugin, gazebo::SimEventsPlugin, gazebo::RubblePlugin, and gazebo::RazerHydra.
|
inlinevirtual |
Reimplemented in gazebo::ArrangePlugin.