Gui.hh
Go to the documentation of this file.
1/*
2 * Copyright 2018 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#ifndef SDF_GUI_HH_
18#define SDF_GUI_HH_
19
20#include <ignition/utils/ImplPtr.hh>
21#include "sdf/Element.hh"
22#include "sdf/Types.hh"
23#include "sdf/sdf_config.h"
24#include "sdf/system_util.hh"
25
26namespace sdf
27{
28 // Inline bracket to help doxygen filtering.
29 inline namespace SDF_VERSION_NAMESPACE {
31 {
33 public: Gui();
34
41 public: Errors Load(ElementPtr _sdf);
42
45 public: bool Fullscreen() const;
46
50 public: void SetFullscreen(const bool _fullscreen);
51
56 public: bool operator==(const Gui &_gui) const;
57
62 public: sdf::ElementPtr Element() const;
63
65 IGN_UTILS_IMPL_PTR(dataPtr)
66 };
67 }
68}
69#endif
Definition: Gui.hh:31
Errors Load(ElementPtr _sdf)
Load the gui based on a element pointer.
bool operator==(const Gui &_gui) const
Equality operator that returns true if this Gui instance equals the given Gui instance.
Gui()
Default constructor.
void SetFullscreen(const bool _fullscreen)
Set whether the Gui should be full screen.
bool Fullscreen() const
Get whether the Gui should be fullscreen.
sdf::ElementPtr Element() const
Get a pointer to the SDF element that was used during load.
std::vector< Error > Errors
A vector of Error.
Definition: Types.hh:106
std::shared_ptr< Element > ElementPtr
Definition: Element.hh:54
namespace for Simulation Description Format parser
Definition: Actor.hh:34
#define SDFORMAT_VISIBLE
Use to represent "symbol visible" if supported.
Definition: system_util.hh:41