A plugin with access to physics::Model.
More...
#include <Plugin.hh>
Inherits PluginT< ModelPlugin >.
Inherited by ActorPlugin, ActuatorPlugin, ArduCopterPlugin, AttachLightPlugin, BuoyancyPlugin, CartDemoPlugin, CessnaPlugin, DiffDrivePlugin, ElevatorPlugin, FlashLightPlugin, FollowerPlugin, GimbalSmall2dPlugin, GravityCompensationPlugin, HarnessPlugin, HydraDemoPlugin, InitialVelocityPlugin, JointTrajectoryPlugin, KeysToJointsPlugin, LiftDragPlugin, LinearBatteryConsumerPlugin, LinearBatteryPlugin, LinkPlot3DPlugin, MudPlugin, PlaneDemoPlugin, RandomVelocityPlugin, RegionEventBoxPlugin, SkidSteerDrivePlugin, SphereAtlasDemoPlugin, TouchPlugin, VehiclePlugin, and WheelSlipPlugin.
|
static TPtr | Create (const std::string &_filename, const std::string &_name) |
| a class method that creates a plugin from a file name. More...
|
|
A plugin with access to physics::Model.
See reference.
◆ TPtr
plugin pointer type definition
◆ ModelPlugin()
◆ ~ModelPlugin()
◆ 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()
Override this method for custom plugin initialization behavior.
Reimplemented in BuoyancyPlugin, HarnessPlugin, FollowerPlugin, PlaneDemoPlugin, MudPlugin, CartDemoPlugin, VehiclePlugin, GimbalSmall2dPlugin, LinearBatteryPlugin, DiffDrivePlugin, and SphereAtlasDemoPlugin.
◆ 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] | _model | Pointer to the Model |
[in] | _sdf | Pointer to the SDF element of the plugin. |
Implemented in FlashLightPlugin, KeysToJointsPlugin, WheelSlipPlugin, ActuatorPlugin, LinkPlot3DPlugin, RandomVelocityPlugin, CessnaPlugin, BuoyancyPlugin, HarnessPlugin, TouchPlugin, GravityCompensationPlugin, ElevatorPlugin, ArduCopterPlugin, RegionEventBoxPlugin, FollowerPlugin, AttachLightPlugin, SkidSteerDrivePlugin, LiftDragPlugin, HydraDemoPlugin, PlaneDemoPlugin, CartDemoPlugin, JointTrajectoryPlugin, VehiclePlugin, ActorPlugin, InitialVelocityPlugin, MudPlugin, GimbalSmall2dPlugin, LinearBatteryConsumerPlugin, LinearBatteryPlugin, DiffDrivePlugin, and SphereAtlasDemoPlugin.
◆ Reset()
◆ filename
Path to the shared library file.
◆ handleName
◆ type
The documentation for this class was generated from the following file: