GlobalIlluminationCiVct.hh

Go to the documentation of this file.

/*
 * Copyright (C) 2022 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_GLOBALILLUMINATIONCIVCT_HH_
#define GZ_RENDERING_GLOBALILLUMINATIONCIVCT_HH_
 
#include "gz/rendering/GlobalIlluminationBase.hh"
 
#include "gz/rendering/RenderTypes.hh"
 
#include <gz/math/Vector3.hh>
 
namespace gz
{
  namespace rendering
  {
  inline namespace GZ_RENDERING_VERSION_NAMESPACE {
 
  class GZ_RENDERING_VISIBLE CiVctCascade
  {
    public: CiVctCascade();
 
    public: virtual ~CiVctCascade();
 
    public: virtual void SetCorrectAreaLightShadows(
          bool _correctAreaLightShadows) = 0;
 
    public: virtual bool CorrectAreaLightShadows() const = 0;
 
    public: virtual void SetAutoMultiplier(bool _autoMultiplier) = 0;
 
    public: virtual bool AutoMultiplier() const = 0;
 
    public: virtual void SetThinWallCounter(float _thinWallCounter) = 0;
 
    public: virtual float ThinWallCounter() const = 0;
 
    public: virtual void SetResolution(const uint32_t _resolution[3]) = 0;
 
    public: virtual const uint32_t* Resolution() const = 0;
 
    public: virtual void SetOctantCount(const uint32_t _octants[3]) = 0;
 
    public: virtual const uint32_t* OctantCount() const = 0;
 
    public: virtual void SetAreaHalfSize(
          const gz::math::Vector3d &_areaHalfSize) = 0;
 
    public: virtual gz::math::Vector3d AreaHalfSize() const = 0;
 
    public: virtual void SetCameraStepSize(
          const gz::math::Vector3d &_stepSize) = 0;
 
    public: virtual gz::math::Vector3d CameraStepSize() const = 0;
  };
 
  class GZ_RENDERING_VISIBLE GlobalIlluminationCiVct :
        public GlobalIlluminationBase
  {
    public: enum DebugVisualizationMode
            {
              DVM_Albedo,
              DVM_Normal,
              DVM_Emissive,
              DVM_Lighting,
              DVM_None
            };
 
    public: GlobalIlluminationCiVct();
 
    public: virtual ~GlobalIlluminationCiVct();
 
    public: virtual void SetMaxCascades(const uint32_t _maxCascades) = 0;
 
    public: virtual CiVctCascadePtr AddCascade(const CiVctCascade *_ref) = 0;
 
    public: virtual void PopCascade() = 0;
 
    public: virtual void AutoCalculateStepSizes(
        const gz::math::Vector3d &_stepSize) = 0;
 
    public: virtual void SetConsistentCascadeSteps(
        bool _consistentCascadeSteps) = 0;
 
    public: virtual bool ConsistentCascadeSteps() const = 0;
 
    public: virtual bool Started() const = 0;
 
    public: virtual void Start(uint32_t _bounceCount, bool _anisotropic) = 0;
 
    public: virtual void NewSettings(
        uint32_t _bounceCount, bool _anisotropic) = 0;
 
    public: virtual void Reset() = 0;
 
    public: virtual void Bind(const CameraPtr &_camera) = 0;
 
    public: virtual bool Anisotropic() const = 0;
 
    public: virtual void SetHighQuality(bool _highQuality) = 0;
 
    public: virtual bool HighQuality() const = 0;
 
    public: virtual void SetDebugVisualization(DebugVisualizationMode _dvm) = 0;
 
    public: virtual DebugVisualizationMode DebugVisualization() const = 0;
 
    public: virtual void LightingChanged() = 0;
  };
  }
  }
}
#endif