DtShadowSettingsManager.h

Go to the documentation of this file.

/*****************************************************************************
* Copyright (c) 2014 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 <string>
#include <map>

namespace makVrv
{
   class DtShadowSettingsManager;

   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 DtDe;
   class DtStringKeyConverter;

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

      static DtShadowSettingsManager& instance( DtDe& de );

      virtual ~DtShadowSettingsManager();
      
      virtual void createShadowSettings();

      int lookupShadowQuality( 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 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 setCloudsCastsShadows( int quality, bool castShadows);
      
      bool cloudsCastsShadows( int quality ) const;
      
      bool cloudsCastsShadows() 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 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;

      enum ShadowStabilizationScheme
      {
         EXACT_ANTI_FLICKERING,
         APPROXIMATE_ANTI_FLICKERING,
         NO_ANTI_FLICKERING
      };

      void setShadowStabilizationScheme( int quality, ShadowStabilizationScheme shadowStabilizationScheme);

      ShadowStabilizationScheme shadowStabilizationScheme( int quality ) const;

      ShadowStabilizationScheme shadowStabilizationScheme() const;

      void setAntiFlickerQuantizationFactor( int quality, float antiFlickerQuantizationFactor);

      float antiFlickerQuantizationFactor( int quality ) const;

      float antiFlickerQuantizationFactor() const;

      enum SplitDistanceComputeScheme
      {
         LOGARITHMIC_SPLIT,
         UNIFORM_SPLIT,
         MIXED_LOGARITHMIC_UNIFORM_SPLIT
      };

      void setSplitDistanceComputeScheme( int quality, SplitDistanceComputeScheme splitDistanceComputeScheme);

      SplitDistanceComputeScheme splitDistanceComputeScheme( int quality ) const;

      SplitDistanceComputeScheme splitDistanceComputeScheme() const;

      void setMixedSplitInterpolationValue( int quality, double interp);

      double mixedSplitInterpolationValue( int quality ) const;

      double mixedSplitInterpolationValue() const;

      enum SplitSelectionScheme
      {
         EYE_SPACE,
         LIGHT_SPACE
      };

      void setSplitSelectionScheme( int quality, SplitSelectionScheme splitSelectionScheme);

      SplitSelectionScheme splitSelectionScheme( int quality ) const;

      SplitSelectionScheme splitSelectionScheme() const;

      enum DataStorageScheme
      {
         TEXTURE_2D_STORAGE,
         TEXTURE_2D_ATLAS_STORAGE,
         TEXTURE_2D_ARRAY_STORAGE
      };

      void setDataStorageScheme( int quality, DataStorageScheme dataStorageScheme);

      DataStorageScheme dataStorageScheme( int quality ) const;

      DataStorageScheme dataStorageScheme() const;

      enum PreFilteringScheme
      {
         EXPONENTIAL_VARIANCE_SHADOW_MAPS,
         EXPONENTIAL_SHADOW_MAPS,
         VARIANCE_SHADOW_MAPS,
         NO_PRE_FILTERING
      };

      void setPreFilteringScheme( int quality, PreFilteringScheme preFilteringScheme);

      PreFilteringScheme preFilteringScheme( int quality ) const;

      PreFilteringScheme preFilteringScheme() const;

      enum FilteringScheme
      {
         PCF_4_TAPS,
         PCF_9_TAPS,
         PCF_16_TAPS,
         PCF_25_TAPS,
         PCF_POISSON_DISC_4_TAPS,
         PCF_POISSON_DISC_8_TAPS,
         PCF_POISSON_DISC_16_TAPS,
         PCF_POISSON_DISC_24_TAPS,
         PCF_POISSON_DISC_32_TAPS,
         NO_FILTERING
      };

      void setFilteringScheme( int quality, FilteringScheme filteringScheme);

      FilteringScheme filteringScheme( int quality ) const;

      FilteringScheme filteringScheme() const;

      enum PoissonDiskSamplingScheme
      {
         UNIFORM_SAMPLING,
         STRATIFIED_SAMPLING,
         ROTATED_SAMPLING
      };

      void setPoissonDiskSamplingScheme( int quality, PoissonDiskSamplingScheme poissonDiskSamplingScheme);

      PoissonDiskSamplingScheme poissonDiskSamplingScheme( int quality ) const;

      PoissonDiskSamplingScheme poissonDiskSamplingScheme() 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 setUseSDSM( int quality, bool useSDSM);

      bool useSDSM( int quality ) const;

      bool useSDSM() const;

      void setSDSMReadBackLatency( int quality, unsigned int sdsmReadBackLatency);

      unsigned int sdsmReadBackLatency( int quality ) const;

      unsigned int sdsmReadBackLatency() const;

      void setUseCameraDepthBufferForSDSM( int quality, bool useCameraDepthBufferForSDSM);

      bool useCameraDepthBufferForSDSM( int quality ) const;

      bool useCameraDepthBufferForSDSM() 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::signal<void (int,const std::string&)> shadowSettingsNameChanged;

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

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

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

      boost::signal<void (int,int)> shadowSettingsCloudsCastsShadowsChanged;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

      boost::signal<void (int,int)> shadowSettingsDataStorageSchemeChanged;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

      boost::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& );

      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;

      bool           myEntitiesCastsShadows;

      bool           myPropsCastsShadows;

      bool           myTerrainCastsShadows;

      bool           myCloudsCastsShadows;

      unsigned int      myNumSplits;

      bool           myVisualizeShadows;

      std::vector<float>   myPolygonOffsetFactor;

      std::vector<float>  myPolygonOffsetUnits;

      bool           myUsePolygonOffset;

      unsigned int      mySpotLightShadowMapSize;

      unsigned int      myGlobalLightShadowMapSize;

      double            myMaximumViewDistance;

      bool           myUseMaximumViewDistance;

      bool           myUseFrontFaceCulling;

      double            mySplitNearDistanceMinimumBias;

      double            mySplitNearDistanceMaximumBias;

      double            mySplitFarDistanceBias;

      double            mySDSMRenderInterval;

      float                   myShadowAmbientFactor;

      ShadowStabilizationScheme     myShadowStabilizationScheme;

      float                   myAntiFlickerQuantizationFactor;

      SplitDistanceComputeScheme    mySplitDistanceComputeScheme;

      double                     myMixedSplitInterp;

      SplitSelectionScheme       mySplitSelectionScheme;

      DataStorageScheme          myDataStorageScheme;

      PreFilteringScheme            myPreFilteringScheme;

      FilteringScheme               myFilteringScheme;

      PoissonDiskSamplingScheme     myPoissonDiskSamplingScheme;

      unsigned int               myNumPersistentPassesPerCascade;

      unsigned int               myNumAdditionalPassesPerCascade;

      unsigned int               myPcfFilterWidth;

      bool                    myBlendCascadesBoundaries;

      bool                    myUseSDSM;

      unsigned int                    mySDSMReadBackLatency;

      bool                    myUseCameraDepthBufferForSDSM;

      double                     myEVSMPositiveExponent;

      double                     myEVSMNegativeExponent;

      double                     myVSMMininumVariance;

      double                     myESMDarkeningFactor;

      std::string                myName;

      int                        myQuality;


      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& );

   };

}