Material.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_MATERIAL_HH_
18 #define SDF_MATERIAL_HH_
19 
20 #include <string>
21 #include <gz/utils/ImplPtr.hh>
22 #include "sdf/Element.hh"
23 #include "sdf/Types.hh"
24 #include "sdf/sdf_config.h"
25 #include "sdf/system_util.hh"
26 
27 namespace sdf
28 {
29  // Inline bracket to help doxygen filtering.
30  inline namespace SDF_VERSION_NAMESPACE {
31  //
32 
33  // Forward declarations.
34  class Pbr;
35 
36  enum class ShaderType : int
37  {
38  PIXEL = 0,
39  VERTEX = 1,
42  };
43 
46  {
48  public: Material();
49 
56  public: Errors Load(ElementPtr _sdf);
57 
62  public: gz::math::Color Ambient() const;
63 
68  public: void SetAmbient(const gz::math::Color &_color);
69 
74  public: gz::math::Color Diffuse() const;
75 
80  public: void SetDiffuse(const gz::math::Color &_color);
81 
86  public: gz::math::Color Specular() const;
87 
92  public: void SetSpecular(const gz::math::Color &_color);
93 
96  public: double Shininess() const;
97 
100  public: void SetShininess(const double _shininess);
101 
106  public: gz::math::Color Emissive() const;
107 
112  public: void SetEmissive(const gz::math::Color &_color);
113 
118  public: float RenderOrder() const;
119 
123  public: void SetRenderOrder(const float _renderOrder);
124 
128  public: bool Lighting() const;
129 
132  public: void SetLighting(const bool _lighting);
133 
137  public: bool DoubleSided() const;
138 
141  public: void SetDoubleSided(bool _doubleSided);
142 
147  public: sdf::ElementPtr Element() const;
148 
152  public: std::string ScriptUri() const;
153 
156  public: void SetScriptUri(const std::string &_uri);
157 
163  public: std::string ScriptName() const;
164 
168  public: void SetScriptName(const std::string &_name);
169 
172  public: ShaderType Shader() const;
173 
176  public: void SetShader(const ShaderType &_type);
177 
182  public: std::string NormalMap() const;
183 
186  public: void SetNormalMap(const std::string &_map);
187 
190  public: void SetPbrMaterial(const Pbr &_pbr);
191 
194  public: const Pbr *PbrMaterial() const;
195 
198  public: const std::string &FilePath() const;
199 
202  public: void SetFilePath(const std::string &_filePath);
203 
209  public: sdf::ElementPtr ToElement() const;
210 
212  IGN_UTILS_IMPL_PTR(dataPtr)
213  };
214  }
215 }
216 #endif
sdf::SDF_VERSION_NAMESPACE::Pbr
This class provides access to Physically-Based-Rendering (PBR) material workflows.
Definition: Pbr.hh:238
sdf
namespace for Simulation Description Format parser
Definition: Actor.hh:34
sdf::SDF_VERSION_NAMESPACE::ShaderType::NORMAL_MAP_TANGENTSPACE
@ NORMAL_MAP_TANGENTSPACE
sdf::SDF_VERSION_NAMESPACE::Element
class IGNITION_SDFORMAT_VISIBLE Element
Definition: Element.hh:50
sdf::SDF_VERSION_NAMESPACE::ShaderType::VERTEX
@ VERTEX
sdf::SDF_VERSION_NAMESPACE::Material
This class contains visual material properties.
Definition: Material.hh:45
Types.hh
sdf_config.h
SDFORMAT_VISIBLE
#define SDFORMAT_VISIBLE
Definition: system_util.hh:25
sdf::SDF_VERSION_NAMESPACE::ShaderType::NORMAL_MAP_OBJECTSPACE
@ NORMAL_MAP_OBJECTSPACE
sdf::SDF_VERSION_NAMESPACE::Errors
std::vector< Error > Errors
A vector of Error.
Definition: Types.hh:106
sdf::SDF_VERSION_NAMESPACE::ShaderType
ShaderType
Definition: Material.hh:36
system_util.hh
sdf::SDF_VERSION_NAMESPACE::ElementPtr
std::shared_ptr< Element > ElementPtr
Definition: Element.hh:54
Element.hh
sdf::SDF_VERSION_NAMESPACE::ShaderType::PIXEL
@ PIXEL