DtObserverMode.h

Go to the documentation of this file.

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


#pragma once

#include <vrvCore/vrvCore.h>

#include <makArchives/DtObserverModeRecord.h>
#include <vrvCore/DtObserverObject.h>

#include <string>

namespace makVrv
{
   class DtDe;
   enum class DtModelSetId;

   class DT_DLL_VRVCORE DtObserverMode
   {
   public:
      static std::string theXRScaleType;
      static std::string theLinearScaleType;

   public:
      
      DtObserverMode();

      DtObserverMode( const DtObserverMode& orig );
      
      virtual ~DtObserverMode();  
      
      DtObserverMode& operator=( const DtObserverMode& orig );

      void setIntKey( int intKey );
      
      int intKey() const;
     
      void setName( const std::string& name );
      
      const std::string& name() const;
    
      void setIs2D( bool trueOrFalse );  
      
      bool is2D() const;
      
      void setModelSet( DtModelSetId modelSet );
      
      DtModelSetId modelSet() const;

      void setKeyMap( const std::string& keyMap );
      
      const std::string& keyMap() const;
      
      virtual int gainPrecision() const;
      virtual void setGainPrecision( int amt );

      virtual const std::string& sensor() const;
      virtual void setSensor( const std::string& sensorName );
      
      virtual int orbitSpeedGain() const;
      virtual void setOrbitSpeedGain( int gain );
      
      virtual int linearScaledSpeedGain() const;
      virtual void setLinearScaledSpeedGain( int gain );
       
      virtual int linearUnscaledSpeedGain() const;
      virtual void setLinearUnscaledSpeedGain( int gain );
      
     
      virtual int rotationSpeedGain() const;
      virtual void setRotationSpeedGain( int gain );
       
      virtual double modelScaleFactor() const;
      virtual void setModelScaleFactor( double modelScaleFactor );

      const std::string& modelScaleType() const;
      void setModelScaleType(const std::string& modelScaleType);

      double maxModelScaleFactor() const;
      void setMaxModelScaleFactor( double maxModelScaleFactor );

      void setSpeedScalingMode( DtObserverObject::SpeedScalingMode mode );
      DtObserverObject::SpeedScalingMode speedScalingMode() const;

      void setSpeedScalingMslModeOffset( double offset );
      double speedScalingMslModeOffset() const;

      void setCameraShakeEnabled( bool enabled );
      bool cameraShakeEnabled() const;

      void setCameraShakeIntensity( double intensity );
      double cameraShakeIntensity() const;

      void setIsFrustumBasedViewMagnificationEnabled(bool enabled);
      bool isFrustumBasedViewMagnificationEnabled() const;

      void setLodCenterSettings(const DtObserverObject::DtLodCenterSettings& settings);
      const DtObserverObject::DtLodCenterSettings& lodCenterSettings() const;

      virtual void setNorthType(DtObserverObject::NorthType northType);
      virtual DtObserverObject::NorthType northType() const;

      virtual void setColorControlEnabled(bool enabled);

      virtual bool colorControlEnabled() const;

      virtual void setColorControlInvert(bool enabled);

      virtual bool colorControlInvert() const;

      virtual void setColorControlContrast(double value);

      virtual double colorControlContrast() const;

      virtual void setColorControlBrightness(double value);

      virtual double colorControlBrightness() const;

      virtual void setColorControlColorMix(double value);

      virtual double colorControlColorMix() const;

      void setObserverSetting( int settingKey, bool value );

      bool observerSetting( int settingKey ) const;
             
      void getRecord( DtDe& de, makArchives::DtObserverModeRecord& record ) const;

      void setFromRecord( DtDe& de, const makArchives::DtObserverModeRecord& record );

      virtual bool wireframeModeChanged(bool onOrOff, bool& retVal );

       
   protected:
      DtObserverMode( int intKey );

      virtual bool hasSkyRestoreInfo();
      virtual void setHasSkyRestoreInfo(bool trueOrFalse);

      virtual bool skyRestoreInfo();
      virtual void setSkyRestoreInfo(bool onOrOff);

   protected:

      typedef std::map< int, bool> ObserverSettingsMap;

      int myIntKey;
      std::string myName; // Display name
      std::string mySensor;
      DtModelSetId myModelSet;
      bool myIs2D;
      std::string myKeyMap;
      int myOrbitSpeedGain;
      int myLinearScaledSpeedGain;
      int myLinearUnscaledSpeedGain;
      int myRotationSpeedGain;
      int myGainPrecision;
      double myModelScaleFactor;
      std::string myModelScaleType;
      double myMaxModelScaleFactor;
      DtObserverObject::SpeedScalingMode mySpeedScalingMode;
      double mySpeedScalingMslModeOffset;
      bool myCameraShakeEnabled;
      double myCameraShakeIntensity;
      bool myIsFrustumBasedViewMagnificationEnabled;
      ObserverSettingsMap myObserverSettings;
      DtObserverObject::NorthType myNorthType;
      bool myColorControlEnabled;
      bool myColorControlInvert;
      float myColorControlContrast;
      float myColorControlBrightness;
      float myColorControlColorMix;

      DtObserverObject::DtLodCenterSettings myLodCenterSettings;

      bool myHasSkyRestoreInfo;
      bool mySkyRestoreInfo;
   };
}