DtDistributedEnvironmentSettingsManager.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/DtEnvironmentInterface.h>

#include <vrvUtil/DtBaseSettingsManager.h>

#include <makArchives/DtDistributedEnvironmentSettingsRecord.h>

#include <vrvUtil/signalslib.h>

namespace makArchives
{
   class DtDistributedEnvironmentSettingsRecord;
}

namespace makVrv
{

   class DtDe;
   class DtDeSettings;
   class DtRecordSettingsBackupInterface;

   class DT_DLL_VRVCORE DtDistributedEnvironmentSettingsManager
      : public DtBaseSettingsManager<makArchives::DtDistributedEnvironmentSettingsRecord>
   {
   public:

      static DtDistributedEnvironmentSettingsManager& instance( DtDe& de );

      virtual ~DtDistributedEnvironmentSettingsManager();

   public:


      virtual void setListenToRemoteEnvironmentSettingsEnabled( bool val );
      virtual bool listenToRemoteEnvironmentSettingsEnabled() const;



      virtual void setFromRecord( const makArchives::DtDistributedEnvironmentSettingsRecord& rec );

      virtual void getRecord( makArchives::DtDistributedEnvironmentSettingsRecord& rec ) const;


      virtual void refreshRemoteEnvironment() const;

      virtual void getEnvironmentRecord( makArchives::DtEnvironmentRecord& rec ) const;

      boost::signalslib::signal<void( bool )> signal_listenToRemoteEnvironmentSettingsChanged;
      boost::signalslib::signal<void()> signal_refreshRemoteEnvironment;

      virtual void setDateAndTimeOfDay(int year, int month, int day, int hour,
         int minutes, double seconds);

      virtual void setUseGlobalTimeZone(bool);

      virtual void setTimeOfDay(int hour, int minutes, double seconds);

      virtual void setTimeOfDayAdvancementSpeed(float speed);


      virtual void setAirTurbidity(float turbidity);

      virtual void setAmbientAirTemperature(float temperature);

      virtual void setAmbientAirPressure(float pressure);

      virtual void setAirTemperatureAltitude(float altitude);

      virtual void setAirPressureAltitude(float altitude);

      virtual void setAirTemperatureAltitudeIsSeaLevel(bool seaLevel);

      virtual void setAirPressureAltitudeIsSeaLevel(bool seaLevel);

      virtual void setSeaLevelWaterConcentration(float water);

      virtual void setLightningPresent(bool lightningPresent);

      virtual void setPrecipitationType(unsigned int type);

      virtual void setPrecipitationIntensity(float intensity);

      virtual void setFogHeight(float value);

      virtual void setFogColor(const DtVector& color);
      virtual void setFogColor(float red, float green, float blue);  // 0.0-1.0
      virtual void setFogColor(int red, int green, int blue);        // 0-255

      virtual void removeElevationalConfiguration(float baseMSLAltitude);

      virtual void updateOrAddElevationalConfiguration(DtEnvironmentInterface::DtElevationalConfigurationRecord rec);

      virtual void setSwellState(DtDouglasSwellState::Scale state);

      virtual void setSwellStateDirection(float value);

      virtual void setSeaState(DtDouglasSeaState::Scale state);

      virtual void setSeaStateDirection(float value);

      virtual void setWindDrivenSeaStateEnabled(bool value);

      virtual void setWindFetch(float value);

      virtual void setSeaChoppiness(float value);

      virtual void setUnderwaterVisibility(float distance);

      virtual void setSurfaceTransparency(float value);

      virtual void setSurgeDepth(float value);

      virtual void setAmbientWaterTemperature(float temperature);

      virtual void setWaterCurrentSpeed(float speed);

      virtual void setWaterCurrentDirection(float direction);

      virtual void setTidalOffset(float meters);

      virtual void setTidalDirection(bool inOut);

      virtual void setThermoclineDepth(unsigned int layer, float value);

      virtual void setThermoclinePermeability(unsigned int layer, float value);

      virtual void setGroundSnowAccumulation(double depth);

      virtual void setRoadSnowAccumulation(double depth);

      virtual void setSnowMinimumElevation(double elevation);

      virtual void setSnowElevationTransition(double elevation);

      virtual void setGroundRainAccumulation(double depth);

      virtual void remoteGlobalEnvironmentDiscovered();


      boost::signalslib::signal<void(float)> signal_remoteEnvironmentAirTurbidityChanged;

      boost::signalslib::signal<void(float)> signal_remoteEnvironmentAmbientAirTemperatureChanged;

      boost::signalslib::signal<void(float)> signal_remoteEnvironmentAmbientAirPressureChanged;

      boost::signalslib::signal<void(float)> signal_remoteEnvironmentAirTemperatureAltitudeChanged;

      boost::signalslib::signal<void(float)> signal_remoteEnvironmentAirPressureAltitudeChanged;

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

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

      boost::signalslib::signal<void(float)> signal_remoteEnvironmentSeaLevelWaterConcentrationChanged;

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

      boost::signalslib::signal<void(float)> signal_remoteEnvironmentPrecitipationIntensityChanged;

      boost::signalslib::signal<void(DtEnvironmentInterface::PrecipitationType)> signal_remoteEnvironmentPrecipitationTypeChanged;

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

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

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

      boost::signalslib::signal<void(float)> signal_remoteEnvironmentTimeOfDayAdvancementSpeedChanged;

      boost::signalslib::signal<void(float)> signal_remoteEnvironmentVisibilityChanged;

      boost::signalslib::signal<void(float)> signal_remoteEnvironmentFogHeightChanged;

      boost::signalslib::signal<void(const DtVector&)> signal_remoteEnvironmentFogColorChanged;

      boost::signalslib::signal<void(float)> signal_remoteEnvironmentElevationalConfigurationRemoved;

      boost::signalslib::signal<void(DtEnvironmentInterface::DtElevationalConfigurationRecord)> signal_remoteEnvironmentElevationalConfigurationUpdatedOrAdded;

      boost::signalslib::signal<void(DtDouglasSwellState::Scale)> signal_remoteEnvironmentSwellStateChanged;

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

      boost::signalslib::signal<void(DtDouglasSeaState::Scale)> signal_remoteEnvironmentSeaStateChanged;

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

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

      boost::signalslib::signal<void(float)> signal_remoteEnvironmentWindFetchChanged;

      boost::signalslib::signal<void(float)> signal_remoteEnvironmentSeaChoppinessChanged;

      boost::signalslib::signal<void(float)> signal_remoteEnvironmentUnderWaterVisibilityChanged;

      boost::signalslib::signal<void(float)> signal_remoteEnvironmentSurfaceTransparencyChanged;

      boost::signalslib::signal<void(float)> signal_remoteEnvironmentSurgeDepthChanged;

      boost::signalslib::signal<void(float)> signal_remoteEnvironmentAmbientWaterTemperatureChanged;

      boost::signalslib::signal<void(float)> signal_remoteEnvironmentWaterCurrentSpeedChanged;

      boost::signalslib::signal<void(float)> signal_remoteEnvironmentWaterCurrentDirectionChanged;

      boost::signalslib::signal<void(float)> signal_remoteEnvironmentTidalOffsetChanged;

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

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

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

      boost::signalslib::signal<void(float)> signal_remoteEnvironmentGroundSnowAccumulationChanged;

      boost::signalslib::signal<void(float)> signal_remoteEnvironmentRoadSnowAccumulationChanged;

      boost::signalslib::signal<void(float)> signal_remoteEnvironmentSnowMinimumElevationChanged;

      boost::signalslib::signal<void(float)> signal_remoteEnvironmentSnowElevationTransitionChanged;

      boost::signalslib::signal<void(float)> signal_remoteEnvironmentGroundRainAccumulationChanged;

   protected:

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

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

      DtDistributedEnvironmentSettingsManager( DtDe& );

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

   protected:
      makArchives::DtEnvironmentRecord myEnvironmentRecord;
      bool myListenToRemoteEnvironmentSettingsEnabled;
   };

}