Material.hh

Go to the documentation of this file.

/*
 * Copyright 2018 Open Source Robotics Foundation
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 */
#ifndef SDF_MATERIAL_HH_
#define SDF_MATERIAL_HH_

#include <string>
#include "sdf/Element.hh"
#include "sdf/Types.hh"
#include "sdf/sdf_config.h"
#include "sdf/system_util.hh"

namespace sdf
{
  // Inline bracket to help doxygen filtering.
  inline namespace SDF_VERSION_NAMESPACE {
  //

  // Forward declarations.
  class MaterialPrivate;
  class Pbr;

  enum class ShaderType : int
  {
    PIXEL = 0,
    VERTEX = 1,
    NORMAL_MAP_OBJECTSPACE = 2,
    NORMAL_MAP_TANGENTSPACE = 3,
  };

  class SDFORMAT_VISIBLE Material
  {
    public: Material();

    public: Material(const Material &_material);

    public: Material(Material &&_material) noexcept;

    public: ~Material();

    public: Material &operator=(const Material &_material);

    public: Material &operator=(Material &&_material);

    public: Errors Load(ElementPtr _sdf);

    public: ignition::math::Color Ambient() const;

    public: void SetAmbient(const ignition::math::Color &_color) const;

    public: ignition::math::Color Diffuse() const;

    public: void SetDiffuse(const ignition::math::Color &_color) const;

    public: ignition::math::Color Specular() const;

    public: void SetSpecular(const ignition::math::Color &_color) const;

    public: ignition::math::Color Emissive() const;

    public: void SetEmissive(const ignition::math::Color &_color) const;

    public: float RenderOrder() const;

    public: void SetRenderOrder(const float _renderOrder);

    public: bool Lighting() const;

    public: void SetLighting(const bool _lighting);

    public: bool DoubleSided() const;

    public: void SetDoubleSided(bool _doubleSided);

    public: sdf::ElementPtr Element() const;

    public: std::string ScriptUri() const;

    public: void SetScriptUri(const std::string &_uri);

    public: std::string ScriptName() const;

    public: void SetScriptName(const std::string &_name);

    public: ShaderType Shader() const;

    public: void SetShader(const ShaderType &_type);

    public: std::string NormalMap() const;

    public: void SetNormalMap(const std::string &_map);

    public: void SetPbrMaterial(const Pbr &_pbr);

    public: Pbr *PbrMaterial() const;

    public: const std::string &FilePath() const;

    public: void SetFilePath(const std::string &_filePath);

    private: MaterialPrivate *dataPtr = nullptr;
  };
  }
}
#endif