A plugin with access to physics::Model. More...

#include <Plugin.hh>

Inheritance diagram for gazebo::ModelPlugin:

Public Member Functions
	ModelPlugin ()
	Constructor.
virtual	~ModelPlugin ()
	Destructor.
virtual void	Init ()
	Override this method for custom plugin initialization behavior.
virtual void	Load (physics::ModelPtr _model, sdf::ElementPtr _sdf)=0
	Load function.
virtual void	Reset ()
	Override this method for custom plugin reset behavior.
Public Member Functions inherited from gazebo::PluginT< ModelPlugin >
std::string	GetFilename () const
	Get the name of the handler.
std::string	GetHandle () const
	Get the short name of the handler.
PluginType	GetType () const
	Returns the type of the plugin.

Additional Inherited Members
Public Types inherited from gazebo::PluginT< ModelPlugin >
typedef boost::shared_ptr < ModelPlugin >	TPtr
	plugin pointer type definition
Static Public Member Functions inherited from gazebo::PluginT< ModelPlugin >
static TPtr	Create (const std::string &_filename, const std::string &_handle)
	a class method that creates a plugin from a file name.
Protected Attributes inherited from gazebo::PluginT< ModelPlugin >
std::string	filename
	Path to the shared library file.
std::string	handle
	Short name.
PluginType	type
	Type of plugin.

Detailed Description

A plugin with access to physics::Model.

Constructor & Destructor Documentation

gazebo::ModelPlugin::ModelPlugin ( )

inline

Constructor.

virtual gazebo::ModelPlugin::~ModelPlugin ( )

inlinevirtual

Destructor.

virtual void gazebo::ModelPlugin::Init ( )

inlinevirtual

Override this method for custom plugin initialization behavior.

virtual void gazebo::ModelPlugin::Load	(	physics::ModelPtr	_model,
		sdf::ElementPtr	_sdf
	)

pure virtual

Load function.

Called when a Plugin is first created, and after the World has been loaded. This function should not be blocking.

Parameters

[in]	_model	Pointer to the Model
[in]	_sdf	Pointer to the SDF element of the plugin.

virtual void gazebo::ModelPlugin::Reset ( )

inlinevirtual

Override this method for custom plugin reset behavior.

The documentation for this class was generated from the following file: