A plugin that fires an event when another model enters the region defined by the size of this model's box visual. More...
#include <RegionEventBoxPlugin.hh>
Public Member Functions | |
| RegionEventBoxPlugin () | |
| Constructor. More... | |
| void | Load (physics::ModelPtr _parent, sdf::ElementPtr _sdf) |
| Load function. More... | |
| void | OnModelMsg (ConstModelPtr &_msg) |
| Callback when a model message is received. More... | |
| void | OnUpdate (const common::UpdateInfo &_info) |
| Updates the box event plugin at every physics iteration. More... | |
 Public Member Functions inherited from gazebo::ModelPlugin | |
| ModelPlugin () | |
| Constructor. More... | |
| virtual | ~ModelPlugin () |
| Destructor. More... | |
| virtual void | Init () |
| Override this method for custom plugin initialization behavior. More... | |
| virtual void | Reset () |
| Override this method for custom plugin reset behavior. More... | |
| Public Member Functions inherited from gazebo::PluginT< ModelPlugin > | |
| PluginT () | |
| Constructor. More... | |
| virtual | ~PluginT () |
| 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... | |
Public Attributes | |
| transport::NodePtr | node |
| Transport node pointer. More... | |
| std::mutex | receiveMutex |
| Mutex to protect incoming messages. More... | |
Additional Inherited Members | |
| Public Types inherited from gazebo::PluginT< ModelPlugin > | |
| typedef boost::shared_ptr < ModelPlugin > | TPtr |
| plugin pointer type definition More... | |
| Static Public Member Functions inherited from gazebo::PluginT< ModelPlugin > | |
| 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 inherited from gazebo::PluginT< ModelPlugin > | |
| 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 fires an event when another model enters the region defined by the size of this model's box visual.
/// <plugin filename="libRegionEventBoxPlugin.so" name="region_event_box"> /// <event> /// <name>model_in_region_event_box</name> /// <type>inclusion</type> /// <active>true</active> /// </event> /// </plugin> ///
| gazebo::RegionEventBoxPlugin::RegionEventBoxPlugin | ( | ) |
Constructor.
|
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 gazebo::ModelPlugin.
| void gazebo::RegionEventBoxPlugin::OnModelMsg | ( | ConstModelPtr & | _msg | ) |
Callback when a model message is received.
| [in] | _msg | model msg |
| void gazebo::RegionEventBoxPlugin::OnUpdate | ( | const common::UpdateInfo & | _info | ) |
Updates the box event plugin at every physics iteration.
| [in] | _info | Update info |
| transport::NodePtr gazebo::RegionEventBoxPlugin::node |
Transport node pointer.
| std::mutex gazebo::RegionEventBoxPlugin::receiveMutex |
Mutex to protect incoming messages.