Loading...
Searching...
No Matches
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 "sdf/Element.hh"
21#include "sdf/Types.hh"
22#include "sdf/sdf_config.h"
23#include "sdf/system_util.hh"
24
25namespace sdf
26{
27 // Inline bracket to help doxygen filtering.
28 inline namespace SDF_VERSION_NAMESPACE {
29 //
30
31 // Forward declarations.
32 class GuiPrivate;
33
35 {
37 public: Gui();
38
41 public: Gui(const Gui &_gui);
42
45 public: Gui(Gui &&_gui) noexcept;
46
50 public: Gui &operator=(Gui &&_gui);
51
55 public: Gui &operator=(const Gui &_gui);
56
58 public: ~Gui();
59
66 public: Errors Load(ElementPtr _sdf);
67
70 public: bool Fullscreen() const;
71
75 public: void SetFullscreen(const bool _fullscreen) const;
76
81 public: bool operator==(const Gui &_gui) const;
82
87 public: sdf::ElementPtr Element() const;
88
90 private: GuiPrivate *dataPtr = nullptr;
91 };
92 }
93}
94#endif
Definition Gui.hh:35
bool Fullscreen() const
Get whether the Gui should be fullscreen.
bool operator==(const Gui &_gui) const
Equality operator that returns true if this Gui instance equals the given Gui instance.
Gui & operator=(const Gui &_gui)
Copy assignment operator.
Gui(Gui &&_gui) noexcept
Move constructor.
void SetFullscreen(const bool _fullscreen) const
Set whether the Gui should be full screen.
Errors Load(ElementPtr _sdf)
Load the gui based on a element pointer.
~Gui()
Destructor.
Gui & operator=(Gui &&_gui)
Move assignment operator.
Gui(const Gui &_gui)
Copy constructor.
sdf::ElementPtr Element() const
Get a pointer to the SDF element that was used during load.
Gui()
Default constructor.
std::vector< Error > Errors
A vector of Error.
Definition Types.hh:89
std::shared_ptr< Element > ElementPtr
Definition Element.hh:53
namespace for Simulation Description Format parser
Definition Actor.hh:33
#define SDFORMAT_VISIBLE
Use to represent "symbol visible" if supported.
Definition system_util.hh:48