DtEnvironmentInterface.h

Go to the documentation of this file.

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


#pragma once

#include <vrvCore/vrvCore.h>
#include <vrvCore/DtSkyObject.h>

#include <vrfExtObjects/vrfWeatherStateEnums.h>

#include <string>
#include <vector>

class DtVector;

namespace makArchives
{
   class DtCloudLayerRecord;
   class DtEnvironmentRecord;
}

namespace makVrv
{
   class DtDe;
   class DtAgentManagerInterface;
   class DtSettingsBackup;
   class DtOceanLayer;
   class DtCloudLayer;

   class DT_DLL_VRVCORE DtEnvironmentInterface
   {
   public:

      typedef enum
      {
         None = DtSkyObject::None, 
         Rain = DtSkyObject::Rain, 
         Snow = DtSkyObject::SnowWet, 
      } PrecipitationType;

      DtEnvironmentInterface();

      virtual ~DtEnvironmentInterface();

      virtual void clear() = 0;

      virtual void getRecord(makArchives::DtEnvironmentRecord& record) = 0;

      virtual void setFromRecord(
         const makArchives::DtEnvironmentRecord& record) = 0;



      virtual void saveEnvironment(const std::string& envName) = 0;

      virtual void removeEnvironment(const std::string& envName) = 0;

      virtual void renameEnvironment(
         const std::string& oldName, const std::string& newName) = 0;

      virtual void getEnvironmentNames(std::vector<std::string>& names) = 0;

      virtual void setEnvironment(const std::string& envName) = 0;

      virtual void setDefaultEnvironmentName(const std::string& name) = 0;

      virtual std::string defaultEnvironmentName() const = 0;











      virtual void setCloudCover(DtVrfWeatherCloudState cloudCover) = 0;
      virtual DtVrfWeatherCloudState cloudCover() const = 0;



      virtual int cloudLayerCount() const = 0;

      virtual const DtCloudLayer& cloudLayer(unsigned int layerId) const = 0;

      virtual void setCloudLayer(
         unsigned int layerId, const DtCloudLayer& layer) = 0;

      virtual void addCloudLayer(const DtCloudLayer& layer) = 0;

      virtual void removeCloudLayer(unsigned int layerId) = 0;

      virtual void removeCloudLayers() = 0;

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



      virtual bool useCustomCloudCover() const = 0;
      virtual void setUseCustomCloudCover(bool enabled) = 0;


      virtual void setAirTurbidity(float turbidity) = 0;
      virtual float airTurbidity() const = 0;


      virtual void setVisibleDistance(float distance) = 0;
      virtual float visibleDistance() const = 0;


      virtual void setPrecipitationType(PrecipitationType type) = 0;
      virtual PrecipitationType precipitationType() const = 0;


      virtual void setPrecipitationIntensity(float intensity) = 0;
      virtual float precipitationIntensity() const = 0;


      virtual void setWindSpeed(float speed) = 0;
      virtual float windSpeed() const = 0;


      virtual void setWindDirection(float direction) = 0;
      virtual float windDirection() const = 0;


      virtual void setAmbientAirTemperature(float temperature) = 0;
      virtual float ambientAirTemperature() const = 0;


      virtual void setFogHeight(float height) = 0;
      virtual float fogHeight() const = 0;


      virtual void setFogColor(const DtVector& color) = 0;
      virtual DtVector fogColor() const = 0;


      virtual void setSeaState(int state) = 0;
      virtual int seaState() const = 0;


      virtual void setSeaStateDirection(float dir) = 0;
      virtual float seaStateDirection() const = 0;


      virtual void setWindDrivenSeaState(bool enabled) = 0;
      virtual bool windDrivenSeaState() const = 0;


      virtual void setSwellState(int state) = 0;
      virtual int swellState() const = 0;


      virtual void setSwellStateDirection(float dir) = 0;
      virtual float swellStateDirection() const = 0;


      virtual void setWindFetch(float distance) = 0;
      virtual float windFetch() const = 0;


      virtual void setSeaChoppiness(float chop) = 0;
      virtual float seaChoppiness() const = 0;


      virtual void setUnderwaterVisibility(float distance) = 0;
      virtual float underwaterVisibility() const = 0;


      virtual void setWaterSurfaceTransparency(float normalizedValue) = 0;
      virtual float waterSurfaceTransparency() const = 0;


      virtual void setSurgeDepth(float meters) = 0;
      virtual float surgeDepth() const = 0;


      virtual void setDepthOffset(float meters) = 0;
      virtual float depthOffset() const = 0;


      virtual void setAmbientWaterTemperature(float temperature) = 0;
      virtual float ambientWaterTemperature() const = 0;


      virtual void setWaterCurrentSpeed(float speed) = 0;
      virtual float waterCurrentSpeed() const = 0;



      virtual void setWaterCurrentDirection(float direction) = 0;
      virtual float waterCurrentDirection() const = 0;


      virtual void setTidalOffset(float meters) = 0;
      virtual float tidalOffset() const = 0;


      virtual void setTidalDirection(bool inOut) = 0;
      virtual bool tidalDirection() const = 0;


      virtual void setThermoclineDepth(unsigned int layer, float depth) = 0;
      virtual float thermoclineDepth(unsigned int layer) const = 0;


      virtual void setThermoclinePermeability(
         unsigned int layer, float permeability) = 0;
      virtual float thermoclinePermeability(unsigned int layer) const = 0;

      //Called from CTOR to load the default settings.
      virtual void loadDefaults(bool loadOnlyFactorySettings = false) = 0;

      // Restores to backup up environment from startup default
      virtual void restore() = 0;

      //Called to save the current settings as the default settings.
      virtual void saveAsDefaults() = 0;


      virtual void exportSettings(const std::string& filename) = 0;
      virtual void importSettings(const std::string& filename) = 0;

   protected:


      virtual void slot_coordinateSystemChanged() = 0;

      virtual void slot_oceanLayerAdded(const DtOceanLayer& layer) = 0;

      virtual void slot_oceanLayerToBeDeleted(const DtOceanLayer& layer) = 0;

      virtual void slot_oceanLayerSeaLevelChanged(
         const DtOceanLayer& layer, double seaLevel) = 0;

      virtual void slot_oceanLayerLodRangeChanged(
         const DtOceanLayer& layer, int range) = 0;

      virtual void slot_surgeDepthChanged(double depth) = 0;

      virtual void slot_depthOffsetChanged(double offset) = 0;
   };
}