DtEnvironmentConditionsInterface.h

Go to the documentation of this file.

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


#pragma once

#include <vrvCoreQt/vrvCoreQt.h>

#include <string>
#include <list>

#include <vrfExtObjects/vrfWeatherStateEnums.h>

namespace makVrv
{
   class DtDe;
   class DtCloudLayer;
   class DtUnicode;


   class DT_DLL_VRVCOREQT DtEnvironmentConditionsInterface
   {
   public:

      typedef std::list<DtUnicode> StringList;

      DtEnvironmentConditionsInterface(DtDe& de);

      virtual ~DtEnvironmentConditionsInterface();


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

      virtual StringList environmentConditionNames() const = 0;

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

      virtual void setAdvanceConditionsVisible(bool show) = 0;



      virtual void setWindSpeed(double speed) = 0;

      virtual void setWindSpeedDecimals(int decimals) = 0;

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

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

      virtual void setWindDirection(double degrees) = 0;

      virtual void setPrecipitationType(unsigned int type) = 0;

      virtual void setPrecipitationIntensity(double intensity) = 0;

      virtual void setVisibleDistance(double distance) = 0;

      virtual void setVisibleDistanceDecimals(int decimals) = 0;

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

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



      virtual void addCloudLayer(const DtUnicode& type, 
         const DtUnicode& xLocation, const DtUnicode& yLocation, 
         const DtUnicode& altitude, bool enabled, bool infinite) = 0;

      virtual void setCloudLayer(unsigned int  index, const DtUnicode& type,
         const DtUnicode& xLocation, const DtUnicode& yLocation, 
         const DtUnicode& altitude, bool enabled, bool infinite) = 0;

      virtual void removeAllCloudLayers() = 0;

      virtual void removeCloudLayer(unsigned int  index) = 0;

      virtual void setCloudLayerEnabled(unsigned int index, bool enabled) = 0;

      virtual void setCloudCover( DtVrfWeatherCloudState cloudCover ) = 0;

      virtual void setAxisLabels(
         const DtUnicode& x, const DtUnicode& y, const DtUnicode& z) = 0;

      virtual void queryUserForNewCloudLayer() = 0;

      virtual void queryUserToEditCloudLayer(unsigned int index) = 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 setAirTurbidity(double turbidity) = 0;



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

      virtual StringList 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 StringList& names) = 0;

      virtual StringList 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 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 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::signal<void (const DtUnicode&)> signal_selectEnvironmentConditions;
      boost::signal<void (const DtUnicode&)> signal_addEnvironmentConditions;
      boost::signal<void (const DtUnicode&)> signal_removeEnvironmentConditions;
      boost::signal<void (const DtUnicode&)> signal_saveEnvironmentConditions;
      boost::signal<void (const DtUnicode&)> signal_setDefaultEnvironmentConditions;

      boost::signal<void (double)> signal_changeWindSpeed;
      boost::signal<void (double)> signal_changeWindDirection;

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

      boost::signal<void (double)> signal_changeVisibility;
      boost::signal<void (DtVrfWeatherCloudState)> signal_cloudCoverChanged;

      boost::signal<void ()> signal_requestNewCloudLayer;
      boost::signal<void (const DtCloudLayer&)> signal_addNewCloudLayer;
      boost::signal<void (unsigned int)> signal_requestedEditCloudLayer;
      boost::signal<void (unsigned int, const DtCloudLayer&)> signal_changeCloudLayer;
      boost::signal<void (unsigned int)> signal_deleteCloudLayer;
      boost::signal<void (unsigned int, bool)> signal_enableCloudLayer;

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

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

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

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

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

   protected:
      DtDe& myDe;
   };
}