DtLayeredEnvironmentDataBase.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/DtEnvironment.h>

#include <makArchives/DtEnvironmentRecord.h>
#include <makArchives/DtDateTimeRecord.h>

#include <vrvUtil/DtVirtualBaseClass.h>

#include <unordered_map>

namespace makVrv
{
   class DT_DLL_VRVCORE DtLayeredEnvironmentDataBase
   {
   public:
      DtLayeredEnvironmentDataBase();

      DtLayeredEnvironmentDataBase(const DtLayeredEnvironmentDataBase& orig);

      DtLayeredEnvironmentDataBase& operator=(const DtLayeredEnvironmentDataBase& rhs);

      virtual ~DtLayeredEnvironmentDataBase();

   public:
      virtual void addElevationalConfiguration(DtUniqueID layerId);

      virtual float removeElevationalConfiguration(DtUniqueID layerId);

      virtual void setAirPressure(float pressure);
      virtual float airPressure() const;

      virtual void setAirTemperature(float temp);
      virtual float airTemperature() const;

      virtual void setPrecipitationType(DtEnvironment::PrecipitationType precipType);
      virtual DtEnvironment::PrecipitationType precipitationType() const;

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

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

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

      virtual void setSnowMinimumElevation(float elevation);
      virtual float snowMinimumElevation() const;

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

      virtual void setGroundRainAccumulation(float accumulation);
      virtual float groundRainAccumulation() const;

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

      virtual void setFogColor(const makArchives::DtEnvironmentRecord::DtColorRecord& color);
      virtual const makArchives::DtEnvironmentRecord::DtColorRecord& fogColor() const;

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

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

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

      virtual void setSwellState(DtDouglasSwellState::Scale state);
      virtual DtDouglasSwellState::Scale swellState() const;

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

      virtual void setSeaState(DtDouglasSeaState::Scale state);
      virtual DtDouglasSeaState::Scale seaState() const;

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

      virtual void setWindDrivenSeaStateEnabled(bool value);
      virtual bool windDrivenSeaStateEnabled() const;

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

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

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

      virtual void setSurfaceTransparency(float value);
      virtual float surfaceTransparency() const;

      virtual void setSurgeDepth(float value);
      virtual float surgeDepth() 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 setDateAndTimeOfDay(int year, int month, int day, int hour, int minutes, double seconds);
      virtual void getDateAndTimeOfDay(int& year, int& month, int& day, int& hour, int& minutes, double& seconds) const;

      virtual void setUseGlobalTimeZone(bool useOrNot);
      virtual bool useGlobalTimeZone() const;

      virtual void setTimeOfDayAdvancementSpeed(float speed);
      virtual float timeOfDayAdvancementSpeed() const;

      virtual makArchives::DtEnvironmentRecord::DtElevationalConfigurationRecord* setBaseMSLAltitude(DtUniqueID layerId, float mslAltitudeInMeters);
      virtual float baseMSLAltitude(DtUniqueID layerId) const;

      virtual makArchives::DtEnvironmentRecord::DtElevationalConfigurationRecord* setWindSpeed(DtUniqueID layerId, float speedInMetersPerSecond);
      virtual float windSpeed(DtUniqueID layerId) const;

      virtual makArchives::DtEnvironmentRecord::DtElevationalConfigurationRecord* setWindDirection(DtUniqueID layerId, float offsetInRadiansFromTrueNorth);
      virtual float windDirection(DtUniqueID layerId) const;

      virtual makArchives::DtEnvironmentRecord::DtElevationalConfigurationRecord* setVisibilityDistance(DtUniqueID layerId, float visibilityInMeters);
      virtual float visibilityDistance(DtUniqueID layerId) const;

      virtual makArchives::DtEnvironmentRecord::DtElevationalConfigurationRecord* setObscurant(DtUniqueID layerId, makArchives::VisibilityObscurant obscurantEnumerationValue);
      virtual makArchives::VisibilityObscurant obscurant(DtUniqueID layerId) const;

      virtual makArchives::DtEnvironmentRecord::DtElevationalConfigurationRecord* setCloudType(DtUniqueID layerId, const std::string& cloudTypeName);
      virtual std::string cloudType(DtUniqueID layerId) const;

      virtual makArchives::DtEnvironmentRecord::DtElevationalConfigurationRecord* setCloudDensity(DtUniqueID layerId, float cloudDensity);
      virtual float cloudDensity(DtUniqueID layerId) const;

      virtual makArchives::DtEnvironmentRecord::DtElevationalConfigurationRecord* setSkyCoverage(DtUniqueID layerId, float skyCoverage);
      virtual float skyCoverage(DtUniqueID layerId) const;

      virtual makArchives::DtEnvironmentRecord::DtElevationalConfigurationRecord* findElevationRecord(DtUniqueID layerId);

      virtual const makArchives::DtEnvironmentRecord::DtElevationalConfigurationRecord* findElevationRecord(DtUniqueID layerId) const;

   protected:

      makArchives::DtEnvironmentRecord myEnvironmentRecord;
      std::unordered_map<DtUniqueID, makArchives::DtEnvironmentRecord::DtElevationalConfigurationRecord> myElevationRecords;
      makArchives::DtDateTimeRecord myDateAndTimeRecord;
      bool myUseGlobalTimeZone;
   };
}