A model plugin that enables multiple lights in the world to be attached to links within the model. More...
#include <AttachLightPlugin.hh>
Inherits ModelPlugin.
Public Types | |
| typedef boost::shared_ptr < ModelPlugin > | TPtr |
| plugin pointer type definition More... | |
Public Member Functions | |
| AttachLightPlugin () | |
| Constructor. 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 () |
| Override this method for custom plugin initialization behavior. More... | |
| virtual void | Load (physics::ModelPtr _model, sdf::ElementPtr _sdf) |
| Load function. More... | |
| void | OnRequest (ConstRequestPtr &_msg) |
| Request callback for handling deletion events. 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... | |
A model plugin that enables multiple lights in the world to be attached to links within the model.
The plugin has the following SDF description: <link> SDF element. More than one <link> can be defined. <link_name> Name of the link in the model. <light> SDF element. More than one <light> can be attached. <pose> Offset pose of the light in the link frame. <light_name> Name of the light in the world.
|
inherited |
plugin pointer type definition
Constructor.
|
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 |
References PluginT< T >::filename, gzerr, and SingletonT< SystemPaths >::Instance().
|
inlineinherited |
Get the name of the handler.
References PluginT< T >::filename.
|
inlineinherited |
Get the short name of the handler.
References PluginT< T >::handleName.
|
inlineinherited |
|
inlinevirtualinherited |
Override this method for custom plugin initialization behavior.
Reimplemented in BuoyancyPlugin, HarnessPlugin, FollowerPlugin, PlaneDemoPlugin, MudPlugin, CartDemoPlugin, VehiclePlugin, GimbalSmall2dPlugin, LinearBatteryPlugin, DiffDrivePlugin, and SphereAtlasDemoPlugin.
|
virtual |
Load function.
Called when a Plugin is first created, and after the World has been loaded. This function should not be blocking.
| [in] | _model | Pointer to the Model |
| [in] | _sdf | Pointer to the SDF element of the plugin. |
Implements ModelPlugin.
| void OnRequest | ( | ConstRequestPtr & | _msg | ) |
Request callback for handling deletion events.
| [in] | _msg | The message data. |
|
inlinevirtualinherited |
Override this method for custom plugin reset behavior.
Reimplemented in RandomVelocityPlugin, ElevatorPlugin, FollowerPlugin, LinearBatteryPlugin, ActorPlugin, InitialVelocityPlugin, and SphereAtlasDemoPlugin.
|
protectedinherited |
Path to the shared library file.
|
protectedinherited |
Short name.
|
protectedinherited |
Type of plugin.
Referenced by ModelPlugin::ModelPlugin().