Ignition Gazebo

API Reference

6.1.0

Displays a tree view with all the entities in the world. More...

#include <EntityTree.hh>

Public Member Functions

 EntityTree ()
 Constructor. More...
 
 ~EntityTree () override
 Destructor. More...
 
Q_INVOKABLE void DeselectAllEntities ()
 Callback when all entities have been deselected. This should be called from QML. More...
 
void LoadConfig (const tinyxml2::XMLElement *_pluginElem) override
 
Q_INVOKABLE void OnEntitySelectedFromQml (Entity _entity)
 Callback when an entity has been selected. This should be called from QML. More...
 
Q_INVOKABLE void OnInsertEntity (const QString &_type)
 Callback to insert a new entity. More...
 
Q_INVOKABLE void OnLoadMesh (const QString &_type)
 Callback to insert a new entity. More...
 
void Update (const UpdateInfo &, EntityComponentManager &) 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...
 

Protected Member Functions

bool eventFilter (QObject *_obj, QEvent *_event) override
 

Detailed Description

Displays a tree view with all the entities in the world.

Configuration

None

Constructor & Destructor Documentation

◆ EntityTree()

Constructor.

◆ ~EntityTree()

~EntityTree ( )
override

Destructor.

Member Function Documentation

◆ DeselectAllEntities()

Q_INVOKABLE void DeselectAllEntities ( )

Callback when all entities have been deselected. This should be called from QML.

◆ eventFilter()

bool eventFilter ( QObject *  _obj,
QEvent *  _event 
)
overrideprotected

◆ LoadConfig()

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

◆ OnEntitySelectedFromQml()

Q_INVOKABLE void OnEntitySelectedFromQml ( Entity  _entity)

Callback when an entity has been selected. This should be called from QML.

Parameters
[in]_entityEntity being selected.

◆ OnInsertEntity()

Q_INVOKABLE void OnInsertEntity ( const QString &  _type)

Callback to insert a new entity.

Parameters
[in]_typeType of entity to insert

◆ OnLoadMesh()

Q_INVOKABLE void OnLoadMesh ( const QString &  _type)

Callback to insert a new entity.

Parameters
[in]_typeType of entity to insert

◆ 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.


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