Scene.hh
Go to the documentation of this file.
1/*
2 * Copyright 2019 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_SCENE_HH_
18#define SDF_SCENE_HH_
19
20#include <ignition/math/Color.hh>
21#include <ignition/utils/ImplPtr.hh>
22
23#include "sdf/Element.hh"
24#include "sdf/Sky.hh"
25#include "sdf/Types.hh"
26#include "sdf/sdf_config.h"
27#include "sdf/system_util.hh"
28
29namespace sdf
30{
31 // Inline bracket to help doxygen filtering.
32 inline namespace SDF_VERSION_NAMESPACE {
34 {
36 public: Scene();
37
44 public: Errors Load(ElementPtr _sdf);
45
48 public: ignition::math::Color Ambient() const;
49
52 public: void SetAmbient(const ignition::math::Color &_ambient);
53
56 public: ignition::math::Color Background() const;
57
60 public: void SetBackground(const ignition::math::Color &_background);
61
64 public: bool Grid() const;
65
68 public: void SetGrid(const bool _enabled);
69
72 public: bool OriginVisual() const;
73
76 public: void SetOriginVisual(const bool _enabled);
77
80 public: bool Shadows() const;
81
84 public: void SetShadows(const bool _shadows);
85
88 public: void SetSky(const Sky &_sky);
89
92 public: const sdf::Sky *Sky() const;
93
98 public: sdf::ElementPtr Element() const;
99
101 IGN_UTILS_IMPL_PTR(dataPtr)
102 };
103 }
104}
105#endif
Definition: Scene.hh:34
void SetShadows(const bool _shadows)
Set whether shadows should be enabled.
sdf::ElementPtr Element() const
Get a pointer to the SDF element that was used during load.
void SetAmbient(const ignition::math::Color &_ambient)
Set the ambient color of the scene.
Scene()
Default constructor.
bool Shadows() const
Get whether shadows are enabled.
ignition::math::Color Background() const
Get the background color of the scene.
bool Grid() const
Get whether grid is enabled.
void SetOriginVisual(const bool _enabled)
Set whether the origin visual should be enabled.
void SetSky(const Sky &_sky)
Set sky.
Errors Load(ElementPtr _sdf)
Load the scene based on a element pointer.
void SetBackground(const ignition::math::Color &_background)
Set the background color of the scene.
bool OriginVisual() const
Get whether origin visual is enabled.
void SetGrid(const bool _enabled)
Set whether the grid should be enabled.
const sdf::Sky * Sky() const
Get sky.
ignition::math::Color Ambient() const
Get the ambient color of the scene.
Definition: Sky.hh:34
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