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_SIM_GUI_GLOBALILLUMINATIONCIVCT_HH_
#define GZ_SIM_GUI_GLOBALILLUMINATIONCIVCT_HH_
 
#include <memory>
 
#include "gz/sim/gui/GuiSystem.hh"
#include "gz/gui/qt.h"
 
#include <QtQml/QQmlExtensionPlugin>
 
namespace gz
{
namespace sim
{
// Inline bracket to help doxygen filtering.
inline namespace GZ_SIM_VERSION_NAMESPACE
{
  class GlobalIlluminationCiVctPrivate;
  class CiVctCascadePrivate;
 
  class GlobalIlluminationCiVct : public gz::sim::GuiSystem
  {
    Q_OBJECT
 
    Q_PROPERTY(
      bool enabled
      READ Enabled
      WRITE SetEnabled
      NOTIFY EnabledChanged
    )
 
    Q_PROPERTY(
      bool cascadesEditable
      READ CascadesEditable
      NOTIFY CascadesEditableChanged
    )
 
    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(
      int debugVisualizationMode
      READ DebugVisualizationMode
      WRITE SetDebugVisualizationMode
      NOTIFY DebugVisualizationModeChanged
    )
 
    Q_PROPERTY(
      QStringList cameraList
      READ CameraList
      NOTIFY CameraListChanged
    )
 
    public: GlobalIlluminationCiVct();
 
    public: ~GlobalIlluminationCiVct() override;
 
    // Documentation inherited
    public: void LoadConfig(const tinyxml2::XMLElement *_pluginElem) override;
 
    // Documentation Inherited
    public: bool eventFilter(QObject *_obj, QEvent *_event) override;
 
    public: bool LoadGlobalIlluminationCiVct();
 
    public: Q_INVOKABLE void UpdateDebugVisualizationMode(int _mode);
 
    public: Q_INVOKABLE bool SetEnabled(const bool _enabled);
 
    public: Q_INVOKABLE bool Enabled() const;
 
    public: Q_INVOKABLE bool CascadesEditable() const;
 
    signals: void EnabledChanged();
 
    signals: void CascadesEditableChanged();
 
    signals: void SettingsChanged();
 
    signals: void LightingChanged();
 
    signals: void DebugVisualizationModeChanged();
 
    signals: void CameraListChanged();
 
    signals: void qmlAddCascade();
 
    signals: void qmlAddCascade2(quint32 _resX, quint32 _resY, quint32 _resZ,
                                 quint32 _octX, quint32 _octY, quint32 _octZ,
                                 float _ahsX, float _ahsY, float _ahsZ,
                                 float _thinWallCounter);
 
    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 SetDebugVisualizationMode(const uint32_t _visMode);
 
    public: Q_INVOKABLE uint32_t DebugVisualizationMode() const;
 
    public: Q_INVOKABLE void OnCamareBind(const QString &_cameraName);
 
    private: void OnRefreshCamerasImpl();
 
    public: Q_INVOKABLE void OnRefreshCameras();
 
    public: Q_INVOKABLE QStringList CameraList();
 
    public: Q_INVOKABLE QObject* AddCascade();
 
    public: Q_INVOKABLE void PopCascade();
 
    public: Q_INVOKABLE QObject* GetCascade(int _idx) const;
 
    public: Q_INVOKABLE void ResetCascades();
 
    private: bool ValidSettings() const;
 
    private: std::unique_ptr<GlobalIlluminationCiVctPrivate> dataPtr;
  };
}
}
}
#endif