DtOsgSkyObject.h

Go to the documentation of this file.

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


#pragma once

#include <vrvOsg/DtSilverliningGroup.h>
#include <vrvOsg/DtWeatherAreaGroup.h>
#include <vrvOsg/DtWeatherLayerGroup.h>
#include <vrvCore/DtSkyObject.h>
#include <vrvUtil/DtSignalConnectionManager.h>
#include <osg/TextureCubeMap>

#include <unordered_map>

namespace makVrv
{
   class DtDe;
   class DtWaterOnScreen;

   class DT_DLL_VRVOSG DtOsgSkyObject : public DtSkyObject
   {
   public:

      DtOsgSkyObject(DtDe&, DtUniqueID id);

      virtual ~DtOsgSkyObject();

      virtual void setLocation(const DtVector& location);

      virtual const DtVector& location() const;


      virtual void addCloudLayer(DtCloudLayerId layerId);
      virtual void setCloudLayerDeckType(DtCloudLayerId layerId, int deckType);
      virtual void setCloudLayerCornerRadius(DtCloudLayerId layerId, float corner);
      virtual void setCloudLayerBounds(DtCloudLayerId layerId, const DtVector& bounds);
      virtual void setCloudLayerDensity(DtCloudLayerId layerId, double density);
      virtual void setCloudLayerInfiniteFlag(DtCloudLayerId layerId, bool infinite);
      virtual void setCloudLayerRelativeFlag(DtCloudLayerId layerId, bool relative);
      virtual void setCloudLayerFadeAtAltitudeFlag(DtCloudLayerId layerId, bool fadeAtAltitude);
      virtual void setCloudLayerAltitudeIsHATFlag(DtCloudLayerId layerId, bool altitudeIsHAT);


      virtual CloudLayer* findCloudLayer(DtCloudLayerId layerId);

      //virtual int cloudLayerCount() const;     

      virtual void removeCloudLayer(DtCloudLayerId layerId);

      virtual void removeCloudLayers();

      virtual void sendCloudLayers();

      virtual void sendCloudLayer(DtCloudLayerId layerId);

      virtual void setCloudLayerEnabled(DtCloudLayerId layerId, bool enabled);

      virtual float getSunAlpha() const;

      virtual void setDrawSunAndMoonIntoEnvMap(bool draw);

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

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

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

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

      virtual void setFogColor(const DtVector& color);
      virtual const osg::Vec4& fogColor() const;
      virtual void setGroundFogColor(const DtVector& color) override;
      virtual const osg::Vec3& groundFogColor() const;

      virtual void setFogThresholdDistance(float distance);
      virtual float fogThresholdDistance() const;

      virtual void setPrecipitationEnabled(bool enabled);
      virtual bool precipitationEnabled() const;

      virtual void setPrecipitationVisibilityEffectsEnabled(bool enabled);
      virtual bool precipitationVisibilityEffectsEnabled() const;

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

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

      virtual bool computeLocalPrecipitation(const DtVector& location, int& type, float& intensity) const;

      virtual bool computeLocalGroundRainAccumulation(const DtVector& location,
         float& depth, float& blend) const;

      virtual void setCloudLayerPositionAndOrientation(DtCloudLayerId layerId, const DtVector& position, float orientation);

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

      
      virtual void setWindDirection(float radians);
      virtual float windDirection() const;
      virtual float windDirectionInDegrees() const;
      

      virtual void setMinimumWindAltitude(float alt);
      virtual float minimumWindAltitude() const;

      virtual void setMaximumWindAltitude(float alt);
      virtual float maximumWindAltitude() const;

      virtual void setLensFlare(bool enabled);
      virtual bool lensFlare() const;

      virtual void setCrepuscularRays(bool enabled);
      virtual bool crepuscularRays() const;

      virtual void setRainSplashEffect();

      void setGenerateCubeMaps(bool enabled);

      GLuint getCubeMap(const osg::ref_ptr<const osg::Camera> camera, const osg::State &state) const;

      void setFogOverride(osg::ref_ptr<const osg::Camera> camera, const osg::Vec4f& fogColor, float fogDensity);

      void clearFogOverride(osg::ref_ptr<const osg::Camera> camera);

      void clearFogOverrideForAllCameras(void);

      void setHorizonColor(const osg::Vec4f& horizonColor);

      void clearHorizonColor();

      void updatePrecipitation();

      DtSilverliningGroup *getDtSilverlining();

      DtWeatherAreaGroup* findWeatherAreaGroup();

      DtWeatherLayerGroup* findWeatherLayerGroup();

      // !\brief Checks to see if weather layer types can be disabled if no matching weather area types exist.
      virtual void disableInactiveWeatherLayers();

      // !\brief Checks to see if weather layer types should be enabled if matching weather area types exist.
      virtual void enableActiveWeatherLayers();

      void enableLighting(osg::ref_ptr<osg::Camera> camera, bool enable);

      bool shouldActivateRaindrops() const;

     void setAboveWater(bool value) { myAboveWater = value; }
      bool aboveWater() { return myAboveWater; }

      virtual bool bindFogFroxelTexture(const int unit, const unsigned int renderContextId);

      virtual float fogFroxelMaxDistance() const;

   protected:
      void updatePrecipitationSilverLining();

      void on_coordinateSystemChanged(const std::string& type);

      void applyCurrentSettings();

   protected:

      virtual void sendCloudLayer(const CloudLayer& layer);

protected:

      typedef std::unordered_map<DtCloudLayerId, CloudLayer> CloudLayerMap;

      DtDe& myDe;
      DtSignalConnectionManager mySignals;
      osg::ref_ptr<DtSilverliningGroup> mySilverliningGroup;
      osg::ref_ptr<DtWeatherAreaGroup> myWeatherAreaGroup;
      osg::ref_ptr<DtWeatherLayerGroup> myWeatherLayerGroup;
      DtUniqueID myBlowingDustWeatherLayerId;
      DtUniqueID myBlowingSandWeatherLayerId;
      DtUniqueID myBlowingSnowWeatherLayerId;
      DtUniqueID myHailLayerId;
      DtVector myLocation;
      CloudLayerMap myCloudLayerMap;
      bool myPrecipitationEnabled;
      int myPrecipitationEffectType;
      float myPrecipitationIntensity;
      float myAirTurbidity;
      float myAirTemperature;
      float myVisibleDistance;
      float myFogHeight;
      osg::Vec4f myFogColor;
      osg::Vec3f myGroundFogColor;
      float myFogThreshold;
      float myWindSpeed;
      float myWindDirection;
      float myWindAltMinimum;
      float myWindAltMaximum;
      bool myLensFlareEnabled;
      bool myCrepuscularRaysEnabled;
      bool myVisibilitySaved;
      float mySavedVisibility;
      bool myAboveWater;
      bool myPrecipitationVisibilityEffects;

      //default cube map for when the sky is turned off.
      osg::ref_ptr<osg::TextureCubeMap> myDefaultCubeMap;

   };
}