GlobalIlluminationBase.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_GLOBALILLUMINATIONBASE_HH_
#define GZ_RENDERING_GLOBALILLUMINATIONBASE_HH_
 
#include <cstdint>
 
#include "gz/rendering/Export.hh"
#include "gz/rendering/config.hh"
 
namespace gz
{
  namespace rendering
  {
    inline namespace GZ_RENDERING_VERSION_NAMESPACE {
 
    class GZ_RENDERING_VISIBLE GlobalIlluminationBase
    {
      private: friend class Ogre2Scene;
 
      public: enum ParticipatingVisualsFlags
      {
        DYNAMIC_VISUALS = 1u << 0u,
 
        STATIC_VISUALS = 1u << 1u
      };
 
      public: GlobalIlluminationBase();
 
      public: virtual ~GlobalIlluminationBase();
 
      protected: virtual void Init() = 0;
 
      protected: virtual void Destroy() = 0;
 
      protected: virtual void SetEnabled(bool _enabled) = 0;
 
      public: virtual bool Enabled() const = 0;
 
      public: virtual void Build() = 0;
 
      public: virtual void UpdateLighting() = 0;
 
      public: virtual void UpdateCamera() = 0;
 
      public: virtual void SetBounceCount(uint32_t _bounceCount) = 0;
 
      public: virtual uint32_t BounceCount() const = 0;
 
      public: virtual void SetParticipatingVisuals(uint32_t _mask) = 0;
 
      public: virtual uint32_t ParticipatingVisuals() const = 0;
    };
    }
  }
}
#endif