DtSkyObject.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/DtUniqueID.h>

#include <vrvUtil/DtVirtualBaseClass.h>
#include <vrvUtil/signalslib.h>

#include <matrix/vlVector.h>

// Because there's an X header out there that defines it, and gets included
// (unncessarily) by SensorFX code.  The next version of Sensim should
// fix this, and then the undef could be removed (4-24-2014)
#ifdef None
#undef None
#endif

namespace makVrv
{
   class DtDe;
   class DtSkyObjectSignaler;

   class DT_DLL_VRVCORE DtSkyObject
   {
   public:

      enum PrecipitationType
      {
         None = 0,
         Rain = 1,
         SnowWet = 2,
         SnowDry = 3,
         Sleet = 4

      };

      const static float DefaultDayLightLevel;
      const static float DefaultFogVisibilityLevel; 

      DtSkyObject(DtDe& de, DtUniqueID id);

      virtual ~DtSkyObject();

      virtual void setLocation( const DtVector& location );

      virtual void setDateAndTime(unsigned short year, unsigned char month,
         unsigned char day, unsigned char hour, unsigned char minutes,
         double seconds, bool observeDaylightSavings);

      virtual void addCloudLayer(int deckType, const DtVector& location,
         const DtVector& bounds, double density, bool infinite, bool relative);

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

      virtual int cloudLayerCount() const;     

      virtual void removeCloudLayer(int index) = 0;

      virtual void removeCloudLayers() = 0;

      virtual void setAirTurbidity(float turbidity) = 0;

      virtual void setAmbientAirTemperature(float temperature) = 0;

      virtual void setVisibleDistance(float distance) = 0;

      virtual void setPrecipitationEnabled(bool enabled) = 0;

      virtual void setPrecipitationType(int type) = 0;

      virtual void setPrecipitationIntensity(float intensity) = 0;

      virtual void setCloudLayerPosition(int index, double xCoord,
         double yCoord) = 0;

      virtual void setFogHeight(float meters) = 0;

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

      virtual void setWindSpeed(float metersPerSecond) = 0;

      virtual void setWindDirection(float radians) = 0;

      //@(
      void setAmbientLightValue( float ambientLightValue );
      float ambientLightValue() const;

      //@(
      void setIsDay( bool isDay );
      bool isDay() const;


   protected:

      float myAmbientLightValue;
      bool myIsDay;
      DtSkyObjectSignaler& mySignaler;
   };

   class DT_DLL_VRVCORE DtSkyObjectSignaler : public DtVirtualBaseClass
   {
   public:
      static DtSkyObjectSignaler& instance(DtDe& de);

      virtual ~DtSkyObjectSignaler();



      boost::signal<void (int deckType, const DtVector& location,
         const DtVector& bounds, double density, bool infinite, bool relative)> 
         signal_addCloudLayer;

      boost::signal<void (int index,bool enabled) > 
         signal_cloudLayerEnabledChanged;

      boost::signal<void (int index) > signal_removeCloudLayer;

      boost::signal<void ()> signal_removeCloudLayers;

      boost::signal<void (float turbidity)> signal_airTurbidityChanged;

      boost::signal<void (float temperature)> signal_ambientAirTemperatureChanged;

      boost::signal<void (float distance)> signal_visibleDistanceChanged;

      boost::signal<void (bool enabled)> signal_precipitationEnabledChanged;

      boost::signal<void (int type)> signal_precipitationTypeChanged;

      boost::signal<void (float intensity)> signal_precipitationIntensityChanged;

      boost::signal<void (int index, double xCoord,
         double yCoord)> signal_cloudLayerPositionChanged;

      boost::signal<void (float meters)> signal_fogHeightChanged;

      boost::signal<void (const DtVector& color)> signal_fogColorChanged;

      boost::signal<void (float metersPerSecond)> signal_windSpeedChanged;

      boost::signal<void (float radians) > signal_windDirectionChanged;

      boost::signal<void (float)> signal_ambientLightValueChanged;

      boost::signal<void (bool)> signal_isDayChanged;

   protected:
      DtSkyObjectSignaler();
   };
}