DtObserverModeManager.h

Go to the documentation of this file.

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


#pragma once

#include <vrvCore/vrvCore.h>
#include <vrvUtil/DtBaseSettingsManager.h>
#include <vrvUtil/DtSignalConnectionManager.h>

#include <makArchives/DtObserverModesRecord.h>
#include <vrvCore/DtObserverMode.h>

#include <string>
#include <map>

namespace makVrv
{
   class DtObserverModeManager;

   class DT_DLL_VRVCORE DtObserverModesSettingsBackup 
      : public DtRecordSettingsBackup< DtBaseSettingsManager<makArchives::DtObserverModesRecord>, 
                                       makArchives::DtObserverModesRecord >
   {
   public:

      DtObserverModesSettingsBackup(DtDe& de, DtObserverModeManager* parent, 
         const std::string& name, const std::string& displayName );

      virtual ~DtObserverModesSettingsBackup();

      virtual void restoreSelected( const DtSettingsBackup* );

      virtual int currentSelectedObserverMode() const;
      virtual void setCurrentSelectedObserverMode( int modeKey );

   protected:
      int myCurrentSelectedObserverMode;
   };

   class DtDe;
   class DtStringKeyConverter;

   class DT_DLL_VRVCORE DtObserverModeManager
      : public DtBaseSettingsManager<makArchives::DtObserverModesRecord>
   {
   public:

      typedef std::map<int, DtObserverMode> ObserverModes;

   public:

      static DtObserverModeManager& instance( DtDe& de );

      virtual ~DtObserverModeManager();

      const ObserverModes& observerModes() const;

      int numberOfObserverModes() const;

      virtual int createObserverMode( const std::string& stringKey,
         const std::string& displayName );

      virtual int cloneObserverMode(  int modeKeyOrig, const std::string& newStringKey,
         const std::string& newDisplayName );

      virtual int createModeKey( const std::string& stringKey );

      virtual void removeObserverMode( int mode );

      int lookupObserverModeKey( const std::string& stringKey ) const;

      const std::string* findObserverModeStringKey( int modeKey )  const;

      bool getObserverModeById( int modeKey, DtObserverMode& result ) const;

      bool getObserverModeByName( const std::string& observerModeName,
         DtObserverMode& result );

      std::string name( int modeKey ) const;

      void setName( int modeKey, const std::string& name );

      DtModelSetId modelSet( int modeKey ) const;

      void setModelSet( int modeKey, DtModelSetId modelSet );

      std::string keyMap( int modeKey ) const;

      void setKeyMap( int modeKey, const std::string& keyMap );

      void setIs2D( int modeKey, bool trueOrFalse );

      bool is2D( int modeKey ) const;

      bool setSensor(int modeKey, const std::string& sensorName);

      std::string sensor( int modeKey ) const;

      void setGainPrecision( int modeKey, int precision );

      int gainPrecision( int modeKey ) const;

      void setModelScaleFactor( int modeKey, double modelScaleFactor );

      double modelScaleFactor( int modeKey ) const;

      void setModelScaleType( int modeKey, const std::string& modelScaleType );

      const std::string& modelScaleType( int modeKey ) const;

      void setMaxModelScaleFactor( int modeKey, double maxModelScaleFactor );

      double maxModelScaleFactor( int modeKey ) const;

      void setMaxLinearModelScaleFactor( int modeKey, double maxLinearModelScaleFactor );

      double maxLinearModelScaleFactor( int modeKey ) const;

      void setOrbitSpeedGain( int modeKey, int gain );

      int orbitSpeedGain( int modeKey ) const;

      void setLinearScaledSpeedGain( int modeKey, int gain ); 

      int linearScaledSpeedGain( int modeKey ) const;

      void setLinearUnscaledSpeedGain( int modeKey, int gain );

      int linearUnscaledSpeedGain( int modeKey ) const;

      void setRotationSpeedGain( int modeKey, int gain );

      int rotationSpeedGain( int modeKey ) const;

      void setSpeedScalingMode( int modeKey, 
         DtObserverObject::SpeedScalingMode mode );
      DtObserverObject::SpeedScalingMode speedScalingMode( int modeKey ) const;

      void setSpeedScalingMslModeOffset( int modeKey, double offset );
      double speedScalingMslModeOffset( int modeKey ) const;

      void setCameraShakeEnabled( int modeKey, bool enabled );
      bool cameraShakeEnabled( int modeKey ) const;

      void setCameraShakeIntensity( int modeKey, double intensity );
      double cameraShakeIntensity( int modeKey ) const;

      void setLodScaleCenterEnabled(int modeKey, bool enabled);
      bool lodScaleCenterEnabled(int modeKey) const;

      void setLodScaleCenterMagMinLimit(int modeKey, double limit);
      double lodScaleCenterMagMinLimit(int modeKey) const;

      void setNorthType(int modeKey, DtObserverObject::NorthType northType);
      DtObserverObject::NorthType northType(int modeKey) const;

      virtual void setColorControlEnabled(int modeKey, bool enabled);

      virtual bool colorControlEnabled(int modeKey) const;

      virtual void setColorControlInvert(int modeKey, bool enabled);

      virtual bool colorControlInvert(int modeKey) const;

      virtual void setColorControlContrast(int modeKey, double value);

      virtual double colorControlContrast(int modeKey) const;

      virtual void setColorControlBrightness(int modeKey, double value);

      virtual double colorControlBrightness(int modeKey) const;

      virtual void setColorControlColorMix(int modeKey, double value);

      virtual double colorControlColorMix(int modeKey) const;

      void setObserverSetting( int modeKey, int settingKey, bool val );

      bool observerSetting( int modeKey, int settingKey ) const;


      virtual void loadDefaultSettings( bool loadOnlyDefaultSettings );

      virtual void loadDefaultSettings( bool loadOnlyDefaultSettings, bool merge );

      using DtBaseSettingsManager<makArchives::DtObserverModesRecord>::importSettings;

      virtual void importSettings( const std::string& filepath, bool merge );

      virtual void exportObserverMode( int modeKey,
         const std::string& filepath ) const;

      virtual void setFromRecord( const makArchives::DtObserverModesRecord& record );

      virtual void setFromRecord( const makArchives::DtObserverModesRecord& record,
         bool merge );

      virtual void setObserverModeFromRecord( const makArchives::DtObserverModesRecord& record,
         int modeKey );

      virtual void getRecord( makArchives::DtObserverModesRecord& record ) const;

      virtual DtObserverModesSettingsBackup* observerModeSettingsBackup();

   public:

      boost::signalslib::signal<void (int)> observerModeKeyMapChanged;

      boost::signalslib::signal<void (int)> observerModeModelSetChanged;

      // \brief signal that the indicated observer mode's dimension changed
      boost::signalslib::signal<void (int)> observerModeIs2DChanged;

      boost::signalslib::signal<void (int)> observerModeNameChanged;

      boost::signalslib::signal<void (int)> observerModeSensorChanged;

      boost::signalslib::signal<void (int, int,bool)> observerModeSettingChanged;

      boost::signalslib::signal<void (int)> observerModeGainPrecisionChanged;

      boost::signalslib::signal<void (int)> observerModeOrbitSpeedGainChanged;

      boost::signalslib::signal<void (int)> observerModeRotationSpeedGainChanged;

      boost::signalslib::signal<void (int)> observerModeLinearScaledSpeedGainChanged;

      boost::signalslib::signal<void (int)> observerModeLinearUnscaledSpeedGainChanged;

      boost::signalslib::signal<void (int)> observerModeModelScaleFactorChanged;

      boost::signalslib::signal<void (int)> observerModeModelScaleTypeChanged;

      boost::signalslib::signal<void (int)> observerModeMaxModelScaleFactorChanged;

      boost::signalslib::signal<void (int)> observerModeMaxLinearModelScaleFactorChanged;

      boost::signalslib::signal<void (int)> observerModeSpeedScalingModeChanged;

      boost::signalslib::signal<void (int)> observerModeSpeedScalingMslModeOffsetChanged;

      boost::signalslib::signal<void (int)> observerModeCameraShakeEnabledChanged;

      boost::signalslib::signal<void (int)> observerModeCameraShakeIntensityChanged;

      boost::signalslib::signal<void(int)> observerModeLodScaleCenterEnabledChanged;

      boost::signalslib::signal<void(int)> observerModeLodScaleCenterMagMinLimitChanged;

      boost::signalslib::signal<void(int)> observerModeNorthTypeChanged;

      boost::signalslib::signal<void(int)> observerModeColorControlEnabledChanged;

      boost::signalslib::signal<void(int)> observerModeColorControlInvertChanged;

      boost::signalslib::signal<void(int)> observerModeColorControlContrastChanged;

      boost::signalslib::signal<void(int)> observerModeColorControlBrightnessChanged;

      boost::signalslib::signal<void(int)> observerModeColorControlColorMixChanged;

      boost::signalslib::signal<void (int)> observerModeAdded;

      boost::signalslib::signal<void (int)> observerModeToBeRemoved;

   protected:

      template <typename ManagerClass>
      friend ManagerClass& defaultManagerInstanceFunction( DtDe&, bool );

      template <typename ManagerClass>
      friend void defaultManagerRegisterInstanceFunction( DtDe&, ManagerClass* );

      friend class DtObserverModeManagerCreator;

      DtObserverModeManager( DtDe& );

      virtual bool applyFactoryOverrides(makArchives::DtObserverModesRecord& rec) const;

      DtObserverMode* getObserverModePtr( int modeKey );

      const DtObserverMode* getObserverModeConstPtr( int modeKey ) const;

      virtual void addObserverMode( const DtObserverMode& mode );

      virtual void clear();

      virtual void initializeBackup();

      virtual void slot_wireframeModeChanged(bool onOrOff);


   protected:

      typedef std::map<std::string,int> ObserverModesMap;

      DtStringKeyConverter* myStringKeyConverter;

      // The map of visual modes (from id to DtObserverMode)
      ObserverModes myObserverModes;

      // map from name to id
      ObserverModesMap myObserverModesMap;

      DtSignalConnectionManager mySignalConnections;

   };


   class DT_DLL_VRVCORE DtObserverModeManagerCreator : public DtVirtualBaseClass
   {
   public:

      DtObserverModeManagerCreator();

      virtual ~DtObserverModeManagerCreator();

      static DtObserverModeManagerCreator& instance( DtDe& de );

      virtual DtObserverModeManager* create( DtDe& );

   };

}