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

A plugin loaded within the gzserver on startup. More...

#include <Plugin.hh>

Inheritance diagram for gazebo::VisualPlugin:
Inheritance graph
[legend]
Collaboration diagram for gazebo::VisualPlugin:
Collaboration graph
[legend]

Public Member Functions

 VisualPlugin ()
 
virtual void Init ()
 Initialize the plugin. More...
 
virtual void Load (rendering::VisualPtr _visual, 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< VisualPlugin >
 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< VisualPlugin >
typedef boost::shared_ptr
< VisualPlugin
TPtr
 plugin pointer type definition More...
 
- Static Public Member Functions inherited from gazebo::PluginT< VisualPlugin >
static TPtr Create (const std::string &_filename, const std::string &_handle)
 a class method that creates a plugin from a file name. More...
 
- Protected Attributes inherited from gazebo::PluginT< VisualPlugin >
std::string filename
 Path to the shared library file. More...
 
std::string handle
 Short name. More...
 
PluginType type
 Type of plugin. More...
 

Detailed Description

A plugin loaded within the gzserver on startup.

See reference.

Constructor & Destructor Documentation

gazebo::VisualPlugin::VisualPlugin ( )
inline

References gazebo::VISUAL_PLUGIN.

Member Function Documentation

virtual void gazebo::VisualPlugin::Init ( )
inlinevirtual

Initialize the plugin.

Called after Gazebo has been loaded. Must not block.

virtual void gazebo::VisualPlugin::Load ( rendering::VisualPtr  _visual,
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]_visualPointer the Visual Object.
[in]_sdfPointer the the SDF element of the plugin.
virtual void gazebo::VisualPlugin::Reset ( )
inlinevirtual

Override this method for custom plugin reset behavior.


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