Gazebo Gui

API Reference

3.12.0

Event called to spawn a resource, given its description as a string. More...

#include <GuiEvents.hh>

Public Member Functions

 SpawnFromDescription (const std::string &_description)
 Constructor. More...
 
const std::stringDescription () const
 Get the string description of the resource. More...
 
- Public Member Functions inherited from QEvent
 QEvent (Type type)
 
virtual ~QEvent ()
 
void accept ()
 
void ignore ()
 
bool isAccepted () const
 
void setAccepted (bool accepted)
 
bool spontaneous () const
 
Type type () const
 

Public Attributes

std::string description
 The string of the resource to be spawned. More...
 

Static Public Attributes

static const QEvent::Type kType = QEvent::Type(QEvent::MaxUser - 2)
 Unique type for this event. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from QEvent
int registerEventType (int hint)
 
- Properties inherited from QEvent
 accepted
 

Detailed Description

Event called to spawn a resource, given its description as a string.

Constructor & Destructor Documentation

◆ SpawnFromDescription()

SpawnFromDescription ( const std::string _description)
inlineexplicit

Constructor.

Parameters
[in]_descriptionThe resource's description as a string, such as an SDF file.

Member Function Documentation

◆ Description()

const std::string& Description ( ) const
inline

Get the string description of the resource.

Returns
The resource string

References SpawnFromDescription::description.

Member Data Documentation

◆ description

std::string description

The string of the resource to be spawned.

Referenced by SpawnFromDescription::Description().

◆ kType

const QEvent::Type kType = QEvent::Type(QEvent::MaxUser - 2)
static

Unique type for this event.


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