Gazebo Gazebo

API Reference

3.15.2
List of all members | Public Member Functions | Public Attributes | Static Public Attributes
SpawnPreviewPath Class Reference

Event called to spawn a preview resource, which takes the path to the SDF file. Used by plugins that spawn resources. More...

#include <GuiEvents.hh>

Public Member Functions

 SpawnPreviewPath (const std::string &_filePath)
 Constructor. More...
 
std::string FilePath () const
 Get the path of the SDF file. More...
 

Public Attributes

std::string filePath
 The path of SDF file to be previewed. More...
 

Static Public Attributes

static const QEvent::Type kType = QEvent::Type(QEvent::User + 5)
 Unique type for this event. More...
 

Detailed Description

Event called to spawn a preview resource, which takes the path to the SDF file. Used by plugins that spawn resources.

Constructor & Destructor Documentation

◆ SpawnPreviewPath()

SpawnPreviewPath ( const std::string &  _filePath)
inlineexplicit

Constructor.

Parameters
[in]_filePathThe path to an SDF file.

Member Function Documentation

◆ FilePath()

std::string FilePath ( ) const
inline

Get the path of the SDF file.

Returns
The file path.

References SpawnPreviewPath::filePath.

Member Data Documentation

◆ filePath

std::string filePath

The path of SDF file to be previewed.

Referenced by SpawnPreviewPath::FilePath().

◆ kType

const QEvent::Type kType = QEvent::Type(QEvent::User + 5)
static

Unique type for this event.

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