All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | List of all members
gazebo::WorldPlugin Class Reference

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

#include <common/common.hh>

Inheritance diagram for gazebo::WorldPlugin:
Inheritance graph

Public Member Functions

 WorldPlugin ()
virtual ~WorldPlugin ()
virtual void Init ()
virtual void Load (physics::WorldPtr _world, sdf::ElementPtr _sdf)=0
 Load function.
virtual void Reset ()
- Public Member Functions inherited from gazebo::PluginT< WorldPlugin >
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< WorldPlugin >
typedef boost::shared_ptr
< WorldPlugin
 plugin pointer type definition
- Static Public Member Functions inherited from gazebo::PluginT< WorldPlugin >
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< WorldPlugin >
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::World.

See reference.

Constructor & Destructor Documentation

gazebo::WorldPlugin::WorldPlugin ( )
virtual gazebo::WorldPlugin::~WorldPlugin ( )


Member Function Documentation

virtual void gazebo::WorldPlugin::Init ( )
virtual void gazebo::WorldPlugin::Load ( physics::WorldPtr  _world,
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.

[in]_worldPointer the World
[in]_sdfPointer the the SDF element of the plugin.
virtual void gazebo::WorldPlugin::Reset ( )

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