This plugin stored the reflectance map in the parent visual Then we will be able to access this reflectance map from the ogre node to apply this reflectance to the object using this plugin.
More...
#include <ReflectancePlugin.hh>
Inherits VisualPlugin.
|
static TPtr | Create (const std::string &_filename, const std::string &_name) |
| a class method that creates a plugin from a file name. More...
|
|
|
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...
|
|
This plugin stored the reflectance map in the parent visual Then we will be able to access this reflectance map from the ogre node to apply this reflectance to the object using this plugin.
This plugin should have a <reflectance_map> tag. Inside this tag you two options:
- include <name> with the absolute path of your image
- include <name> with the name of the resource and <uri> could be used:
- absolute directory
- model://
The image could be RGB or black and white. It's recommended to use .png files.
◆ TPtr
plugin pointer type definition
◆ ReflectancePlugin()
◆ ~ReflectancePlugin()
◆ Create()
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
◆ GetFilename()
std::string GetFilename |
( |
| ) |
const |
|
inlineinherited |
Get the name of the handler.
◆ GetHandle()
std::string GetHandle |
( |
| ) |
const |
|
inlineinherited |
Get the short name of the handler.
◆ GetType()
Returns the type of the plugin.
- Returns
- type of the plugin
◆ Init()
Initialize the plugin.
Called after Gazebo has been loaded. Must not block.
◆ Load()
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.
◆ LoadParam() [1/2]
void LoadParam |
( |
const sdf::ElementPtr & |
_sdf, |
|
|
const std::string & |
_name, |
|
|
V & |
_target, |
|
|
V |
_defaultValue = V() |
|
) |
| const |
|
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.
- 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. |
◆ LoadParam() [2/2]
void LoadParam |
( |
sdf::ElementPtr & |
_sdf, |
|
|
const std::string & |
_name, |
|
|
std::string & |
_target, |
|
|
const char * |
_defaultValue |
|
) |
| const |
|
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.
- 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. |
◆ Reset()
Override this method for custom plugin reset behavior.
◆ filename
Path to the shared library file.
◆ handleName
◆ type
The documentation for this class was generated from the following file: