A plugin that demonstrates how to set shader parameters of a material used by a visual. More...
#include <ShaderParamVisualPlugin.hh>
Inherits VisualPlugin.
Public Types | |
typedef boost::shared_ptr< VisualPlugin > | TPtr |
plugin pointer type definition More... | |
Public Member Functions | |
ShaderParamVisualPlugin () | |
Constructor. More... | |
~ShaderParamVisualPlugin () | |
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 Member Functions | |
void | LoadParam (const sdf::ElementPtr &_sdf, const std::string &_name, V &_target, V _defaultValue=V()) const |
Load parameter value from _sdf and store it to the given reference, using the supplied default value if the element in _sdf is not found. More... | |
void | LoadParam (sdf::ElementPtr &_sdf, const std::string &_name, std::string &_target, const char *_defaultValue) const |
Load parameter value from _sdf and store it to the given reference, using the supplied default value if the element in _sdf is not found. 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... | |
A plugin that demonstrates how to set shader parameters of a material used by a visual.
Plugin parameters:
Shader parameter - can be repeated within plugin SDF element <name> Name of uniform bound to the shader <type> Type of shader, i.e. vertex, fragment
Value to set the shader parameter to. The value string can be an int, float, or a space delimited array of floats. It can also be 'TIME', in which case the value will be bound to sim time.
Example usage:
/// <plugin name="shader_param" filename="libShaderParamVisualPlugin.so"> /// /// <!-- Sets a fragment shader uniform name "ambient" to color red --> /// <param> /// <name>ambient</name> /// <type>fragment</name> /// <value>1.0 0.0 0.0 1.0</value> /// </param> /// </plugin> ///
|
inherited |
plugin pointer type definition
Constructor.
Destructor.
|
inlinestaticinherited |
a class method that creates a plugin from a file name.
It locates the shared library and loads it dynamically.
[in] | _filename | the path to the shared library. |
[in] | _name | short name of the plugin |
|
inlineinherited |
Get the name of the handler.
|
inlineinherited |
Get the short name of the handler.
|
inlineinherited |
Returns the type of the plugin.
|
inlinevirtualinherited |
Initialize the plugin.
Called after Gazebo has been loaded. Must not block.
|
virtual |
Load function.
Called when a Plugin is first created, and after the World has been loaded. This function should not be blocking.
[in] | _visual | Pointer the Visual Object. |
[in] | _sdf | Pointer the the SDF element of the plugin. |
Implements VisualPlugin.
|
inlineprotectedinherited |
Load parameter value from _sdf and store it to the given reference, using the supplied default value if the element in _sdf is not found.
A message is written using gzmsg reporting whether the default value was used or not.
[in] | _sdf | The SDF element of the plugin. |
[in] | _name | Name of a tag inside the SDF. |
[out] | _target | The reference to store the param value to. |
[in] | _defaultValue | The default value. |
|
inlineprotectedinherited |
Load parameter value from _sdf and store it to the given reference, using the supplied default value if the element in _sdf is not found.
A message is written using gzmsg reporting whether the default value was used or not. String specialization to allow accepting const char* values for std::string parameters.
[in] | _sdf | The SDF element of the plugin. |
[in] | _name | Name of a tag inside the SDF. |
[out] | _target | The reference to store the param value to. |
[in] | _defaultValue | The default value. |
|
inlinevirtualinherited |
Override this method for custom plugin reset behavior.
|
protectedinherited |
Path to the shared library file.
|
protectedinherited |
Short name.
|
protectedinherited |
Type of plugin.