The JoyPlugin connects to a joystick or gamepad, and transmits data from the joystick over an Ignition Transport topic. More...
#include <JoyPlugin.hh>
Inherits WorldPlugin.
Public Types | |
typedef boost::shared_ptr< WorldPlugin > | TPtr |
plugin pointer type definition More... | |
Public Member Functions | |
JoyPlugin () | |
Constructor. More... | |
virtual | ~JoyPlugin () |
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 () |
void | Load (physics::WorldPtr _world, sdf::ElementPtr _sdf) override |
Load function. More... | |
virtual void | Reset () |
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... | |
The JoyPlugin connects to a joystick or gamepad, and transmits data from the joystick over an Ignition Transport topic.
The default topic name is /joy, and the message type is ignition.msgs.Joy.
Another plugin or application can listen to the joystick messages, and then take actions based on the data.
Echo the joy data to a terminal: ign topic -e -t /joy
Note: You will need ign-tools
The plugin is loaded via a world plugin. In SDF this looks like:
See worlds/joy_demo.world for an example.
Options that can be specified in the plugin include:
|
inherited |
plugin pointer type definition
JoyPlugin | ( | ) |
Constructor.
|
virtual |
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 |
Reimplemented in StaticMapPlugin, ArrangePlugin, SimEventsPlugin, and RubblePlugin.
|
overridevirtual |
Load function.
Called when a Plugin is first created, and after the World has been loaded. This function should not be blocking.
[in] | _world | Pointer the World |
[in] | _sdf | Pointer the the SDF element of the plugin. |
Implements WorldPlugin.
|
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 |
Reimplemented in ArrangePlugin.
|
protectedinherited |
Path to the shared library file.
|
protectedinherited |
Short name.
|
protectedinherited |
Type of plugin.