Gui.hh

Go to the documentation of this file.

/*
 * Copyright 2018 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 SDF_GUI_HH_
#define SDF_GUI_HH_
 
#include <gz/utils/ImplPtr.hh>
#include "sdf/Element.hh"
#include "sdf/Plugin.hh"
#include "sdf/Types.hh"
#include "sdf/config.hh"
#include "sdf/system_util.hh"
 
namespace sdf
{
  // Inline bracket to help doxygen filtering.
  inline namespace SDF_VERSION_NAMESPACE {
  class SDFORMAT_VISIBLE Gui
  {
    public: Gui();
 
    public: Errors Load(ElementPtr _sdf);
 
    public: bool Fullscreen() const;
 
    public: void SetFullscreen(const bool _fullscreen);
 
    public: bool operator==(const Gui &_gui) const;
 
    public: sdf::ElementPtr Element() const;
 
    public: sdf::ElementPtr ToElement() const;
 
    public: uint64_t PluginCount() const;
 
    public: const Plugin *PluginByIndex(const uint64_t _index) const;
 
    public: void ClearPlugins();
 
    public: void AddPlugin(const Plugin &_plugin);
 
    public: const sdf::Plugins &Plugins() const;
 
    public: sdf::Plugins &Plugins();
 
    GZ_UTILS_IMPL_PTR(dataPtr)
  };
  }
}
#endif