DtDynamicOceanObject.h

Go to the documentation of this file.

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


#pragma once

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

#include <vrvUtil/DtDouglasSeaScale.h>

#include <list>

#include <matrix/vlVector.h>

namespace makVrv
{
   class DtDe;

   class DT_DLL_VRVCORE DtDynamicOceanObject
   {
   public:
      //We should refactor the class with the DtSkyObject and DtWeatherEffectObject
      // and combine them to make a consistent way 
      // to send down environment settings to the RDE.

      class DT_DLL_VRVCORE OceanSwell
      {
      public:
         OceanSwell(double lengthInMeters = 0.0, double heightInMeters = 0.0,
            double radiansClockwiseFromNorth = 0.0);

         OceanSwell(const OceanSwell& orig);

         OceanSwell& operator =(const OceanSwell& rhs);


         void setLength(double meters);
         double length() const;

         void setHeight(double meters);
         double height() const;

         void setDirection(double radiansClockwiseFromNorth);
         double direction() const;


      private:
         double myLength;
         double myHeight;
         double myDirection;
      };

      typedef std::list<OceanSwell> OceanSwellList;


      DtDynamicOceanObject(DtDe& de, DtUniqueID id);

      virtual ~DtDynamicOceanObject();

      virtual void setSeaLevel(double meters);
      virtual double seaLevel() const;

      virtual void setLodAltitude(int meters);
      virtual int lodAltitude() const;

      virtual void setWindSpeed(double metersPerSecond);
      virtual double windSpeed() const;

      virtual void setWindDirection(double radiansClockwiseFromNorth);
      virtual double windDirection() const;

      virtual void setWindFetch(double meters);
      virtual double windFetch() const;

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

      virtual void setDouglasSeaState(DtDouglasSeaState::Scale seaState, double seaStateDirection,
         DtDouglasSwellState::Scale swellState, double swellStateDirection);
      virtual void getDouglasSeaState(DtDouglasSeaState::Scale& seaState, double& seaStateDirection,
         DtDouglasSwellState::Scale& swellState, double& swellStateDirection) const;

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

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

      virtual void setUnderwaterVisibility(double meters);
      virtual double underwaterVisibility() const;

      virtual void setSurfaceTransparency(double transparency);
      virtual double surfaceTransparency() const;

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

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

      virtual void addSwell(double lengthInMeters, double heightInMeters,
         double radiansClockwiseFromNorth);
      virtual void addSwell(const OceanSwell& swell);

      virtual const OceanSwellList& getSwells() const;

      virtual void clearSwells();

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

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

      virtual bool LockHeightData();
      virtual bool UnLockHeightData();
      virtual bool IsLockedHeightData() const;

   protected:
      double mySeaLevel;
      int myLodAltitude;

      double myWindSpeed;
      double myWindDirection;
      double myWindFetch;
      bool myWindDrivenSeaStateEnabled;

      DtDouglasSeaState::Scale myDouglasSeaState;
      double myDouglasSeaDirection;
      DtDouglasSwellState::Scale myDouglasSwellState;
      double myDouglasSwellDirection;
      double mySeaChoppiness;
      double myUnderwaterVisibility;
      double mySurfaceTransparency;
      double mySurgeDepth;
      double myDepthOffset;
      float myWaterCurrentSpeed;
      float myWaterCurrentDirection;
      bool myUnderwaterVisibilityEnabled;

      OceanSwellList myOceanSwells;
   };
}