gz/common/Pbr.hh

Go to the documentation of this file.

/*
 * Copyright 2020 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 GZ_COMMON_PBR_HH_
#define GZ_COMMON_PBR_HH_
 
#include <string>
#include <gz/common/graphics/Export.hh>
 
namespace ignition
{
namespace common
{
  // Forward declarations.
  class PbrPrivate;
 
  enum class PbrType : int
  {
    NONE = 0,
 
    METAL = 1,
 
    SPECULAR = 2,
  };
 
  enum class NormalMapSpace: int
  {
    TANGENT = 0,
 
    OBJECT = 1,
  };
 
  class IGNITION_COMMON_GRAPHICS_VISIBLE Pbr
  {
    public: Pbr();
 
    public: Pbr(const Pbr &_pbr);
 
    public: Pbr(Pbr &&_pbr) noexcept;
 
    public: ~Pbr();
 
    public: Pbr &operator=(const Pbr &_pbr);
 
    public: Pbr &operator=(Pbr &&_pbr);
 
    public: bool operator==(const Pbr &_pbr) const;
 
    public: bool operator!=(const Pbr &_pbr) const;
 
    public: std::string AlbedoMap() const;
 
    public: void SetAlbedoMap(const std::string &_map);
 
    public: std::string NormalMap() const;
 
    public: void SetNormalMap(const std::string &_map,
        NormalMapSpace _space = NormalMapSpace::TANGENT);
 
    public: NormalMapSpace NormalMapType() const;
 
    public: std::string EnvironmentMap() const;
 
    public: void SetEnvironmentMap(const std::string &_map);
 
    public: std::string AmbientOcclusionMap() const;
 
    public: void SetAmbientOcclusionMap(const std::string &_map);
 
    public: std::string RoughnessMap() const;
 
    public: void SetRoughnessMap(const std::string &_map);
 
    public: std::string MetalnessMap() const;
 
    public: void SetMetalnessMap(const std::string &_map);
 
    public: std::string EmissiveMap() const;
 
    public: void SetEmissiveMap(const std::string &_map);
 
    public: std::string LightMap() const;
 
    public: void SetLightMap(const std::string &_map, unsigned int _uvSet = 0u);
 
    public: unsigned int LightMapTexCoordSet() const;
 
    public: double Metalness() const;
 
    public: void SetMetalness(double _value);
 
    public: double Roughness() const;
 
    public: void SetRoughness(double _value);
 
    public: std::string GlossinessMap() const;
 
    public: void SetGlossinessMap(const std::string &_map);
 
    public: double Glossiness() const;
 
    public: void SetGlossiness(double _value);
 
    public: std::string SpecularMap() const;
 
    public: void SetSpecularMap(const std::string &_map);
 
    public: PbrType Type() const;
 
    public: void SetType(PbrType _type);
 
    private: PbrPrivate *dataPtr = nullptr;
  };
}
}
#endif