Ignition Gazebo

API Reference

3.5.0
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 IGNITION_GAZEBO_GUI_GUI_HH_
19 #define IGNITION_GAZEBO_GUI_GUI_HH_
20 
21 #include <memory>
22 #include <ignition/gui/Application.hh>
23 
24 #include "ignition/gazebo/config.hh"
25 #include "ignition/gazebo/Export.hh"
26 
27 namespace ignition
28 {
29 namespace gazebo
30 {
31 // Inline bracket to help doxygen filtering.
32 inline namespace IGNITION_GAZEBO_VERSION_NAMESPACE {
33 namespace gui
34 {
44  IGNITION_GAZEBO_VISIBLE int runGui(int &_argc, char **_argv,
45  const char *_guiConfig);
46 
64  int &_argc, char **_argv, const char *_guiConfig,
65  const char *_defaultGuiConfig = nullptr, bool _loadPluginsFromSdf = true);
66 
67 } // namespace gui
68 } // namespace IGNITION_GAZEBO_VERSION_NAMESPACE
69 } // namespace gazebo
70 } // namespace ignition
71 
72 #endif
STL class.
std::unique_ptr< ignition::gui::Application > createGui(int &_argc, char **_argv, const char *_guiConfig, const char *_defaultGuiConfig=nullptr, bool _loadPluginsFromSdf=true)
Create a Gazebo GUI application.
This library is part of the Ignition Robotics project.
int runGui(int &_argc, char **_argv, const char *_guiConfig)
Run GUI application.