Ignition Gazebo

API Reference

6.7.0
VisualizeContacts Class Reference

Visualize the contacts returned by the Physics plugin. Use the checkbox to turn visualization on or off and spin boxes to change the size of the markers. More...

#include <VisualizeContacts.hh>

Public Slots

void OnVisualize (bool _checked)
 Callback when checkbox state is changed. More...
 
void UpdatePeriod (double _period)
 Update the update period of the markers. More...
 
void UpdateRadius (double _radius)
 Update the radius of the contact. More...
 

Public Member Functions

 VisualizeContacts ()
 Constructor. More...
 
 ~VisualizeContacts () override
 Destructor. More...
 
void LoadConfig (const tinyxml2::XMLElement *_pluginElem) override
 
void Update (const UpdateInfo &_info, EntityComponentManager &_ecm) override
 Update callback called every time the system is stepped. This is called at an Ignition transport thread, so any interaction with Qt should be done through signals and slots. More...
 

Detailed Description

Visualize the contacts returned by the Physics plugin. Use the checkbox to turn visualization on or off and spin boxes to change the size of the markers.

Constructor & Destructor Documentation

◆ VisualizeContacts()

Constructor.

◆ ~VisualizeContacts()

~VisualizeContacts ( )
override

Destructor.

Member Function Documentation

◆ LoadConfig()

void LoadConfig ( const tinyxml2::XMLElement *  _pluginElem)
override

◆ OnVisualize

void OnVisualize ( bool  _checked)
slot

Callback when checkbox state is changed.

Parameters
[in]_checkedindicates show or hide contacts

◆ Update()

void Update ( const UpdateInfo _info,
EntityComponentManager _ecm 
)
overridevirtual

Update callback called every time the system is stepped. This is called at an Ignition transport thread, so any interaction with Qt should be done through signals and slots.

Parameters
[in]_infoCurrent simulation information, such as time.
[in]_ecmMutable reference to the ECM, so the system can read and write entities and their components.

Reimplemented from GuiSystem.

◆ UpdatePeriod

void UpdatePeriod ( double  _period)
slot

Update the update period of the markers.

Parameters
[in]_periodnew update period

◆ UpdateRadius

void UpdateRadius ( double  _radius)
slot

Update the radius of the contact.

Parameters
[in]_radiusnew radius of the contact

The documentation for this class was generated from the following file: