DtEnvironmentConditionsInterface.h

Go to the documentation of this file.

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


#pragma once

#include <vrvCoreQt/vrvCoreQt.h>

#include <string>
#include <list>

#include <makArchives/DtCloudCoverType.h>

#include <vrvCore/DtDisplayUnitsSettingsManager.h>
#include <vrvCore/DtEnvironmentInterface.h>

namespace makVrv
{
   class DtDe;
   class DtUnicode;


   class DT_DLL_VRVCOREQT DtEnvironmentConditionsInterface
   {
   public:

      typedef std::list<DtUnicode> DtUnicodeList;

      enum AtmosphericConditionsTableColumnIndices
      {
         BaseMSLAltitudeColumnIndex = 0,
         WindDirectionColumnIndex,
         WindSpeedColumnIndex,
         VisibilityDistanceColumnIndex,
         PrimaryObscurantColumnIndex,
         CloudTypeColumnIndex,
         CloudDensityColumnIndex,
         SkyCoverageColumnIndex,
         DeleteRecordColumnIndex,
      };

   public:

      DtEnvironmentConditionsInterface(DtDe& de);

      virtual ~DtEnvironmentConditionsInterface();


      virtual void setEnvironmentConditionsNames(const DtUnicodeList& names) = 0;

      virtual DtUnicodeList environmentConditionNames() const = 0;

      virtual void setDefaultConditionName(const DtUnicode& name) = 0;



      virtual void setWindSpeed(float baseMSLAltitude, float speed) = 0;

      virtual void setElevationalWindSpeedRange(double max) = 0;

      virtual void setElevationalWindSpeedDecimals(int decimals) = 0;

      virtual void setElevationalWindSpeedUnits(const DtUnicode& units) = 0;

      virtual void setElevationalConfigurationBaseMSLAltitudeUnits(const DtUnicode& units) = 0;

      virtual void setElevationalVisibilityDistanceDecimals(int decimals) = 0;

      virtual void setElevationalVisibilityDistanceUnits(const DtUnicode& units) = 0;

      virtual void setWindDirection(float baseMSLAltitude, float degrees) = 0;

      virtual void addElevationalConfiguration(float baseMSLAltitude, 
         float windSpeed, int windDirection,
         float visibilityDistance, DtEnvironmentInterface::VisibilityObscurant obscurant, 
         DtEnvironmentInterface::CloudType cloudType, float cloudDensity, int skyCoverage, bool isRemovable = true) = 0;

      virtual void removeElevationalConfiguration(float altitude) = 0;

      virtual void moveElevationalConfiguration(float oldAltitude, float newAltitude) = 0;

      virtual void removeAllElevationalConfigurations() = 0;

      virtual int getElevationalConfigurationTableIndexByBaseMSLAltitude(float altitude) const = 0;

      virtual void setElevationalConfigurationEditableStateByColumn(float altitude, int column, bool editable, bool force = false) = 0;

      virtual float currentHighestElevationalConfigurationBaseMSLAltitude() = 0;

      virtual int elevationalConfigurationCount() const = 0;

      virtual void setPrecipitationType(unsigned int type) = 0;

      virtual void setPrecipitationIntensity(double intensity) = 0;

      virtual void setPrecipitationIntensityUnits(DtDisplayUnitsConverter::VelocityUnits unit) = 0;

      virtual void setVisibleDistance(float baseMSLAltitude, double distance) = 0;
      
      virtual void setVisibleObscurant(float baseMSLAltitude, DtEnvironmentInterface::VisibilityObscurant obscurant) = 0;

      virtual void setCloudType(float baseMSLAltitude, DtEnvironmentInterface::CloudType cloudType) = 0;

      virtual void setCloudDensity(float baseMSLAltitude, float cloudDensity) = 0;

      virtual void setSkyCoverage(float baseMSLAltitude, int skyCoverage) = 0;

      virtual void setVisibilityObscurantNames(const DtUnicodeList& names) = 0;

      virtual DtUnicodeList visibilityObscurantNames() const = 0;

      virtual void setCloudTypeNames(const DtUnicodeList& names) = 0;

      virtual DtUnicodeList cloudTypeNames() const = 0;
      
      virtual void setSkyCoverageNames(const DtUnicodeList& names) = 0;

      virtual DtUnicodeList skyCoverageNames() const = 0;

      virtual void setLightningPresent(bool lightningPresent) = 0;

      virtual void setGroundSnowAccumulation(double depth) = 0;

      virtual void setGroundSnowAccumulationDecimals(int decimals) = 0;

      virtual void setGroundSnowAccumulationRange(double step, double max, double min = 0.0) = 0;

      virtual void setGroundSnowAccumulationUnits(const DtUnicode& units) = 0;

      virtual void setRoadSnowAccumulation(double depth) = 0;

      virtual void setRoadSnowAccumulationDecimals(int decimals) = 0;

      virtual void setRoadSnowAccumulationRange(double step, double max, double min = 0.0) = 0;

      virtual void setRoadSnowAccumulationUnits(const DtUnicode& units) = 0;

      virtual void setSnowMinimumElevation(double elevation) = 0;

      virtual void setSnowMinimumElevationDecimals(int decimals) = 0;

      virtual void setSnowMinimumElevationRange(double step, double max, double min = 0.0) = 0;

      virtual void setSnowMinimumElevationUnits(const DtUnicode& units) = 0;


      virtual void setSnowElevationTransition(double elevation) = 0;

      virtual void setSnowElevationTransitionDecimals(int decimals) = 0;

      virtual void setSnowElevationTransitionRange(double step, double max, double min = 0.0) = 0;

      virtual void setSnowElevationTransitionUnits(const DtUnicode& units) = 0;


      virtual void setGroundRainAccumulation(double depth) = 0;

      virtual void setGroundRainAccumulationDecimals(int decimals) = 0;

      virtual void setGroundRainAccumulationRange(double step, double max, double min = 0.0) = 0;

      virtual void setGroundRainAccumulationUnits(const DtUnicode& units) = 0;



      virtual void setFogHeight(double height) = 0;

      virtual void setFogHeightDecimals(int decimals) = 0;

      virtual void setFogHeightUnits(const DtUnicode& units) = 0;

      virtual void setFogHeightRange(
         double step, double max, double min = 0.0) = 0;

      virtual void setFogColor(double red, double green, double blue) = 0;



      virtual void setSwellStateNames(const DtUnicodeList& names) = 0;

      virtual DtUnicodeList swellStateNames() const = 0;

      virtual void setSwellState(unsigned int index) = 0;

      virtual void setSwellState(const DtUnicode& name) = 0;

      virtual void setSwellStateDirection(double degrees) = 0;

      virtual void enableWindDrivenSeaState(bool enable) = 0;

      virtual void setSeaStateNames(const DtUnicodeList& names) = 0;

      virtual DtUnicodeList seaStateNames() const = 0;

      virtual void setSeaState(unsigned int index) = 0;

      virtual void setSeaState(const DtUnicode& name) = 0;

      virtual void setSeaStateDirection(double degrees) = 0;



      virtual void setSurfaceTransparency(double alpha) = 0;

      virtual void setUnderwaterVisibilityEnabled(bool enabled) = 0;

      virtual void setUnderwaterVisibility(double distance) = 0;

      virtual void setUnderwaterVisibilityDecimals(int decimals) = 0;

      virtual void setUnderwaterVisibilityUnits(const DtUnicode& units) = 0;

      virtual void setUnderwaterVisibilityRange(
         double step, double max, double min = 0.0) = 0;

      virtual void setWaterChoppiness(double chop) = 0;

      virtual void setWindFetch(double distance) = 0;

      virtual void setWindFetchDecimals(int decimals) = 0;

      virtual void setWindFetchUnits(const DtUnicode& units) = 0;

      virtual void setWindFetchRange(
         double step, double max, double min = 0.0) = 0;

      virtual void setSurgeDepth(double depth) = 0;

      virtual void setSurgeDepthDecimals(int decimals) = 0;

      virtual void setSurgeDepthUnits(const DtUnicode& units) = 0;

      virtual void setSurgeDepthRange(
         double step, double max, double min = 0.0) = 0;

      virtual void setDepthOffset(double offset) = 0;

      virtual void setTidalCurrentSpeedDecimals(int decimals) = 0;

      virtual void setTidalCurrentSpeedUnits(const DtUnicode& units) = 0;

      virtual void setTidalCurrentSpeedRange(double step, double max, 
         double min = 0.0) = 0;

      virtual void setTidalCurrentSpeed( double speed ) = 0;

      virtual void setTidalCurrentDirectionDecimals(int decimals) = 0;

      virtual void setTidalCurrentDirectionUnits(const DtUnicode& units) = 0;

      virtual void setTidalCurrentDirectionRange(double step, double max, 
         double min = 0.0) = 0;

      virtual void setTidalCurrentDirection( double direction ) = 0;



      virtual void setListenToRemoteWeather(bool enable) = 0;



      boost::signalslib::signal<void (const DtUnicode&)> signal_selectEnvironmentConditions;
      boost::signalslib::signal<void (const DtUnicode&)> signal_addEnvironmentConditions;
      boost::signalslib::signal<void (const DtUnicode&)> signal_removeEnvironmentConditions;
      boost::signalslib::signal<void (const DtUnicode&)> signal_saveEnvironmentConditions;
      boost::signalslib::signal<void (const DtUnicode&)> signal_setDefaultEnvironmentConditions;

      boost::signalslib::signal<void ()> signal_addElevationalConfiguration;
      boost::signalslib::signal<void (float)> signal_removeElevationalConfiguration;
      boost::signalslib::signal<void(float, float)> signal_elevationalConfigurationAltitudeChanged;
      boost::signalslib::signal<void(float, float, int, float, DtEnvironmentInterface::VisibilityObscurant, DtEnvironmentInterface::CloudType, float, int)> signal_elevationalConfigurationUpdated;

      boost::signalslib::signal<void (int)> signal_changePrecipitationType;
      boost::signalslib::signal<void (double)> signal_changePrecipitationIntensity;

      boost::signalslib::signal<void (makArchives::DtCloudCoverType)> signal_cloudCoverChanged;
      boost::signalslib::signal<void (bool)> signal_lightningPresentChanged;

      boost::signalslib::signal<void(double)> signal_changeGroundSnowAccumulation;
      boost::signalslib::signal<void(double)> signal_changeRoadSnowAccumulation;
      boost::signalslib::signal<void(double)> signal_changeSnowMinimumElevation;
      boost::signalslib::signal<void(double)> signal_changeSnowElevationTransition;

      boost::signalslib::signal<void(double)> signal_changeGroundRainAccumulation;

      boost::signalslib::signal<void (double)> signal_changeFogHeight;
      boost::signalslib::signal<void (double, double, double)> signal_changeFogColor;

      boost::signalslib::signal<void (unsigned int)> signal_changeSwellState;
      boost::signalslib::signal<void (double)> signal_changeSwellStateDirection;

      boost::signalslib::signal<void (bool)> signal_enableWindDrivenSeaState;
      boost::signalslib::signal<void (unsigned int)> signal_changeSeaState;
      boost::signalslib::signal<void (double)> signal_changeSeaStateDirection;

      boost::signalslib::signal<void (double)> signal_changeSeaSurfaceTransparency;
      boost::signalslib::signal<void (bool)> signal_changeUnderWaterVisibilityEnabled;
      boost::signalslib::signal<void (double)> signal_changeUnderWaterVisibility;
      boost::signalslib::signal<void (double)> signal_changeSeaChoppiness;
      boost::signalslib::signal<void (double)> signal_changeWindFetch;
      boost::signalslib::signal<void (double)> signal_changeSurgeDepth;
      boost::signalslib::signal<void (double)> signal_changeDepthOffset;
      boost::signalslib::signal<void (double)> signal_changeTidalCurrentSpeed;
      boost::signalslib::signal<void (double)> signal_changeTidalCurrentDirection;

      boost::signalslib::signal<void (bool)> signal_changeRemoteSettings;
      boost::signalslib::signal<void ()> signal_requestRemoteSettings;

   protected:
      DtDe& myDe;
   };
}