BlinkVisualPlugin Class Reference

Plugin that makes a visual blink between two colors. More...

#include <BlinkVisualPlugin.hh>

Inherits VisualPlugin.

Public Types
typedef boost::shared_ptr < VisualPlugin >	TPtr
	plugin pointer type definition More...

Public Member Functions
	BlinkVisualPlugin ()
	Constructor. More...
	~BlinkVisualPlugin ()
	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...
virtual void	Init ()
	Initialize the plugin. More...
virtual void	Load (rendering::VisualPtr _visual, sdf::ElementPtr _sdf)
	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

Plugin that makes a visual blink between two colors.

See the example usage below:

///    <plugin name="blink" filename="libBlinkVisualPlugin.so">
///
///      <!-- First RGBA color, each number from 0 to 1. Defaults to red. -->
///      <color_a>1 0 0 1</color_a>
///
///      <!-- Second RGBA color. Defaults to black. -->
///      <color_a>0 0 0 1</color_a>
///
///      <!-- Period in seconds. Defaults to 1 s. -->
///      <period>1</period>
///
///      <!-- True to use wall time, false to use sim time.
///           Defaults to false. -->
///      <use_wall_time>true</use_wall_time>
///
///    </plugin>
/// 

See worlds/blink_visual.world for a complete example.  

Member Typedef Documentation

typedef boost::shared_ptr<VisualPlugin > TPtr

inherited

plugin pointer type definition

Constructor & Destructor Documentation

BlinkVisualPlugin

(

)

Constructor.

~BlinkVisualPlugin

(

)

Destructor.

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]	_filename	the path to the shared library.
[in]	_name	short 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 ( )

inlinevirtualinherited

Initialize the plugin.

Called after Gazebo has been loaded. Must not block.

virtual void Load ( rendering::VisualPtr  _visual, sdf::ElementPtr  _sdf  )

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]	_visual	Pointer the Visual Object.
[in]	_sdf	Pointer the the SDF element of the plugin.

Implements VisualPlugin.

virtual void Reset ( )

inlinevirtualinherited

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.

Referenced by VisualPlugin::VisualPlugin().

---

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

• BlinkVisualPlugin.hh