A plugin with access to physics::Model. More...
#include <Plugin.hh>
Public Member Functions | |
| ModelPlugin () | |
| Constructor. More... | |
| virtual | ~ModelPlugin () |
| Destructor. More... | |
| virtual void | Init () |
| Override this method for custom plugin initialization behavior. More... | |
| virtual void | Load (physics::ModelPtr _model, sdf::ElementPtr _sdf)=0 |
| Load function. More... | |
| virtual void | Reset () |
| Override this method for custom plugin reset behavior. More... | |
 Public Member Functions inherited from gazebo::PluginT< ModelPlugin > | |
| 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< ModelPlugin > | |
| typedef boost::shared_ptr < ModelPlugin > | TPtr |
| plugin pointer type definition More... | |
| Static Public Member Functions inherited from gazebo::PluginT< ModelPlugin > | |
| 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< ModelPlugin > | |
| 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::Model.
See reference.
|
inline |
Constructor.
References gazebo::MODEL_PLUGIN.
|
inlinevirtual |
Destructor.
|
inlinevirtual |
Override this method for custom plugin initialization behavior.
Reimplemented in gazebo::BuoyancyPlugin, gazebo::VehiclePlugin, gazebo::MudPlugin, gazebo::CartDemoPlugin, gazebo::SphereAtlasDemoPlugin, and gazebo::DiffDrivePlugin.
|
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] | _model | Pointer to the Model |
| [in] | _sdf | Pointer to the SDF element of the plugin. |
Implemented in gazebo::ActuatorPlugin, gazebo::RandomVelocityPlugin, gazebo::CessnaPlugin, gazebo::BuoyancyPlugin, gazebo::ElevatorPlugin, gazebo::JointTrajectoryPlugin, gazebo::SkidSteerDrivePlugin, gazebo::HydraDemoPlugin, gazebo::LiftDragPlugin, gazebo::VehiclePlugin, gazebo::InitialVelocityPlugin, gazebo::CartDemoPlugin, gazebo::MudPlugin, gazebo::SphereAtlasDemoPlugin, and gazebo::DiffDrivePlugin.
|
inlinevirtual |
Override this method for custom plugin reset behavior.
Reimplemented in gazebo::RandomVelocityPlugin, gazebo::ElevatorPlugin, gazebo::InitialVelocityPlugin, and gazebo::SphereAtlasDemoPlugin.