Gazebo Sim

API Reference

9.0.0
EnvironmentVisualization Class Reference

A GUI plugin for a user to load an Environment component into the ECM on a live simulation. More...

#include <EnvironmentVisualization.hh>

Public Member Functions

 EnvironmentVisualization ()
 Constructor.
 
 ~EnvironmentVisualization () override
 Destructor.
 
void LoadConfig (const tinyxml2::XMLElement *_pluginElem) override
 
Q_INVOKABLE void ResamplePointcloud ()
 
void Update (const UpdateInfo &, EntityComponentManager &_ecm) override
 Update callback called every time the system is stepped. This is called at a Gazebo Transport thread, so any interaction with Qt should be done through signals and slots.
 
- Public Member Functions inherited from Plugin
 Plugin ()
 
virtual ~Plugin ()
 
QQuickItem * CardItem () const
 
virtual std::string ConfigStr ()
 
QQmlContext * Context () const
 
bool DeleteLaterRequested () const
 
void Load (const tinyxml2::XMLElement *_pluginElem)
 
QQuickItem * PluginItem () const
 
void PostParentChanges ()
 
virtual std::string Title () const
 

Properties

unsigned int xSamples {10}
 Samples along x axis.
 
unsigned int ySamples {10}
 Samples along y axis.
 
unsigned int zSamples {10}
 Samples along z axis.
 

Additional Inherited Members

- Protected Member Functions inherited from Plugin
void DeleteLater ()
 
- Protected Attributes inherited from Plugin
std::string configStr
 
std::string title
 

Detailed Description

A GUI plugin for a user to load an Environment component into the ECM on a live simulation.

gz/sim/systems/EnvironmentVisualization.hh

Constructor & Destructor Documentation

◆ EnvironmentVisualization()

Constructor.

◆ ~EnvironmentVisualization()

~EnvironmentVisualization ( )
override

Destructor.

Member Function Documentation

◆ LoadConfig()

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

Reimplemented from Plugin.

◆ ResamplePointcloud()

Q_INVOKABLE void ResamplePointcloud ( )

◆ Update()

void Update ( const UpdateInfo _info,
EntityComponentManager _ecm 
)
overridevirtual

Update callback called every time the system is stepped. This is called at a Gazebo 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.

Property Documentation

◆ xSamples

unsigned int xSamples {10}

Samples along x axis.

◆ ySamples

unsigned int ySamples {10}

Samples along y axis.

◆ zSamples

unsigned int zSamples {10}

Samples along z axis.


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