Gazebo Gazebo

API Reference

6.16.0
gz/sim/gui/Gui.hh
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2020 Open Source Robotics Foundation
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  *
16  */
17 
18 #ifndef GZ_GAZEBO_GUI_GUI_HH_
19 #define GZ_GAZEBO_GUI_GUI_HH_
20 
21 #include <memory>
22 #include <string>
23 #include <gz/gui/Application.hh>
24 
25 #include "gz/sim/config.hh"
26 #include "gz/sim/gui/Export.hh"
27 
28 namespace ignition
29 {
30 namespace gazebo
31 {
32 // Inline bracket to help doxygen filtering.
33 inline namespace IGNITION_GAZEBO_VERSION_NAMESPACE {
34 namespace gui
35 {
47  IGNITION_GAZEBO_GUI_VISIBLE int runGui(int &_argc,
48  char **_argv, const char *_guiConfig, const char *_renderEngine = nullptr);
49 
65  IGNITION_GAZEBO_GUI_VISIBLE int runGui(int &_argc, char **_argv,
66  const char *_guiConfig, const char *_sdfFile, int _waitGui,
67  const char *_renderEngine = nullptr);
68 
87  IGNITION_GAZEBO_GUI_VISIBLE
89  int &_argc, char **_argv, const char *_guiConfig,
90  const char *_defaultGuiConfig = nullptr, bool _loadPluginsFromSdf = true,
91  const char *_renderEngine = nullptr);
92 
114  IGNITION_GAZEBO_GUI_VISIBLE
116  int &_argc, char **_argv, const char *_guiConfig,
117  const char *_defaultGuiConfig, bool _loadPluginsFromSdf,
118  const char *_sdfFile, int _waitGui, const char *_renderEngine = nullptr);
119 } // namespace gui
120 } // namespace IGNITION_GAZEBO_VERSION_NAMESPACE
121 } // namespace gazebo
122 } // namespace ignition
123 
124 #endif
This library is part of the Gazebo project.
IGNITION_GAZEBO_GUI_VISIBLE int runGui(int &_argc, char **_argv, const char *_guiConfig, const char *_renderEngine=nullptr)
Run GUI application.
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, const char *_renderEngine=nullptr)
Create a Gazebo GUI application.
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, const char *_renderEngine=nullptr)
Create a Gazebo GUI application.
STL class.
IGNITION_GAZEBO_GUI_VISIBLE int runGui(int &_argc, char **_argv, const char *_guiConfig, const char *_sdfFile, int _waitGui, const char *_renderEngine=nullptr)
Run GUI application.