environmentalStateManager.h

Go to the documentation of this file.

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



#pragma once

#include <vlutil/vlString.h>
#include <vrfExtObjects/vrfWeatherStateEnums.h>
#include "vrfobjcore/vrfobjcoreDefines.h"

class DtSimManager;
class DtVrfObject;
class DtObjectType;
class DtEnvironmentalStateSetter;
class DtChangeGlobalWeatherCommand;
class DtChangeTimeOfDayCommand;
class DtVector;

class DT_DLL_vrfobjcore DtEnvironmentalStateManager
{
private:

   DtEnvironmentalStateManager(const DtEnvironmentalStateManager & orig);
   const DtEnvironmentalStateManager & operator=(const DtEnvironmentalStateManager & 
      orig);
   DtEnvironmentalStateManager();

public:

   DtEnvironmentalStateManager(DtSimManager* simManager);

   virtual ~DtEnvironmentalStateManager();

   virtual bool init();

   virtual void tick();

   virtual DtSimManager* simManager();

   virtual bool globalEnvironmentSimulatedLocally() const;

   virtual bool startEnvironmentSimulationLocally();


   virtual void setAirTurbidity(double factor);
   virtual double airTurbidity() const;


   virtual void setAmbientAirTemperature(double temp);
   virtual double ambientAirTemperature() const;


   virtual void setCloudState(DtVrfWeatherCloudState current);
   virtual DtVrfWeatherCloudState cloudState() const;


   virtual void setPrecipitationIntensity(double factor);
   virtual double precipitationIntensity() const;


   virtual void setPrecipitationType(DtVrfWeatherPrecipitationType current);
   virtual DtVrfWeatherPrecipitationType precipitationType() const;


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


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


   virtual void setVisibility(double value);
   virtual double visibility() const;


   virtual double illumination(const DtVector& localPosition) const;

   virtual void setGlobalWeather(const DtChangeGlobalWeatherCommand& command);

   virtual void setTimeOfDay(double secondsPastMidnight);
   virtual void setTimeOfDay(const DtChangeTimeOfDayCommand& command);
   virtual double timeOfDay() const;

   virtual void setTimeOfDayAdvancementSpeed(double speed);
   virtual void setTimeOfDayAdvancementSpeed(const DtChangeTimeOfDayCommand& command);
   virtual double timeOfDayAdvancementSpeed() const;


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


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


   virtual void setWaterCurrentSpeed(double waterCurrentSpeed);
   virtual double waterCurrentSpeed() const;


   virtual void setWaterCurrentDirection(double waterCurrentDirection);
   virtual double waterCurrentDirection() const;


   virtual void setAmbientWaterTemperature(double waterTemperature);
   virtual double ambientWaterTemperature() const;


   virtual void setTidalOffset(double tidalOffset);
   virtual double tidalOffset() const;


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

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


   virtual void setSwellStateDirection(double direction);
   virtual double swellStateDirection() const;


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


   virtual void setSeaStateDirection(double direction);
   virtual double seaStateDirection() const;


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


   virtual void setChoppiness(double choppiness);
   virtual double choppiness() const;


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


   virtual void setThermoclineLayer1Depth(double depth);
   virtual double thermoclineLayer1Depth() const;
   virtual void setThermoclineLayer1Permeability(double depth);
   virtual double thermoclineLayer1Permeability() const;
   virtual void setThermoclineLayer2Depth(double depth);
   virtual double thermoclineLayer2Depth() const;
   virtual void setThermoclineLayer2Permeability(double depth);
   virtual double thermoclineLayer2Permeability() const;
   virtual void setThermoclineLayer3Depth(double depth);
   virtual double thermoclineLayer3Depth() const;
   virtual void setThermoclineLayer3Permeability(double depth);
   virtual double thermoclineLayer3Permeability() const;
   virtual void setThermoclineLayer4Depth(double depth);
   virtual double thermoclineLayer4Depth() const;
   virtual void setThermoclineLayer4Permeability(double depth);
   virtual double thermoclineLayer4Permeability() const;
   virtual void setThermoclineLayer5Depth(double depth);
   virtual double thermoclineLayer5Depth() const;
   virtual void setThermoclineLayer5Permeability(double depth);
   virtual double thermoclineLayer5Permeability() const;

protected:
   static void objectAddedCallback(DtVrfObject* object, void* usr);
   virtual void processObjectAdded(DtVrfObject* object);

   static void objectRemovedCallback(DtVrfObject* object, void* usr);
   virtual void processObjectRemoved(DtVrfObject* object);

   virtual void createGlobalEnvironmentObject();

   virtual DtObjectType globalEnvironmentObjectType() const;

   virtual DtEnvironmentalStateSetter* createLocalEnvironmentalStateSetter();
   virtual DtEnvironmentalStateSetter* createRemoteEnvironmentalStateSetter();

protected:
   DtSimManager* mySimManager;

   DtVrfObject* myGlobalEnvironmentObject;
   DtEnvironmentalStateSetter* myEnvironmentalStateSetter;

   bool myFirstTick;
};