GlobalIlluminationVct.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_SIM_GUI_GLOBALILLUMINATIONVCT_HH_
#define GZ_SIM_GUI_GLOBALILLUMINATIONVCT_HH_
 
#include <memory>
 
#include "gz/sim/gui/GuiSystem.hh"
#include "gz/gui/qt.h"
 
namespace gz
{
namespace sim
{
// Inline bracket to help doxygen filtering.
inline namespace GZ_SIM_VERSION_NAMESPACE
{
  class GlobalIlluminationVctPrivate;
 
  class GlobalIlluminationVct : public gz::sim::GuiSystem
  {
    Q_OBJECT
 
    Q_PROPERTY(
      bool enabled
      READ Enabled
      WRITE SetEnabled
      NOTIFY EnabledChanged
    )
 
    Q_PROPERTY(
      int resolutionX
      READ ResolutionX
      WRITE SetResolutionX
      NOTIFY SettingsChanged
    )
    Q_PROPERTY(
      int resolutionY
      READ ResolutionY
      WRITE SetResolutionY
      NOTIFY SettingsChanged
    )
    Q_PROPERTY(
      int resolutionZ
      READ ResolutionZ
      WRITE SetResolutionZ
      NOTIFY SettingsChanged
    )
 
    Q_PROPERTY(
      int octantCountX
      READ OctantCountX
      WRITE SetOctantCountX
      NOTIFY SettingsChanged
    )
    Q_PROPERTY(
      int octantCountY
      READ OctantCountY
      WRITE SetOctantCountY
      NOTIFY SettingsChanged
    )
    Q_PROPERTY(
      int octantCountZ
      READ OctantCountZ
      WRITE SetOctantCountZ
      NOTIFY SettingsChanged
    )
 
    Q_PROPERTY(
      int bounceCount
      READ BounceCount
      WRITE SetBounceCount
      NOTIFY LightingChanged
    )
 
    Q_PROPERTY(
      bool highQuality
      READ HighQuality
      WRITE SetHighQuality
      NOTIFY LightingChanged
    )
 
    Q_PROPERTY(
      bool anisotropic
      READ Anisotropic
      WRITE SetAnisotropic
      NOTIFY LightingChanged
    )
 
    Q_PROPERTY(
      bool conserveMemory
      READ ConserveMemory
      WRITE SetConserveMemory
      NOTIFY LightingChanged
    )
 
    Q_PROPERTY(
      float thinWallCounter
      READ ThinWallCounter
      WRITE SetThinWallCounter
      NOTIFY LightingChanged
    )
 
    Q_PROPERTY(
      int debugVisualizationMode
      READ DebugVisualizationMode
      WRITE SetDebugVisualizationMode
      NOTIFY DebugVisualizationModeChanged
    )
 
    public: GlobalIlluminationVct();
 
    public: ~GlobalIlluminationVct() override;
 
    // Documentation inherited
    public: void LoadConfig(const tinyxml2::XMLElement *_pluginElem) override;
 
    // Documentation Inherited
    public: bool eventFilter(QObject *_obj, QEvent *_event) override;
 
    public: bool LoadGlobalIlluminationVct();
 
    public: Q_INVOKABLE void UpdateDebugVisualizationMode(int _mode);
 
    public: Q_INVOKABLE void UpdateResolution(int _axis, uint32_t _res);
 
    public: Q_INVOKABLE void UpdateOctantCount(int _axis, uint32_t _count);
 
    public: Q_INVOKABLE void SetEnabled(const bool _enabled);
 
    public: Q_INVOKABLE bool Enabled() const;
 
    signals: void EnabledChanged();
 
    signals: void SettingsChanged();
 
    signals: void LightingChanged();
 
    signals: void DebugVisualizationModeChanged();
 
    public: Q_INVOKABLE void SetResolutionX(const uint32_t _res);
 
    public: Q_INVOKABLE uint32_t ResolutionX() const;
 
    public: Q_INVOKABLE void SetResolutionY(const uint32_t _res);
 
    public: Q_INVOKABLE uint32_t ResolutionY() const;
 
    public: Q_INVOKABLE void SetResolutionZ(const uint32_t _res);
 
    public: Q_INVOKABLE uint32_t ResolutionZ() const;
 
    public: Q_INVOKABLE void SetOctantCountX(const uint32_t _octantCount);
 
    public: Q_INVOKABLE uint32_t OctantCountX() const;
 
    public: Q_INVOKABLE void SetOctantCountY(const uint32_t _octantCount);
 
    public: Q_INVOKABLE uint32_t OctantCountY() const;
 
    public: Q_INVOKABLE void SetOctantCountZ(const uint32_t _octantCount);
 
    public: Q_INVOKABLE uint32_t OctantCountZ() const;
 
    public: Q_INVOKABLE void SetBounceCount(const uint32_t _bounces);
 
    public: Q_INVOKABLE uint32_t BounceCount() const;
 
    public: Q_INVOKABLE void SetHighQuality(const bool _quality);
 
    public: Q_INVOKABLE bool HighQuality() const;
 
    public: Q_INVOKABLE void SetAnisotropic(const bool _anisotropic);
 
    public: Q_INVOKABLE bool Anisotropic() const;
 
    public: Q_INVOKABLE void SetConserveMemory(const bool _conserveMemory);
 
    public: Q_INVOKABLE bool ConserveMemory() const;
 
    public: Q_INVOKABLE void SetThinWallCounter(const float _thinWallCounter);
 
    public: Q_INVOKABLE float ThinWallCounter() const;
 
    public: Q_INVOKABLE void SetDebugVisualizationMode(const uint32_t _visMode);
 
    public: Q_INVOKABLE uint32_t DebugVisualizationMode() const;
 
    private: std::unique_ptr<GlobalIlluminationVctPrivate> dataPtr;
  };
}
}
}
#endif