localEnvironment.h

Go to the documentation of this file.

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



#pragma once

#include <vrfGuiCore/vrfGuiCore.h>
#include <vrvCore/DtCloudLayer.h>
#include <vrvCore/DtEnvironmentInterface.h>
#include <vrvCore/DtEnvironmentList.h>

#include <vrvCore/DtScene.h>

namespace makVrv
{
   class DtDe;
}

namespace makVrf
{
   class DT_DLL_VRFGUICORE DtLocalEnvironment : public makVrv::DtEnvironmentInterface
   {
   public:
      DtLocalEnvironment(makVrv::DtDe& de);
      virtual ~DtLocalEnvironment();


      virtual void setLightningPresent(bool lightningPresent);
      virtual bool lightningPresent() const;

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

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

      virtual void setWindSpeed(float windSpeed);
      virtual float windSpeed() const;

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

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

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

      virtual void updateOrAddElevationalConfiguration(
         const DtElevationalConfigurationRecord& record);

      virtual bool getElevationalConfiguration(float baseMSLAltitude,
         makArchives::DtEnvironmentRecord::DtElevationalConfigurationRecord& wRec) const;

      virtual void removeElevationalConfiguration(float baseMSLAltitude);

      virtual void moveElevationalConfiguration(
         float oldBaseMSLAltitude, float newBaseMSLAltitude);

      virtual void setWindSpeedAtMSLAltitude(float mslAltitude, float windSpeed);

      virtual float windSpeedAtMSLAltitude(float mslAltitude) const;

      virtual void setWindDirectionAtMSLAltitude(float mslAltitude, float windDirection);

      virtual float windDirectionAtMSLAltitude(float mslAltitude) const;

      virtual void setVisibilityDistanceAtMSLAltitude(float mslAltitude, float visibilityDistance);

      virtual float visibilityDistanceAtMSLAltitude(float mslAltitude) const;

      virtual void setObscurantAtMSLAltitude(float mslAltitude, VisibilityObscurant obscurant);

      virtual VisibilityObscurant obscurantAtMSLAltitude(float mslAltitude) const;

      virtual void setCloudTypeAtMSLAltitude(float mslAltitude, CloudType cloudType);

      virtual CloudType cloudTypeAtMSLAltitude(float mslAltitude) const;

      virtual void setSkyCoverageAtMSLAltitude(float mslAltitude, float skyCoverage);

      virtual float skyCoverageAtMSLAltitude(float mslAltitude) const;

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

      virtual void setAmbientAirPressure(float pressure);
      virtual float ambientAirPressure() const;

      virtual void setAirPressureAltitude(float altitude);
      virtual float airPressureAltitude() const;

      virtual void setAirTemperatureAltitude(float altitude);
      virtual float airTemperatureAltitude() const;

      virtual void setAirPressureAltitudeIsSeaLevel(bool seaLevel);
      virtual bool airPressureAltitudeIsSeaLevel() const;

      virtual void setAirTemperatureAltitudeIsSeaLevel(bool seaLevel);
      virtual bool airTemperatureAltitudeIsSeaLevel() const;

      virtual void setSeaLevelWaterConcentration(float water);
      virtual float seaLevelWaterConcentration() const;

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

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

      virtual void setGroundFogColor(const DtVector& color) override;
      virtual DtVector groundFogColor() const override;

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

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

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

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

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

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

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

      void setUnderwaterVisibilityEnabled(bool enabled);
      bool underwaterVisibilityEnabled() const;

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

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

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

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

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

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

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

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

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

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

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

      virtual void setGroundSnowAccumulation(float depth);
      virtual float groundSnowAccumulation() const;

      virtual void setRoadSnowAccumulation(float depth);
      virtual float roadSnowAccumulation() const;

      virtual void setSnowMinimumElevation(float elevation);
      virtual float snowMinimumElevation() const;
      
      virtual void setSnowElevationTransition(float elevation);
      virtual float snowElevationTransition() const;
      
      virtual void setGroundRainAccumulation(float depth);
      virtual float groundRainAccumulation() const;

      virtual void loadDefaults(bool loadOnlyFactorySettings = false);

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

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

      virtual makArchives::DtEnvironmentRecord environmentConditionRecord(const std::string&);

      virtual void saveEnvironment(const std::string& name);

      virtual void setEnvironment(const std::string& name);

      virtual void removeEnvironment(const std::string& name);

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

      virtual void getEnvironmentNames(std::vector<std::string>& names, 
         bool includeLocalOnlyEnvironment = true);

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

      virtual std::string defaultEnvironmentName() const;

      void restore() {};

      void saveAsDefaults();

      virtual void exportSettings(const std::string& filename) {};
      virtual void importSettings(const std::string& filename){};
      
      virtual void slot_coordinateSystemChanged() {};
      virtual void slot_oceanLayerAdded(const makVrv::DtOceanLayer& layer) {};
      virtual void slot_oceanLayerToBeDeleted(const makVrv::DtOceanLayer& layer) {};
      virtual void slot_oceanLayerSeaLevelChanged(const makVrv::DtOceanLayer& layer, 
         double seaLevel) {};
      virtual void slot_oceanLayerLodRangeChanged(const makVrv::DtOceanLayer& layer, 
         int range) {};
      virtual void slot_surgeDepthChanged(double depth) {};
      virtual void slot_depthOffsetChanged(double offset) {};
      virtual void autoSave();

   protected:
      makVrv::DtDe& myDe;

      makArchives::DtEnvironmentRecord myCurrentSettings;

      makVrv::DtEnvironmentList myEnvironmentList;

      DtVector myGroundFogColor;
   };
}