DtVrvApplicationConfiguration.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/DtDeConfiguration.h>
#include <vrvUtil/DtDeInitializer.h>
#include <vrvUtil/DtDePathConfiguration.h>
#include <vrvCore/DtMenuConfiguration.h>
#include <vrvCore/DtToolbarConfiguration.h>
#include <vrvCore/DtPageConfiguration.h>
#include <vrvCore/DtRendererThreadingModel.h>
#include <vrvMath/DtVector2.h>
#include <vrvMath/DtVector3.h>

#include <list>
#include <map>
#include <unordered_set>

namespace makVrv
{

   class DT_DLL_VRVCORE DtVrvApplicationConfiguration : public DtConfiguration
   {

   public:

      struct UIConfiguration
      {
         DtToolbarConfiguration myToolbarConfiguration;
         DtPageConfiguration myPageConfiguration;
         DtMenuConfiguration myMenuConfiguration;
         bool                myShowStartupScreen;
         std::list<std::string> myRecentTerrains;

         template<class Archive>
         void serialize(Archive& ar, const unsigned int version)
         {
            ar& DT_SERIALIZE_MEMBER(myToolbarConfiguration);
            ar& DT_SERIALIZE_MEMBER(myPageConfiguration);
            ar& DT_SERIALIZE_MEMBER(myShowStartupScreen);
            if (version > 0 && version < 2)
            {
               ar& DT_SERIALIZE_MEMBER(myRecentTerrains);
            }
         }
      };

   public:

      DtVrvApplicationConfiguration();

      DtVrvApplicationConfiguration(const DtVrvApplicationConfiguration&);

      DtVrvApplicationConfiguration& operator=(const DtVrvApplicationConfiguration&);

      virtual ~DtVrvApplicationConfiguration();

      bool loadPlugins();

      void setLoadPlugins(bool enable);

      void addPluginFile(const std::string& file);

      const std::list<std::string>& pluginFiles() const;

      void excludePluginFile(const std::string& file);

      const std::list<std::string>& excludedPluginFiles() const;

      void setAssembleUserInterfaceComponents(bool flag);
      bool assembleUserInterfaceComponents() const;

      void setApplicationName(const std::string& appName);
      const std::string& applicationName() const;

      void setApplicationVersion(const std::string& v);
      const std::string& applicationVersion() const;

      void setApplicationIcon(const std::string& appIcon);
      const std::string& applicationIcon() const;

      const UIConfiguration& masterModeUIConfiguration() const;
      UIConfiguration& masterModeUIConfiguration();

      void setMasterModeMenuConfiguration(const DtMenuConfiguration& menuConfig);
      const DtMenuConfiguration& masterModeMenuConfiguration() const;
      DtMenuConfiguration& masterModeMenuConfiguration();

      void setMasterModeToolbarConfiguration(const DtToolbarConfiguration& toolbarConfig);
      const DtToolbarConfiguration& masterModeToolbarConfiguration() const;
      DtToolbarConfiguration& masterModeToolbarConfiguration();

      void setMasterModePageConfiguration(const DtPageConfiguration& pageConfig);
      const DtPageConfiguration& masterModePageConfiguration() const;
      DtPageConfiguration& masterModePageConfiguration();

      const UIConfiguration& slaveModeUIConfiguration() const;
      UIConfiguration& slaveModeUIConfiguration();

      void setSlaveModeMenuConfiguration(const DtMenuConfiguration& menuConfig);
      const DtMenuConfiguration& slaveModeMenuConfiguration() const;
      DtMenuConfiguration& slaveModeMenuConfiguration();

      void setSlaveModeToolbarConfiguration(const DtToolbarConfiguration& toolbarConfig);
      const DtToolbarConfiguration& slaveModeToolbarConfiguration() const;
      DtToolbarConfiguration& slaveModeToolbarConfiguration();

      void setSlaveModePageConfiguration(const DtPageConfiguration& pageConfig);
      const DtPageConfiguration& slaveModePageConfiguration() const;
      DtPageConfiguration& slaveModePageConfiguration();

      DtDeInitializer buildInitializer();


      const DtDriverConfiguration& driverConfiguration() const;
      DtDriverConfiguration& driverConfiguration();

      void setDriverConfiguration(const DtDriverConfiguration&);

      const DtGuiConfiguration& guiConfiguration() const;
      DtGuiConfiguration& guiConfiguration();

      void setGuiConfiguration(const DtGuiConfiguration&);

      const DtInputDriverConfiguration& inputDriverConfiguration() const;
      DtInputDriverConfiguration& inputDriverConfiguration();

      void setInputDriverConfiguration(const DtInputDriverConfiguration& config);

      const std::string& displayName() const;

      void setDisplayEngineName(const std::string& name);

      DtDeInitializer::DeMode deMode() const;

      void setDeMode(DtDeInitializer::DeMode mode);

      void setDeFeatures(DtDeInitializer::DeFeatures features);

      void setDefaultDrivers(const DtDeInitializer::DriverInstanceList& drivers);

      const DtDeInitializer::DriverInstanceList& defaultDrivers() const;

      void setDeConfiguration(const DtDeConfiguration& config);

      DtDeConfiguration& deConfiguration();

      const DtDeConfiguration& deConfiguration() const;

      void setCoordinateSystem(const std::string& coordinateSystem,
         const std::string& parameters);

      const std::string& coordinateSystem() const;

      const std::string& coordinateSystemParameters() const;

      void setNotifyLevel(DtDebugLog::PrintLevel level);

      DtDebugLog::PrintLevel notifyLevel() const;

      void setLogFileName(const std::string& filename);

      const std::string& logFileName() const;

      void setModelPreloadFilename(const std::string& filename);

      const std::string& modelPreloadFilename() const;

      void setDiscoveredModelPreloadFilename(const std::string& filename);

      const std::string& discoveredModelPreloadFilename() const;

      void setAutoLoadDrivers(bool autoLoad);

      bool autoLoadDrivers() const;

      void setAutoStartDrivers(const std::vector<std::string>& names);

      const std::vector<std::string>& autoStartDrivers() const;

      void setAuthorizationCodeMap(const DtDeInitializer::AuthorizationCodeMap& map);

      void addAuthorizationCodeMapping(const std::string& key,
         const std::string& value);

      void removeAuthorizationCodeMapping(const std::string& key);

      const std::string* findAuthorizationCodeValue(const std::string& key)
         const;

      void setObserverStateMap(const DtDeInitializer::ObserverStateMap& osm);

      const DtDeInitializer::ObserverStateMap& observerStateMap() const;

      void setTerrainObserverViewsEnabled(bool enable);

      bool terrainObserverViewsEnabled() const;

      const std::vector<std::string>& mappingFilesToLoad() const;

      void setMappingFilesToLoad(const std::vector<std::string>&);

      const std::vector<std::string>& modelDefinitionFilesOrDirsToMerge() const;

      void setModelDefinitionFilesOrDirsToMerge(const std::vector<std::string>&);

      const std::vector<std::string>& entityTypeMapFilesOrDirsToMerge() const;

      void setEntityTypeMapFilesOrDirsToMerge(const std::vector<std::string>&);

      const std::vector<std::string>& aggregateTypeMapFilesOrDirsToMerge() const;

      void setAggregateTypeMapFilesOrDirsToMerge(const std::vector<std::string>&);

      const std::vector<std::string>& tacticalGraphicsTypeMapFilesOrDirsToMerge() const;

      void setTacticalGraphicsTypeMapFilesOrDirsToMerge(const std::vector<std::string>&);

      const DtDeInitializer::DisplayConnections& displayConnections() const;
      DtDeInitializer::DisplayConnections& displayConnections();

      void setDisplayConnections(const DtDeInitializer::DisplayConnections& displayConnections);

      void setAutoLoadFile(const std::string& file);

      const std::string& autoLoadFile() const;

      void setRealizeMinimapModelSet(bool val);

      bool realizeMinimapModelSet() const;

      void setIndirectEntityRendering(bool val);

      bool indirectEntityRendering() const;

      void setBufferClearUsesCompute(bool val);

      bool bufferClearUsesCompute() const;

      void setNoEntityDefinitionLoading(bool val);

      bool noEntityDefinitionLoading() const;

      void setNoModelDefinitionLoading(bool val);

      bool noModelDefinitionLoading() const;

      void setNoAggregateDefinitionLoading(bool val);

      bool noAggregateDefinitionLoading() const;

      void setNoTacticalGraphicsDefinitionLoading(bool val);

      bool noTacticalGraphicsDefinitionLoading() const;

      void setNoEntityTypeMapLoading(bool val);

      bool noEntityTypeMapLoading() const;

      void setNoAggregateTypeMapLoading(bool val);

      bool noAggregateTypeMapLoading() const;

      void setNoTacticalGraphicsTypeMapLoading(bool val);

      bool noTacticalGraphicsTypeMapLoading() const;

      const std::vector<std::string>& entityElementDefinitionHierFilesOrDirs() const;

      void setEntityElementDefinitionHierFilesOrDirs(const std::vector<std::string>& filesOrDirs);

      const std::vector<std::string>& entityElementDefinitionLeafFilesOrDirs() const;

      void setEntityElementDefinitionLeafFilesOrDirs(const std::vector<std::string>& filesOrDirs);

      const std::vector<std::string>& aggregateElementDefinitionHierFilesOrDirs() const;

      void setAggregateElementDefinitionHierFilesOrDirs(const std::vector<std::string>& filesOrDirs);

      const std::vector<std::string>& aggregateElementDefinitionLeafFilesOrDirs() const;

      void setAggregateElementDefinitionLeafFilesOrDirs(const std::vector<std::string>& filesOrDirs);

      const std::vector<std::string>& tacticalGraphicsElementDefinitionHierFilesOrDirs() const;

      void setTacticalGraphicsElementDefinitionHierFilesOrDirs(const std::vector<std::string>& filesOrDirs);

      const std::vector<std::string>& tacticalGraphicsElementDefinitionLeafFilesOrDirs() const;

      void setTacticalGraphicsElementDefinitionLeafFilesOrDirs(const std::vector<std::string>& filesOrDirs);


      void setIgnoreZoomForSpeedtreeLod(bool val);

      bool ignoreZoomForSpeedtreeLod() const;

      void setSuppressHatIntersectOnAttach(bool val);

      bool suppressHatIntersectOnAttach() const;

      void setSynchronizedNtpTime(bool val);

      bool synchronizedNtpTime() const;

      void setDofConstraintsEnabled(bool enabled);

      bool dofConstraintsEnabled() const;

      virtual void setKdTreesDisabled(bool disabled);
      virtual bool kdTreesDisabled() const;

      virtual void setForceTextShaping(bool force);
      virtual bool forceTextShaping() const;

      void setStartFullScreen(bool);

      bool startFullScreen() const;

      void setUsePseudoFullScreen(bool enable);

      bool usePseudoFullScreen() const;

      void setUseHighestPriority(bool enable);

      bool useHighestPriority() const;

      void setTcpSendTimeout(double timeout);

      double tcpSendTimeout() const;

      void setAutoReconnectPeriod(double period);

      double autoReconnectPeriod() const;

      void addDefaultSettingsRecord(const std::string& recordName,
         const DtBaseRecordHolder& record);

      void removeDefaultSettingsRecord(const std::string& record);

      const DtBaseRecordHolder* findDefaultSettingsRecord(const std::string& name) const;

      void setConstrainToTerrain(bool constrain);
      bool constrainToTerrain() const;

      void setSpeedScaling(bool scale);
      bool speedScaling() const;

      void setVertexSelectsParent(bool selectsParent);
      bool vertexSelectsParent() const;

      void setDoubleBuffering(bool buffer);
      bool doubleBuffer() const;

      void setEnableVSync(bool sync);
      bool enableVSync() const;
      
      void setEnableTracyProfiling(bool enableProfiling);
      bool enableTracyProfiling() const;

      void setFrameRate(unsigned int framesPerSec);
      unsigned int frameRate() const;

      void setNumDepthBits(unsigned short numBits);
      unsigned short numDepthBits() const;

      void setNumStencilBits(unsigned short numBits);
      unsigned short numStencilBits() const;

      void setAntiAliasingLevel(unsigned short level);
      unsigned short antiAliasingLevel() const;

      void setPathConfiguration(const DtDePathConfiguration& pathConfig);

      DtDePathConfiguration& pathConfiguration();

      const DtDePathConfiguration& pathConfiguration() const;

      virtual void setSupportEmail(const std::string& supportEmail);
      virtual const std::string& supportEmail() const;

      virtual void setSupportPhoneNumber(const std::string& phoneNumber);
      virtual const std::string& supportPhoneNumber() const;

      virtual void setSalesEmail(const std::string& email);
      virtual const std::string& salesEmail() const;

      virtual void setAddressFirstLine(const std::string& address1);
      virtual const std::string& addressFirstLine() const;

      virtual void setAddressSecondLine(const std::string& address2);
      virtual const std::string& addressSecondLine() const;

      virtual void setAddressThirdLine(const std::string& address3);
      virtual const std::string& addressThirdLine() const;

      virtual void setSlogan(const std::string&);
      virtual const std::string& slogan() const;

      virtual void setWeblink(const std::string& link);
      virtual const std::string& weblink() const;

      virtual void setSvnRevision(const std::string& rev);
      virtual const std::string& svnRevision() const;

      virtual void setSvnBranch(const std::string& rev);
      virtual const std::string& svnBranch() const;

      virtual void setBuildDate(const std::string& date);
      virtual const std::string& buildDate() const;

      virtual void setAboutBoxImage(const std::string& fname);
      virtual const std::string& aboutBoxImage() const;

      virtual void setAdditionalCopyright(const std::string& copyRightString);
      virtual const std::string& additionalCopyright() const;

      virtual void setCoreDataVersionString(const std::string& coreDataVersionString);
      virtual const std::string& coreDataVersionString() const;

      virtual void setMainScreenNum(unsigned short mainScreenNum);
      virtual unsigned short mainScreenNum();

      void setExtraArgs(const std::string& argString);

      const std::string& extraArgs() const;

      void setUseReverseZBuffer(bool val);

      bool useReverseZBuffer() const;

      void setDisableDynamicTerrain(bool val);

      bool disableDynamicTerrain() const;


      virtual void setMainWindowMaximized(bool fullscreen);
      virtual bool mainWindowMaximized();
      virtual void setMainWindowWidth(int width);
      virtual int mainWindowWidth();
      virtual void setMainWindowHeight(int height);
      virtual int mainWindowHeight();
      virtual void setMainWindowXPos(int x);
      virtual int mainWindowXPos();
      virtual void setMainWindowYPos(int y);
      virtual int mainWindowYPos();



      virtual void setLimitEntityTextures(const DtVector2<int>& resolution);
      virtual const DtVector2<int>& limitEntityTextures(void) const;

      virtual void setLimitEntityTexturesProportional(bool proportional);
      virtual bool limitEntityTexturesProportional(void) const;

      virtual void excludeFromTextureLimits(const std::string& modelDef);
      virtual const std::unordered_set<std::string>& modelDefsExcludedFromTextureLimits(void) const;

      virtual void setLimitTerrainTextures(const DtVector2<int>& resolution);
      virtual const DtVector2<int>& limitTerrainTextures() const;


      virtual void setLimitEarthTerrainTextures(int resolution);
      virtual int limitEarthTerrainTextures() const;


      virtual void setLimitEarthSplattingTextures(int resolution);
      virtual int limitEarthSplattingTextures() const;

      virtual void setLimitEarthVegetationTextures(int resolution);
      virtual int limitEarthVegetationTextures() const;

      virtual void setLimitGpuMemoryPercentage(int percentageCutoff);
      virtual int limitGpuMemoryPercentage(void) const;

      virtual void setEntityGridCellSize(const DtVector3<int>& cellSize);
      virtual DtVector3<int> entityGridCellSize(void) const;

      bool indirectUsesExternalRenderer(void) const;
      void setindirectUsesExternalRenderer(bool val);

      bool enablePersistentShadowTechnique(void) const;
      void setEnablePersistentShadowTechnique(bool val);

      void disableModelSet( unsigned int );
      bool modelSetDisabled( unsigned int ) const;
      const std::set<unsigned int>& disabledModelSets() const;
      
      virtual void setRendererThreadingModel(DtRendererThreadingModel threadingModel);
      DtRendererThreadingModel rendererThreadingModel(void) const;

      void populateDataVersionString(const std::string& dataDir);

     virtual void setShowErrorDialogs(bool show);

     virtual bool showErrorDialogs() const;

     virtual void setEnableMutexesOnIndirectDataStructures( bool enabled );
     virtual bool locksEnabledOnIndirectDataStructures();

     const bool overwriteMappingsOnMerge() const;
     void setOverwriteMappingsOnMerge( bool overwrite );
   protected:

      std::string myBuildDate;
      std::string myApplicationName;
      std::string myApplicationIcon;
      bool myLoadPluginsFlag;
      bool myLoadingIgUserInterfaceFlag;
      std::list<std::string> myPluginFiles;
      std::list<std::string> myExcludedPluginFiles;
      std::string myApplicationVersion;

      DtDriverConfiguration myDriverConfiguration;
      DtGuiConfiguration myGuiConfiguration;
      DtInputDriverConfiguration myInputDriverConfiguration;
      std::string myDisplayEngineName;
      DtDePathConfiguration myPathConfiguration;
      DtDeConfiguration myDeConfiguration;
      DtDeInitializer::DeMode myDeMode;
      DtDeInitializer::DriverInstanceList myDriverInstances;
      std::string myCoordinateSystem;
      std::string myCoordinateSystemParameters;
      int myNotifyLevel;
      std::string myLogFileName;
      std::string myModelPreloadFilename;
      std::string myDiscoveredModelPreloadFilename;
      bool myAutoLoadDriversFlag;
      DtDeInitializer::AuthorizationCodeMap myAuthorizationCodeMap;
      std::vector<std::string> myAutoStartDrivers;
      DtDeInitializer::ObserverStateMap myObserverStateMap;
      std::vector<std::string> myMappingFilesToLoad;
      std::vector<std::string> myEntityElementDefinitionHiersToMerge;
      std::vector<std::string> myEntityElementDefinitionLeafsToMerge;
      std::vector<std::string> myAggregateDefinitionHiersToMerge;
      std::vector<std::string> myAggregateDefinitionLeafsToMerge;
      std::vector<std::string> myTacticalGraphicsDefinitionHiersToMerge;
      std::vector<std::string> myTacticalGraphicsDefinitionLeafsToMerge;
      std::vector<std::string> myModelDefinitionsToMerge;
      std::vector<std::string> myEntityTypeMapsToMerge;
      std::vector<std::string> myAggregateTypeMapsToMerge;
      std::vector<std::string> myTacticalGraphicsTypeMapsToMerge;
      std::set<unsigned int> myDisabledModelSets;
      DtDeInitializer::DisplayConnections myDisplayConnections;
      std::string myAutoLoadFile;

      bool myOverwriteMappingsOnMerge;
      bool myFullScreenFlag;
      bool myUsePseudoFullScreenFlag;
      bool myConstrainToTerrainFlag;
      bool mySpeedScalingFlag;
      bool myVertexSelectsParentFlag;
      bool myDoubleBufferFlag;
      bool myEnableVSyncFlag;
      bool myEnableTracyProfiling;
      bool myRealizeMinimapModelSetFlag;
      bool myIndirectEntityRendering;
      bool myBufferClearUsesCompute;
      bool myNoEntityDefinitionLoadingFlag;
      bool myNoAggregateDefinitionLoadingFlag;
      bool myNoTacticalGraphicsDefinitionLoadingFlag;
      bool myNoModelDefinitionLoadingFlag;
      bool myNoEntityTypeMapLoadingFlag;
      bool myNoAggregateTypeMapLoadingFlag;
      bool myNoTacticalGraphicsTypeMapLoadingFlag;
      bool mySynchronizedNtpTimeFlag;
      bool myDofConstraintsEnabled;
      bool myIgnoreZoomForSpeedtreeLod;
      bool mySuppressHatIntersectOnAttach;
      bool myDisableKdTrees;
      bool myForceTextShaping;

      bool myUseHighestPriorityFlag;
      double myTcpSendTimeout;
      double myAutoReconnectPeriod;

      unsigned int myFrameRate;

      unsigned short myNumDepthBits;
      unsigned short myNumStencilBits;
      unsigned short myAntiAliasingLevel;
      short myMainScreenNum;
      std::string myUdpDeviceAddress;
      std::string myUdpSendAddress;
      int myUdpPort;

      DtDeInitializer::DefaultRecordMap myDefaultRecords;
      DtDeInitializer::DeFeatures myFeatures;
      UIConfiguration myMasterModeUIConfiguration;
      UIConfiguration mySlaveModeUIConfiguration;
      std::string mySupportEmail;
      std::string mySupportPhoneNumber;
      std::string mySalesEmail;
      std::string myAddressFirstLine;
      std::string myAddressSecondLine;
      std::string myAddressThirdLine;
      std::string mySlogan;
      std::string myWeblink;
      std::string mySvnRevision;
      std::string mySvnBranch;
      std::string myAboutBoxImage;
      std::string myAdditionalCopyright;
      std::string myCoreDataVersionString;
      bool myUseReverseZBuffer;
      std::string myExtraArgs;

      bool myDisableDynamicTerrain;

      bool myMainWindowMaximized;
      int myMainWindowWidth;
      int myMainWindowHeight;
      int myMainWindowXPos;
      int myMainWindowYPos;

      bool myTerrainObserverViewsEnabled;

      bool myVerboseIndirectEntitySettings;

      DtVector2<int> myLimitEntityTexturesResolution;

      bool myLimitEntityTexturesProportional;

      DtVector2<int> myLimitTerrainTexturesResolution;

      std::unordered_set<std::string> myModelDefsExcludedFromTextureLimits;

      int myLimitGpuMemoryPercentage;

      DtVector3<int> myEntityGridCellSize = DtVector3<int>(5000,5000,5000);

      bool myIndirectUsesExternalRenderer = true;

      bool myEnablePersistentShadowTechnique = true;

      bool myShowErrorDialogs;
      bool myIndirectStructureMutexesEnabled;

      int myLimitEarthTerrainTextures = -1;
      int myLimitEarthSplattingTextures = -1;
      int myLimitEarthVegetationTextures = -1;

      DtRendererThreadingModel myRendererThreadingModel = RTM_SingleThreaded;
   };
}

BOOST_CLASS_VERSION(makVrv::DtVrvApplicationConfiguration::UIConfiguration, 2)