gz/sim/gui/Gui.hh

Go to the documentation of this file.

/*
 * Copyright (C) 2020 Open Source Robotics Foundation
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 */
 
#ifndef GZ_SIM_GUI_GUI_HH_
#define GZ_SIM_GUI_GUI_HH_
 
#include <memory>
#include <string>
#include <gz/gui/Application.hh>
 
#include "gz/sim/config.hh"
#include "gz/sim/gui/Export.hh"
 
namespace gz
{
namespace sim
{
// Inline bracket to help doxygen filtering.
inline namespace GZ_SIM_VERSION_NAMESPACE {
namespace gui
{
  GZ_SIM_GUI_VISIBLE int runGui(int &_argc,
    char **_argv, const char *_guiConfig, const char *_renderEngine = nullptr);
 
  GZ_SIM_GUI_VISIBLE int runGui(int &_argc, char **_argv,
        const char *_guiConfig, const char *_sdfFile, int _waitGui,
        const char *_renderEngine = nullptr);
 
  GZ_SIM_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);
 
  GZ_SIM_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);
}  // namespace gui
}  // namespace GZ_SIM_VERSION_NAMESPACE
}  // namespace sim
}  // namespace gz
 
#endif