DtShadowSettingsManager.h

Go to the documentation of this file.

/*****************************************************************************
* Copyright (c) 2023 MAK Technologies, Inc.
* All rights reserved.
*****************************************************************************/


#pragma once

#include <vrvCore/vrvCore.h>
#include <vrvCore/DtShadowSettingsObjectAgent.hpp>
#include <vrvCore/DtShadowSettingsObject.h>
#include <vrvUtil/DtBaseSettingsManager.h>
#include <makArchives/DtShadowSettingsCollectionRecord.h>
#include <makArchives/DtShadowSettingsRecord.h>
#include <string>
#include <map>

namespace makVrv
{
   class DtShadowSettingsManager;
   class DtDe;
   class DtStringKeyConverter;

   class DT_DLL_VRVCORE DtShadowSettingsCollectionBackup
      : public DtRecordSettingsBackup< DtBaseSettingsManager<makArchives::DtShadowSettingsCollectionRecord>,
      makArchives::DtShadowSettingsCollectionRecord >
   {
   public:

      DtShadowSettingsCollectionBackup(DtDe& de, DtShadowSettingsManager* parent,
         const std::string& name, const std::string& displayName);

      virtual ~DtShadowSettingsCollectionBackup();

      virtual void restoreSelected(const DtSettingsBackup*);

      virtual int currentSelectedShadowSettings() const;
      virtual void setCurrentSelectedShadowSettings(int quality);

   protected:
      int myCurrentSelectedShadowSettings;
   };

   class DT_DLL_VRVCORE DtShadowSettingsManager
      : public DtBaseSettingsManager<makArchives::DtShadowSettingsCollectionRecord>
   {
   public:

      static DtShadowSettingsManager& instance(DtDe& de);

      virtual ~DtShadowSettingsManager();

      virtual void createShadowSettings();

      int lookupShadowQuality(const std::string& stringKey) const;

      const std::string* findShadowQualityStringKey(int quality)  const;

      void setName(int quality, const std::string& name);

      std::string name(int quality) const;

      void setShadowsEnabled(bool shadowsEnabled);

      bool shadowsEnabled() const;

      void setShadowsEnabledOnOcean(bool enabled);

      bool shadowsEnabledOnOcean() const;

      void setEntitiesCastsShadows(int quality, bool castShadows);

      bool entitiesCastsShadows(int quality) const;

      bool entitiesCastsShadows() const;

      void setPropsCastsShadows(int quality, bool castShadows);

      bool propsCastsShadows(int quality) const;

      bool propsCastsShadows() const;

      void setTerrainCastsShadows(int quality, bool castShadows);

      bool terrainCastsShadows(int quality) const;

      bool terrainCastsShadows() const;

      void setMoonCastsShadows(int quality, bool castShadows);

      bool moonCastsShadows(int quality) const;

      bool moonCastsShadows() const;

      void setVisualizeShadows(int quality, bool visualizeShadows);

      bool visualizeShadows(int quality) const;

      bool visualizeShadows() const;

      void setNumberOfSplits(int quality, unsigned int numSplits);

      unsigned int numberOfSplits(int quality) const;

      unsigned int numberOfSplits() const;

      void setUseFrontFaceCulling(int quality, bool useFrontFaceCulling);

      bool useFrontFaceCulling(int quality) const;

      bool useFrontFaceCulling() const;

      void setUseCachedFarCascade(int quality, bool useCachedFarCascade);

      bool useCachedFarCascade() const;

      void setFarCascadeUpdateFrequency(int quality, double update_freq);

      double farCascadeUpdateFrequency();

      void setAdjustFarAndFlagsBasedOnHAT(int quality, bool adaptive);

      bool adjustFarAndFlagsBasedOnHAT();

      void setUsePolygonOffset(int quality, bool usePolygonOffset);

      bool usePolygonOffset(int quality) const;

      bool usePolygonOffset() const;

      void setPolygonOffset(int quality, unsigned int splitIndex, float factor, float units);

      float polygonOffsetFactor(int quality, unsigned int splitIndex) const;

      float polygonOffsetFactor(unsigned int splitIndex) const;

      float polygonOffsetUnits(int quality, unsigned int splitIndex) const;

      float polygonOffsetUnits(unsigned int splitIndex) const;

      void setSpotLightShadowMapSize(int quality, unsigned int size);

      unsigned int spotLightShadowMapSize(int quality) const;

      unsigned int spotLightShadowMapSize() const;

      void setGlobalLightShadowMapSize(int quality, unsigned int size);

      unsigned int globalLightShadowMapSize() const;

      unsigned int globalLightShadowMapSize(int quality) const;

      void setUseMaximumViewDistance(int quality, bool useMaximumViewDistance);

      bool useMaximumViewDistance(int quality) const;

      bool useMaximumViewDistance() const;

      void setMaximumViewDistance(int quality, double viewDistance);

      double maximumViewDistance(int quality) const;

      double maximumViewDistance() const;

      void setSplitNearDistanceMinimumBias(int quality, double bias);

      double splitNearDistanceMinimumBias(int quality) const;

      double splitNearDistanceMinimumBias() const;

      void setSplitNearDistanceMaximumBias(int quality, double bias);

      double splitNearDistanceMaximumBias(int quality) const;

      double splitNearDistanceMaximumBias() const;

      void setSplitFarDistanceBias(int quality, double bias);

      double splitFarDistanceBias(int quality) const;

      double splitFarDistanceBias() const;

      void setShadowAmbientFactor(int quality, float shadowAmbientFactor);

      float shadowAmbientFactor(int quality) const;

      float shadowAmbientFactor() const;

      void setShadowStabilizationScheme(int quality, makArchives::DtShadowSettingsRecord::ShadowStabilizationScheme shadowStabilizationScheme);

      makArchives::DtShadowSettingsRecord::ShadowStabilizationScheme shadowStabilizationScheme(int quality) const;

      makArchives::DtShadowSettingsRecord::ShadowStabilizationScheme shadowStabilizationScheme() const;

      void setAntiFlickerQuantizationFactor(int quality, float antiFlickerQuantizationFactor);

      float antiFlickerQuantizationFactor(int quality) const;

      float antiFlickerQuantizationFactor() const;

      void setSplitDistanceComputeScheme(int quality, makArchives::DtShadowSettingsRecord::SplitDistanceComputeScheme splitDistanceComputeScheme);

      makArchives::DtShadowSettingsRecord::SplitDistanceComputeScheme splitDistanceComputeScheme(int quality) const;

      makArchives::DtShadowSettingsRecord::SplitDistanceComputeScheme splitDistanceComputeScheme() const;

      void setMixedSplitInterpolationValue(int quality, double interp);

      double mixedSplitInterpolationValue(int quality) const;

      double mixedSplitInterpolationValue() const;

      void setSplitSelectionScheme(int quality, makArchives::DtShadowSettingsRecord::SplitSelectionScheme splitSelectionScheme);

      makArchives::DtShadowSettingsRecord::SplitSelectionScheme splitSelectionScheme(int quality) const;

      makArchives::DtShadowSettingsRecord::SplitSelectionScheme splitSelectionScheme() const;

      void setPreFilteringScheme(int quality, makArchives::DtShadowSettingsRecord::PreFilteringScheme preFilteringScheme);

      makArchives::DtShadowSettingsRecord::PreFilteringScheme preFilteringScheme(int quality) const;

      makArchives::DtShadowSettingsRecord::PreFilteringScheme preFilteringScheme() const;

      void setFilteringScheme(int quality, makArchives::DtShadowSettingsRecord::FilteringScheme filteringScheme);

      makArchives::DtShadowSettingsRecord::FilteringScheme filteringScheme(int quality) const;

      makArchives::DtShadowSettingsRecord::FilteringScheme filteringScheme() const;

      void setPoissonDiskSamplingScheme(int quality, makArchives::DtShadowSettingsRecord::PoissonDiskSamplingScheme poissonDiskSamplingScheme);

      makArchives::DtShadowSettingsRecord::PoissonDiskSamplingScheme poissonDiskSamplingScheme(int quality) const;

      makArchives::DtShadowSettingsRecord::PoissonDiskSamplingScheme poissonDiskSamplingScheme() const;

      void setUseViewportMulticast(int quality, bool useViewportMulticast);

      bool useViewportMulticast() const;

      void setNumPersistentPassesPerCascade(int quality, unsigned int numPasses);

      unsigned int numPersistentPassesPerCascade(int quality) const;

      unsigned int numPersistentPassesPerCascade() const;

      void setNumAdditionalPassesPerCascade(int quality, unsigned int numPasses);

      unsigned int numAdditionalPassesPerCascade(int quality) const;

      unsigned int numAdditionalPassesPerCascade() const;

      void setPcfFilterWidth(int quality, unsigned int pcfFilterWidth);

      unsigned int pcfFilterWidth(int quality) const;

      unsigned int pcfFilterWidth() const;

      void setBlendCascadesBoundaries(int quality, bool blendCascadesBoundaries);

      bool blendCascadesBoundaries(int quality) const;

      bool blendCascadesBoundaries() const;

      void setApplyShadowToAmbientLighting(int quality, bool applyShadowToAmbientLighting);

      bool applyShadowToAmbientLighting(int quality) const;

      bool applyShadowToAmbientLighting() const;

      void setEVSMPositiveExponent(int quality, double evsmPositiveExponent);

      double evsmPositiveExponent(int quality) const;

      double evsmPositiveExponent() const;

      void setEVSMNegativeExponent(int quality, double evsmNegativeExponent);

      double evsmNegativeExponent(int quality) const;

      double evsmNegativeExponent() const;

      void setVSMMininumVariance(int quality, double vsmMininumVariance);

      double vsmMininumVariance(int quality) const;

      double vsmMininumVariance() const;

      void setESMDarkeningFactor(int quality, double esmDarkeningFactor);

      double esmDarkeningFactor(int quality) const;

      double esmDarkeningFactor() const;

      void setDirty(int quality, bool dirty);

      bool dirty(int quality) const;

      bool dirty() const;

      void setCurrentPolygonOffsetCascade(unsigned int cascade);

      unsigned int currentPolygonOffsetCascade() const;


      virtual void loadDefaults();

      using DtBaseSettingsManager<makArchives::DtShadowSettingsCollectionRecord>::importSettings;

      virtual void importSettings(const std::string& filePath);

      virtual void setFromRecord(const makArchives::DtShadowSettingsCollectionRecord& record);

      virtual void setShadowSettingsFromRecord(const makArchives::DtShadowSettingsCollectionRecord& record,
         int quality);

      virtual void getRecord(makArchives::DtShadowSettingsCollectionRecord& record) const;

      virtual void getShadowSettingsFromRecord(makArchives::DtShadowSettingsCollectionRecord& record,
         int quality) const;

      virtual DtShadowSettingsCollectionBackup* shadowSettingsCollectionBackup();

   public:

      boost::signalslib::signal<void(int, const std::string&)> shadowSettingsNameChanged;

      boost::signalslib::signal<void(bool)> shadowSettingsShadowsEnabledChanged;

      boost::signalslib::signal<void(bool)> shadowSettingsShadowsEnabledOnOceanChanged;

      boost::signalslib::signal<void(int, int)> shadowSettingsEntitiesCastsShadowsChanged;

      boost::signalslib::signal<void(int, int)> shadowSettingsPropsCastsShadowsChanged;

      boost::signalslib::signal<void(int, int)> shadowSettingsTerrainCastsShadowsChanged;

      boost::signalslib::signal<void(int, int)> shadowSettingsMoonCastsShadowsChanged;

      boost::signalslib::signal<void(int, int)> shadowSettingsVisualizeShadowsChanged;

      boost::signalslib::signal<void(int, int)> shadowSettingsNumberOfSplitsChanged;

      boost::signalslib::signal<void(int, bool)> shadowSettingsUseFrontFaceCullingChanged;

      boost::signalslib::signal<void(int, bool)> shadowSettingsUseCachedFarCascadeChanged;

      boost::signalslib::signal<void(int, double)> shadowSettingsFarCascadeUpdateFreqChanged;

      boost::signalslib::signal<void(int, bool)> shadowSettingsAdjustFarAndFlagsBasedOnHATChanged;

      boost::signalslib::signal<void(int, bool)> shadowSettingsUseViewportMulticastChanged;

      boost::signalslib::signal<void(int, bool)> shadowSettingsUsePolygonOffsetChanged;

      boost::signalslib::signal<void(int, unsigned int, float)> shadowSettingsPolygonOffsetFactorChanged;

      boost::signalslib::signal<void(int, unsigned int, float)> shadowSettingsPolygonOffsetUnitsChanged;

      boost::signalslib::signal<void(int, int)> shadowSettingsSpotLightShadowMapSizeChanged;

      boost::signalslib::signal<void(int, int)> shadowSettingsGlobalLightShadowMapSizeChanged;

      boost::signalslib::signal<void(int, bool)> shadowSettingsUseMaximumViewDistanceChanged;

      boost::signalslib::signal<void(int, double)> shadowSettingsMaximumViewDistanceChanged;

      boost::signalslib::signal<void(int, double)> shadowSettingsSplitNearDistanceMinimumBiasChanged;

      boost::signalslib::signal<void(int, double)> shadowSettingsSplitNearDistanceMaximumBiasChanged;

      boost::signalslib::signal<void(int, double)> shadowSettingsSplitFarDistanceBiasChanged;

      boost::signalslib::signal<void(int, float)> shadowSettingsShadowFactorChanged;

      boost::signalslib::signal<void(int, int)> shadowSettingsShadowStabilizationSchemeChanged;

      boost::signalslib::signal<void(int, float)> shadowSettingsAntiFlickerQuantizationFactorChanged;

      boost::signalslib::signal<void(int, int)> shadowSettingsSplitDistanceComputeSchemeChanged;

      boost::signalslib::signal<void(int, double)> shadowSettingsMixedSplitInterpolationValueChanged;

      boost::signalslib::signal<void(int, int)> shadowSettingsSplitSelectionSchemeChanged;

      boost::signalslib::signal<void(int, int)> shadowSettingsPreFilteringSchemeChanged;

      boost::signalslib::signal<void(int, int)> shadowSettingsFilteringSchemeChanged;

      boost::signalslib::signal<void(int, int)> shadowSettingsPoissonDiskSamplingSchemeChanged;

      boost::signalslib::signal<void(int, unsigned int)> shadowSettingsNumPersistentPassesPerCascadeChanged;

      boost::signalslib::signal<void(int, unsigned int)> shadowSettingsNumAdditionalPassesPerCascadeChanged;

      boost::signalslib::signal<void(int, unsigned int)> shadowSettingsPcfFilterWidthChanged;

      boost::signalslib::signal<void(int, bool)> shadowSettingsBlendCascadesBoundariesChanged;

      boost::signalslib::signal<void(int, bool)> shadowSettingsApplyShadowToAmbientLightingChanged;

      boost::signalslib::signal<void(int, double)> shadowSettingsEVSMPositiveExponentChanged;

      boost::signalslib::signal<void(int, double)> shadowSettingsEVSMNegativeExponentChanged;

      boost::signalslib::signal<void(int, double)> shadowSettingsVSMMininumVarianceChanged;

      boost::signalslib::signal<void(int, double)> shadowSettingsESMDarkeningFactorChanged;

      boost::signalslib::signal<void(int, bool)> shadowSettingsDirtyChanged;

      boost::signalslib::signal<void(int)> shadowSettingsAdded;

      boost::signalslib::signal<void(int)> shadowSettingsToBeRemoved;

   protected:
      void slot_slaveAdded(const makVrv::DtDeRecord& igRecord);

   protected:

      template <typename ManagerClass>
      friend ManagerClass& defaultManagerInstanceFunction(DtDe&, bool);

      template <typename ManagerClass>
      friend void defaultManagerRegisterInstanceFunction(DtDe&, ManagerClass*);

      friend class DtShadowSettingsManagerCreator;

      DtShadowSettingsManager(DtDe&);

      virtual bool applyFactoryOverrides(makArchives::DtShadowSettingsCollectionRecord& rec) const;

      DtShadowSettingsObjectAgent* getShadowSettingsObjectAgentPtr(int quality) const;

      virtual void addShadowSettingsObjectAgent(int quality, const std::string& stringKey, DtShadowSettingsObjectAgent* agent);

      virtual void createShadowSettings(int quality, const std::string& stringKey);

      virtual void removeShadowQuality(int quality);

      virtual void clear();

      virtual void initializeBackup();

   protected:

      unsigned int        myCurrentQualitySetting;

      unsigned int        myCurrentPolygonOffsetCascade;

      int                 myQuality;

      makArchives::DtShadowSettingsRecord* myCurrentSettings;

      typedef std::map<int, DtShadowSettingsObjectAgent*> ShadowSettingsObjectAgents;

      typedef std::map<std::string, int> ShadowSettingsObjectAgentsMap;

      DtStringKeyConverter* myStringKeyConverter;

      // The map of visual modes (from id to DtObserverMode)
      mutable ShadowSettingsObjectAgents myShadowSettingsObjectAgents;

      // map from name to id
      ShadowSettingsObjectAgentsMap myShadowSettingsObjectAgentsMap;

   };


   class DT_DLL_VRVCORE DtShadowSettingsManagerCreator : public DtVirtualBaseClass
   {
   public:

      DtShadowSettingsManagerCreator();

      virtual ~DtShadowSettingsManagerCreator();

      static DtShadowSettingsManagerCreator& instance(DtDe& de);

      virtual DtShadowSettingsManager* create(DtDe&);

   };

}