include/vrvCoreQt/DtEnvironmentInterface.h

Go to the documentation of this file.

/*****************************************************************************
 * Copyright (c) 2011 MAK Technologies, Inc.
 * All rights reserved.
 *****************************************************************************/
/*****************************************************************************
 * $RCSfile: DtEnvironmentInterface.h,v $ $Revision: 1.8 $ $State: Exp $
 *****************************************************************************/


#pragma once

#include <vrvCoreQt/vrvCoreQt.h>

#include <string>

class QString;

namespace makArchives
{
   class DtCloudLayerRecord;
}

namespace makVrv
{

   class DtUnicode;

   class DT_DLL_VRVCOREQT DtEnvironmentInterface
   {
   public:

      virtual void setListenToRemoteWeather( bool listen ) = 0;

      virtual void setRefreshButtonEnabled( bool enabled ) = 0;

      virtual void addCloudLayer( QString type, QString xLocation,
         QString yLocation, QString altitude, bool enabled ) = 0;

      virtual void removeAllCloudLayers() = 0;

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

      virtual void setPrecipitationEnabled(bool enabledFlag) = 0;
      virtual void setPrecipitationType(const std::string& type) = 0;
      virtual void setPrecipitationIntensity(float intensity) = 0;

      virtual void setTurbidity(float value) = 0;
      virtual void setVisibleDistance( float distance ) = 0;
      virtual void setVisibleDistanceDecimals( int decimals ) = 0;
      virtual void setVisibleDistanceUnits( const DtUnicode& units ) = 0;

      virtual void setAxisLabels( const DtUnicode& x,
         const DtUnicode& y, const DtUnicode& z ) = 0;

      virtual void queryUserForNewCloudLayer() = 0;

      virtual void queryUserToEditCloudLayer( int index ) = 0;

      //Signals when the user changes the "Listen to Remote env settings"
      //preference
      boost::signal<void (bool)> signal_remoteSettingsChanged;
      //Signals when the user requests to refresh the remote settings
      boost::signal<void ()> signal_refreshRemoteSettings;

      //Signals when the user requests to add a new cloud layer.
      boost::signal<void ()> signal_newCloudLayer;
      //Signals when the user requests to delete the selected cloud layer.
      boost::signal<void (int index)> signal_deleteCloudLayer;
      //Signals when the user requests to edit the selected cloud layer.
      boost::signal<void (int index)> signal_editCloudLayer;

      //Signals when the user requests to create a cloud layer.
      boost::signal<void (const makArchives::DtCloudLayerRecord& type)> signal_createCloudLayer;

      //Signal for when whether a cloud layer enable state has been changed by the user.
      boost::signal<void (unsigned int index,bool enabled)> signal_cloudLayerEnableChanged;

      //Signal for when the user has edited a cloud layer
      boost::signal<void (int index, const makArchives::DtCloudLayerRecord& cloudRec)> signal_cloudLayerEdited;

      //Signal for when the precipitation enabled state changes.
      boost::signal<void (float)> signal_turbidityChanged;

      //Signal for when the precipitation enabled state changes.
      boost::signal<void (float)> signal_visibilityChanged;

      //Signal for when the precipitation enabled state changes.
      boost::signal<void (bool enabled)> signal_precipitationEnableChanged;

      //Signal for when the precipitation type changes.
      boost::signal<void (const std::string& type)> signal_precipitationTypeChanged;

      //Signal for when the precipitation intensity changes.
      boost::signal<void (float intensitys)> signal_precipitationIntensityChanged;

   };

}