Gazebo Gazebo

API Reference

3.15.1
ignition::gazebo::gui Namespace Reference

Namespaces

 events
 Namespace for all events. Refer to the EventManager class for more information about events.
 

Classes

class  Plot3D
 Plot the trajectory of an entity into the 3D scene. More...
 

Functions

IGNITION_GAZEBO_GUI_VISIBLE std::unique_ptr< gz::gui::Application > createGui (int &_argc, char **_argv, const char *_guiConfig, const char *_defaultGuiConfig, bool _loadPluginsFromSdf, const char *_sdfFile, int _waitGui)
 Create a Gazebo GUI application. More...
 
IGNITION_GAZEBO_GUI_VISIBLE std::unique_ptr< gz::gui::Application > createGui (int &_argc, char **_argv, const char *_guiConfig, const char *_defaultGuiConfig=nullptr, bool _loadPluginsFromSdf=true)
 Create a Gazebo GUI application. More...
 
IGNITION_GAZEBO_GUI_VISIBLE int runGui (int &_argc, char **_argv, const char *_guiConfig)
 Run GUI application. More...
 
IGNITION_GAZEBO_GUI_VISIBLE int runGui (int &_argc, char **_argv, const char *_guiConfig, const char *_sdfFile, int _waitGui)
 Run GUI application. More...
 

Function Documentation

◆ createGui() [1/2]

IGNITION_GAZEBO_GUI_VISIBLE std::unique_ptr<gz::gui::Application> ignition::gazebo::gui::createGui ( int &  _argc,
char **  _argv,
const char *  _guiConfig,
const char *  _defaultGuiConfig,
bool  _loadPluginsFromSdf,
const char *  _sdfFile,
int  _waitGui 
)

Create a Gazebo GUI application.

Parameters
[in]_argcNumber of command line arguments (Used when running without ign-tools. Set to 1 if using ign-tools). Note: The object referenced by this variable must continue to exist for the lifetime of the application.
[in]_argvCommand line arguments (Used when running without ign-tools. Set to the name of the application if using ign-tools)
[in]_guiConfigThe GUI configuration file. If nullptr, the default configuration from IGN_HOMEDIR/.ignition/gazebo/gui.config will be used.
[in]_defaultGuiConfigThe default GUI configuration file. If no plugins were added from a world file or from _guiConfig, this configuration file will be loaded. If this argument is a nullptr or if the file does not exist, the default configuration from IGN_HOMEDIR/.ignition/gazebo/gui.config will be used.
[in]_loadPluginsFromSdfIf true, plugins specified in the world SDFormat file will get loaded.
[in]_sdfFileSDF world file, or nullptr if not set.
[in]_waitGuiTrue if the server is waiting for the GUI to decide on a starting world.

◆ createGui() [2/2]

IGNITION_GAZEBO_GUI_VISIBLE std::unique_ptr<gz::gui::Application> ignition::gazebo::gui::createGui ( int &  _argc,
char **  _argv,
const char *  _guiConfig,
const char *  _defaultGuiConfig = nullptr,
bool  _loadPluginsFromSdf = true 
)

Create a Gazebo GUI application.

Parameters
[in]_argcNumber of command line arguments (Used when running without ign-tools. Set to 1 if using ign-tools). Note: The object referenced by this variable must continue to exist for the lifetime of the application.
[in]_argvCommand line arguments (Used when running without ign-tools. Set to the name of the application if using ign-tools)
[in]_guiConfigThe GUI configuration file. If nullptr, the default configuration from IGN_HOMEDIR/.ignition/gazebo/gui.config will be used.
[in]_defaultGuiConfigThe default GUI configuration file. If no plugins were added from a world file or from _guiConfig, this configuration file will be loaded. If this argument is a nullptr or if the file does not exist, the default configuration from IGN_HOMEDIR/.ignition/gazebo/gui.config will be used.
[in]_loadPluginsFromSdfIf true, plugins specified in the world SDFormat file will get loaded.

◆ runGui() [1/2]

IGNITION_GAZEBO_GUI_VISIBLE int ignition::gazebo::gui::runGui ( int &  _argc,
char **  _argv,
const char *  _guiConfig 
)

Run GUI application.

Parameters
[in]_argcNumber of command line arguments (Used when running without ign-tools. Set to 1 if using ign-tools). Note: The object referenced by this variable must continue to exist for the lifetime of the application.
[in]_argvCommand line arguments (Used when running without ign-tools. Set to the name of the application if using ign-tools)
[in]_guiConfigThe GUI configuration file. If nullptr, the default configuration from IGN_HOMEDIR/.ignition/gazebo/gui.config will be used.

◆ runGui() [2/2]

IGNITION_GAZEBO_GUI_VISIBLE int ignition::gazebo::gui::runGui ( int &  _argc,
char **  _argv,
const char *  _guiConfig,
const char *  _sdfFile,
int  _waitGui 
)

Run GUI application.

Parameters
[in]_argcNumber of command line arguments (Used when running without ign-tools. Set to 1 if using ign-tools). Note: The object referenced by this variable must continue to exist for the lifetime of the application.
[in]_argvCommand line arguments (Used when running without ign-tools. Set to the name of the application if using ign-tools)
[in]_guiConfigThe GUI configuration file. If nullptr, the default configuration from IGN_HOMEDIR/.ignition/gazebo/gui.config will be used.
[in]_sdfFileThe world file path passed as a command line argument. If set, QuickStart Dialog will not be shown.
[in]_waitGuiFlag indicating whether the server waits until it receives a world path from GUI.