VisualPlugin Class Referenceabstract

A plugin with access to rendering::Visual. More...

#include <Plugin.hh>

Inherits PluginT< VisualPlugin >.

Inherited by BlinkVisualPlugin.

Public Types

typedef boost::shared_ptr< VisualPluginTPtr
 plugin pointer type definition More...
 

Public Member Functions

 VisualPlugin ()
 
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...
 
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...
 

Static Public Member Functions

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

std::string filename
 Path to the shared library file. More...
 
std::string handleName
 Short name. More...
 
PluginType type
 Type of plugin. More...
 

Detailed Description

A plugin with access to rendering::Visual.

See reference.

Member Typedef Documentation

typedef boost::shared_ptr<VisualPlugin > TPtr
inherited

plugin pointer type definition

Constructor & Destructor Documentation

Member Function Documentation

static TPtr Create ( const std::string &  _filename,
const std::string &  _name 
)
inlinestaticinherited

a class method that creates a plugin from a file name.

It locates the shared library and loads it dynamically.

Parameters
[in]_filenamethe path to the shared library.
[in]_nameshort name of the plugin
Returns
Shared Pointer to this class type
std::string GetFilename ( ) const
inlineinherited

Get the name of the handler.

std::string GetHandle ( ) const
inlineinherited

Get the short name of the handler.

PluginType GetType ( ) const
inlineinherited

Returns the type of the plugin.

Returns
type of the plugin
virtual void Init ( )
inlinevirtual

Initialize the plugin.

Called after Gazebo has been loaded. Must not block.

virtual void 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.

Implemented in BlinkVisualPlugin.

virtual void Reset ( )
inlinevirtual

Override this method for custom plugin reset behavior.

Member Data Documentation

std::string filename
protectedinherited

Path to the shared library file.

std::string handleName
protectedinherited

Short name.

PluginType type
protectedinherited

Type of plugin.


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