Ignition Gazebo

API Reference

6.0.0~pre1

Allows to spawn models and lights using the spawn gui events or drag and drop. More...

#include <Spawn.hh>

Signals

void ErrorPopupTextChanged ()
 Notify the popup error text has changed. More...
 
void popupError ()
 Notify that an error has occurred (opens popup) Note that the function name needs to start with lowercase in order for the connection to work on the QML side. More...
 

Public Member Functions

 Spawn ()
 Constructor. More...
 
 ~Spawn () override
 Destructor. More...
 
Q_INVOKABLE QString ErrorPopupText () const
 Get the text for the popup error message. More...
 
void LoadConfig (const tinyxml2::XMLElement *_pluginElem) override
 
void OnDropped (const ignition::gui::events::DropOnScene *_event)
 Handle drop events. More...
 
Q_INVOKABLE void SetErrorPopupText (const QString &_errorTxt)
 Set the text for the popup error message. More...
 

Protected Member Functions

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

Properties

QString errorPopupText
 Text for popup error. More...
 

Detailed Description

Allows to spawn models and lights using the spawn gui events or drag and drop.

Constructor & Destructor Documentation

◆ Spawn()

Spawn ( )

Constructor.

◆ ~Spawn()

~Spawn ( )
override

Destructor.

Member Function Documentation

◆ ErrorPopupText()

Q_INVOKABLE QString ErrorPopupText ( ) const

Get the text for the popup error message.

Returns
The error text

◆ ErrorPopupTextChanged

void ErrorPopupTextChanged ( )
signal

Notify the popup error text has changed.

◆ eventFilter()

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

◆ LoadConfig()

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

◆ OnDropped()

void OnDropped ( const ignition::gui::events::DropOnScene *  _event)

Handle drop events.

Parameters
[in]_eventEvent with drop information.

◆ popupError

void popupError ( )
signal

Notify that an error has occurred (opens popup) Note that the function name needs to start with lowercase in order for the connection to work on the QML side.

◆ SetErrorPopupText()

Q_INVOKABLE void SetErrorPopupText ( const QString &  _errorTxt)

Set the text for the popup error message.

Parameters
[in]_errorTxtThe error text

Property Documentation

◆ errorPopupText

QString errorPopupText
readwrite

Text for popup error.


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