DtSharedOceanRenderSettings.h

Go to the documentation of this file.

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


#pragma once

#include <vrvCore/DtSharedSettings.h>
#include <vrvCore/DtSettingsBackupManager.h>
#include <makArchives/DtOceanRenderSettingsRecord.h>

#include <vrvCore/DtRecordSettingsBackup.h>

#include <string>

namespace makArchives
{
   class DtOceanRenderSettingsRecord;
}

namespace makVrv
{

   class DtDe;
   class DtSharedOceanRenderSettings;

   typedef DtSharedRecordSettingsBackup<DtSharedOceanRenderSettings,
      makArchives::DtOceanRenderSettingsRecord> DtOceanRenderSettingsBackup;

   class DT_DLL_VRVCORE DtSharedOceanRenderSettings : public DtSharedSettings
   {
   public:

      virtual ~DtSharedOceanRenderSettings();


      bool oceanPlanarReflectionsEnabled() const;
      void setOceanPlanarReflectionsEnabled( bool setting );

      float oceanPlanarReflectionsLODScale() const;
      void setOceanPlanarReflectionsLODScale( float setting );

      bool oceanPlanarReflectionsSpecifyFarClip() const;
      void setOceanPlanarReflectionsSpecifyFarClip( bool setting );

      double oceanPlanarReflectionsFarClip() const;
      void setOceanPlanarReflectionsFarClip( double setting );

      bool waveSprayEffectEnabled() const;
      void setWaveSprayEffectEnabled( bool setting );

      bool rotorWashDecalEnabled() const;
      void setRotorWashDecalEnabled( bool setting );

      double oceanHeightMapResolution() const;
      void setOceanHeightMapResolution( double setting );

      bool tidalStreamWakesEnabled() const;
      void setTidalStreamWakesEnabled(bool setting);

      double regenerateCubeMapThreshold() const;
      void setRegenerateCubeMapThreshold(double threshold);

      double regenerateHeightMapPercThreshold() const;
      void setRegenerateHeightMapPercThreshold(double threshold);

      bool omitCloudInCubeMap() const;
      void setOmitCloudInCubeMap(bool omit);

      int oceanHeightMapTextureSize() const;
      void setOceanHeightMapTextureSize(int setting);

      double staticOceanLodRange() const;
      void setStaticOceanLodRange( double range );

      int planarReflectionTextureWidth() const;
      void setPlanarReflectionTextureWidth( int w );

      int planarReflectionTextureHeight() const;
      void setPlanarReflectionTextureHeight( int h );   

      unsigned int oceanQuality() const;
      void setOceanQuality(unsigned int quality);

      unsigned int oceanSpectralModel() const;
      void setOceanSpectralModel(unsigned int spectralModel);

      bool planarReflectionsShowSpeedTrees() const;
      void setPlanarReflectionsShowSpeedTrees( bool setting );


      void setFromRecord( const makArchives::DtOceanRenderSettingsRecord& rec );

      void getRecord( makArchives::DtOceanRenderSettingsRecord& rec ) const;

      virtual const DtOceanRenderSettingsBackup* settingsBackup() const;

      virtual DtOceanRenderSettingsBackup* settingsBackup();

      virtual void backup();


      static const std::string& className();

   protected:

      friend class DtReadSettingsLock<DtSharedOceanRenderSettings>;
      friend class DtWriteSettingsLock<DtSharedOceanRenderSettings>;

      DtSharedOceanRenderSettings( DtSharedSettingsManager& manager );

   protected:

      bool myOceanPlanarReflectionsEnabled;
      float myOceanPlanarReflectionsLODScale;
      bool myOceanPlanarReflectionsSpecifyFarClip;
      double myOceanPlanarReflectionsFarClip;
      bool myWaveSprayEffectEnabled;
      bool myRotorWashDecalEnabled;
      double myOceanHeightMapResolution;
      bool myTidalStreamWakesEnabled;
      double myRegenerateCubeMapThreshold;
      double myRegenerateHeightMapPercThreshold;
      bool myOmitCloudInCubeMap;
      int myOceanHeightMapTextureSize;
      int myPlanarReflectionTextureWidth;
      int myPlanarReflectionTextureHeight;
      unsigned int myOceanQuality;
      unsigned int myOceanSpectralModel;
      double myStaticOceanLodRange;
      bool myPlanarReflectionsShowSpeedTrees;

      DtOceanRenderSettingsBackup* mySettingsBackup;

   };

}