gz/rendering/ogre2/Ogre2Material.hh

Go to the documentation of this file.

/*
 * Copyright (C) 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 GZ_RENDERING_OGRE2_OGRE2MATERIAL_HH_
#define GZ_RENDERING_OGRE2_OGRE2MATERIAL_HH_
 
#include <memory>
#include <string>
 
#include "gz/rendering/base/BaseMaterial.hh"
#include "gz/rendering/ogre2/Ogre2Object.hh"
 
#ifdef _MSC_VER
  #pragma warning(push, 0)
#endif
#include <Hlms/Pbs/OgreHlmsPbsPrerequisites.h>
#include <OgreGpuProgramParams.h>
#include <OgreMaterial.h>
#ifdef _MSC_VER
  #pragma warning(pop)
#endif
 
namespace Ogre
{
  class HlmsPbsDatablock;
  class HlmsUnlitDatablock;
}  // namespace Ogre
 
namespace gz
{
  namespace rendering
  {
    inline namespace GZ_RENDERING_VERSION_NAMESPACE {
    //
    // forward declaration
    class Ogre2MaterialPrivate;
 
    class GZ_RENDERING_OGRE2_VISIBLE Ogre2Material :
      public BaseMaterial<Ogre2Object>
    {
      protected: Ogre2Material();
 
      public: virtual ~Ogre2Material();
 
      // Documentation inherited
      public: virtual void Destroy() override;
 
      // Documentation inherited
      public: virtual math::Color Diffuse() const override;
 
      // Documentation inherited
      public: virtual void SetDiffuse(const math::Color &_color) override;
 
      // Documentation inherited
      public: virtual math::Color Specular() const override;
 
      // Documentation inherited
      public: virtual void SetSpecular(const math::Color &_color) override;
 
      // Documentation inherited
      public: virtual math::Color Emissive() const override;
 
      // Documentation inherited
      public: virtual void SetEmissive(const math::Color &_color) override;
 
      // Documentation inherited
      public: virtual void SetTransparency(const double _transparency) override;
 
      // Documentation inherited
      public: virtual void SetAlphaFromTexture(bool _enabled,
          double _alpha = 0.5, bool _twoSided = true) override;
 
      // Documentation inherited
      public: virtual float RenderOrder() const override;
 
      // Documentation inherited
      // Review the official documentation to get more details about this
      // parameter, in particular mDepthBiasConstant
      public: virtual void SetRenderOrder(const float _renderOrder) override;
 
      // Documentation inherited
      public: virtual bool ReceiveShadows() const override;
 
      // Documentation inherited
      public: virtual void SetReceiveShadows(const bool _receiveShadows)
          override;
 
      // Documentation inherited
      public: virtual bool HasTexture() const override;
 
      // Documentation inherited
      public: virtual std::string Texture() const override;
 
      // Documentation inherited
      public: virtual void SetTexture(const std::string &_texture,
          const std::shared_ptr<const common::Image> &_img) override;
 
      // Documentation inherited
      public: virtual std::shared_ptr<const common::Image> TextureData()
          const override;
 
      // Documentation inherited
      public: virtual void ClearTexture() override;
 
      // Documentation inherited
      public: virtual bool HasNormalMap() const override;
 
      // Documentation inherited
      public: virtual std::string NormalMap() const override;
 
      // Documentation inherited
      public: virtual std::shared_ptr<const common::Image> NormalMapData()
          const override;
 
      // Documentation inherited
      public: virtual void SetNormalMap(const std::string &_normalMap,
          const std::shared_ptr<const common::Image> &_img) override;
 
      // Documentation inherited
      public: virtual void ClearNormalMap() override;
 
      // Documentation inherited
      public: virtual bool HasRoughnessMap() const override;
 
      // Documentation inherited
      public: virtual std::string RoughnessMap() const override;
 
      // Documentation inherited
      public: virtual std::shared_ptr<const common::Image> RoughnessMapData()
          const override;
 
      // Documentation inherited
      public: virtual void SetRoughnessMap(const std::string &_roughnessMap,
          const std::shared_ptr<const common::Image> &_img) override;
 
      // Documentation inherited
      public: virtual void ClearRoughnessMap() override;
 
      // Documentation inherited
      public: virtual bool HasMetalnessMap() const override;
 
      // Documentation inherited
      public: virtual std::string MetalnessMap() const override;
 
      // Documentation inherited
      public: virtual std::shared_ptr<const common::Image> MetalnessMapData()
          const override;
 
      // Documentation inherited
      public: virtual void SetMetalnessMap(const std::string &_metalnessMap,
          const std::shared_ptr<const common::Image> &_img) override;
 
      // Documentation inherited
      public: virtual void ClearMetalnessMap() override;
 
      // Documentation inherited
      public: virtual bool HasEnvironmentMap() const override;
 
      // Documentation inherited
      public: virtual std::string EnvironmentMap() const override;
 
      // Documentation inherited
      public: virtual std::shared_ptr<const common::Image> EnvironmentMapData()
          const override;
 
      // Documentation inherited
      public: virtual void SetEnvironmentMap(
        const std::string &_environmentMap,
        const std::shared_ptr<const common::Image> &_img) override;
 
      // Documentation inherited
      public: virtual void ClearEnvironmentMap() override;
 
      // Documentation inherited
      public: virtual void SetRoughness(const float _roughness) override;
 
      // Documentation inherited
      public: virtual bool HasEmissiveMap() const override;
 
      // Documentation inherited
      public: virtual std::string EmissiveMap() const override;
 
      // Documentation inherited
      public: virtual std::shared_ptr<const common::Image> EmissiveMapData()
          const override;
 
      // Documentation inherited
      public: virtual void SetEmissiveMap(
        const std::string &_emissiveMap,
        const std::shared_ptr<const common::Image> &_img) override;
 
      // Documentation inherited
      public: virtual void ClearEmissiveMap() override;
 
      // Documentation inherited
      public: virtual bool HasLightMap() const override;
 
      // Documentation inherited
      public: virtual std::string LightMap() const override;
 
      // Documentation inherited
      public: virtual unsigned int LightMapTexCoordSet() const override;
 
      // Documentation inherited
      public: virtual void SetLightMap(const std::string &_lightMap,
          const std::shared_ptr<const common::Image> &_img,
          unsigned int _uvSet = 0u) override;
 
      // Documentation inherited
      public: virtual std::shared_ptr<const common::Image> LightMapData()
          const override;
 
      // Documentation inherited
      public: virtual void ClearLightMap() override;
 
      // Documentation inherited
      public: virtual float Roughness() const override;
 
      // Documentation inherited
      public: virtual void SetMetalness(const float _roughness) override;
 
      // Documentation inherited
      public: virtual float Metalness() const override;
 
      public: virtual Ogre::MaterialPtr Material();
 
      public: virtual Ogre::HlmsPbsDatablock *Datablock() const;
 
      public: virtual Ogre::HlmsUnlitDatablock *UnlitDatablock();
 
      public: virtual void FillUnlitDatablock(
          Ogre::HlmsUnlitDatablock *_datablock) const;
 
      // Documentation inherited.
      // \sa BaseMaterial::PreRender()
      public: virtual void PreRender() override;
 
      // Documentation inherited.
      public: virtual enum MaterialType Type() const override;
 
      // Documentation inherited
      public: virtual bool DepthCheckEnabled() const override;
 
      // Documentation inherited
      public: virtual void SetDepthCheckEnabled(bool _enabled) override;
 
      // Documentation inherited
      public: virtual bool DepthWriteEnabled() const override;
 
      // Documentation inherited
      public: virtual void SetDepthWriteEnabled(bool _enabled) override;
 
      // Documentation inherited.
      // \sa Material::SetVertexShader(const std::string &)
      public: virtual void SetVertexShader(const std::string &_path) override;
 
      // Documentation inherited.
      // \sa Material::VertexShader() const
      public: virtual std::string VertexShader() const override;
 
      // Documentation inherited.
      // \sa Material::VertexShaderParams()
      public: virtual ShaderParamsPtr VertexShaderParams() override;
 
      // Documentation inherited.
      // \sa Material::SetFragmentShader(const std::string &)
      public: virtual void SetFragmentShader(const std::string &_path)
                  override;
 
      // Documentation inherited.
      // \sa Material::FragmentShader() const
      public: virtual std::string FragmentShader() const override;
 
      // Documentation inherited.
      // \sa Material::FragmentShaderParams()
      public: virtual ShaderParamsPtr FragmentShaderParams() override;
 
      protected: virtual void SetTextureMapImpl(const std::string &_texture,
          Ogre::PbsTextureTypes _type);
 
      protected: void SetTextureMapDataImpl(const std::string& _texture,
          const std::shared_ptr<const common::Image> &_img,
          Ogre::PbsTextureTypes _type);
 
      protected: virtual Ogre::TextureGpu *Texture(const std::string &_name);
 
      protected: virtual void UpdateTransparency();
 
      // Documentation inherited.
      protected: virtual void Init() override;
 
      protected: void UpdateShaderParams();
 
      protected: void UpdateShaderParams(ConstShaderParamsPtr _params,
          Ogre::GpuProgramParametersSharedPtr _ogreParams);
 
      protected: Ogre::MaterialPtr ogreMaterial;
 
      protected: Ogre::HlmsPbsDatablock *ogreDatablock = nullptr;
 
      protected: Ogre::HlmsUnlitDatablock *ogreUnlitDatablock = nullptr;
 
      protected: Ogre::HlmsPbs *ogreHlmsPbs = nullptr;
 
      protected: std::string textureName;
 
      protected: std::string normalMapName;
 
      protected: std::string roughnessMapName;
 
      protected: std::string metalnessMapName;
 
      protected: std::string environmentMapName;
 
      protected: std::string emissiveMapName;
 
      protected: std::string lightMapName;
 
      protected: unsigned int lightMapUvSet = 0u;
 
      protected: std::string ogreDatablockId;
 
      private: std::unique_ptr<Ogre2MaterialPrivate> dataPtr;
 
      private: friend class Ogre2Scene;
    };
    }
  }
}
#endif