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 <gz/math/Color.hh>
21 #include <gz/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 
29 namespace 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 
53  public: Errors Load(sdf::ElementPtr _sdf, const ParserConfig &_config);
54 
57  public: gz::math::Color Ambient() const;
58 
61  public: void SetAmbient(const gz::math::Color &_ambient);
62 
65  public: gz::math::Color Background() const;
66 
69  public: void SetBackground(const gz::math::Color &_background);
70 
73  public: bool Grid() const;
74 
77  public: void SetGrid(const bool _enabled);
78 
81  public: bool OriginVisual() const;
82 
85  public: void SetOriginVisual(const bool _enabled);
86 
89  public: bool Shadows() const;
90 
93  public: void SetShadows(const bool _shadows);
94 
97  public: void SetSky(const Sky &_sky);
98 
101  public: const sdf::Sky *Sky() const;
102 
107  public: sdf::ElementPtr Element() const;
108 
114  public: sdf::ElementPtr ToElement() const;
115 
122  public: sdf::ElementPtr ToElement(sdf::Errors &_errors) const;
123 
125  GZ_UTILS_IMPL_PTR(dataPtr)
126  };
127  }
128 }
129 #endif
sdf::SDF_VERSION_NAMESPACE::Sky
Definition: Sky.hh:40
sdf
namespace for Simulation Description Format parser
Definition: Actor.hh:34
Types.hh
sdf_config.h
SDFORMAT_VISIBLE
#define SDFORMAT_VISIBLE
Definition: system_util.hh:25
sdf::SDF_VERSION_NAMESPACE::ParserConfig
This class contains configuration options for the libsdformat parser.
Definition: ParserConfig.hh:84
sdf::SDF_VERSION_NAMESPACE::Scene
Definition: Scene.hh:33
sdf::SDF_VERSION_NAMESPACE::Element
class GZ_SDFORMAT_VISIBLE Element
Definition: Element.hh:51
sdf::SDF_VERSION_NAMESPACE::Errors
std::vector< Error > Errors
A vector of Error.
Definition: Types.hh:80
Sky.hh
system_util.hh
sdf::SDF_VERSION_NAMESPACE::ElementPtr
std::shared_ptr< Element > ElementPtr
Definition: Element.hh:55
Element.hh