DtObserverSettingsManager.h

Go to the documentation of this file.

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


#pragma once
#include <vrvCore/DtSharedVisualizerTypeMappingsManager.h>
#include <vrvCore/DtStringKeyConverter.h>
#include <vrvCore/DtVisualTypeManager.h>

#include <vrvUtil/DtUnicode.h>

#include <vector>

namespace makVrv 
{ 
   class DtDe;
   class DtObserverSettingsDisplayNameProvider;
   class DtObserverSettingsToolTipProvider;
   class DtStringKeyConverter;

   class DT_DLL_VRVCORE DtObserverSettingsManager : public DtVirtualBaseClass
   { 
   public:
      friend class DtObserverSettingsManagerCreator;

      enum ObserverSetting
      {
         Global = 0,
         ShowMainModel = 1,
         EnableSpeedScaling,
         EnableTerrainDragging,
         EnableViewControl,  // Deprecated.  Use DtApplicationSettingsManager
         ConstrainToTerrain,
         ShowDustClouds,
         ShowWakes,              // Obsolete with Triton Wakes
         ShowContrails,
         ShowFootprints,
         ShowTreads,
         ShowFire,
         ShowSmokePlumes,
         ShowTrackHistories,
         ShowDetonations,
         ShowMuzzleFlashes,
         EnableModelScaling,
         DisplaySky,
         ForceNorthOrientation,
         DisplayCompass,
         DisplayGridLines,
         DisplayFeatures,
         ShowTacticalSmoke,
         EnableDynamicLights,
         EnableDynamicOcean,
         ShowRainSplash,
         ShowOceanSpray,
         ShowWaveSplash,
         ShowDepthOfField,
         ShowSensorFieldsOfView,
         InvalidSetting,
         ShowTracers,
         EnableHighDynamicRange,
         EnableVideoStreamTexture,
         USER_START = 500 // if the user wants to extend enum
      };

      typedef DtVisualTypeManager::SupportedModelSets ModelSetList;
      typedef std::vector<int> GlobalSettingsList;
      typedef std::vector<int> ProjectionSettingsList;
      typedef std::vector<int> ModelSetSettingsList;

      static DtObserverSettingsManager& instance(DtDe& de);

      virtual ~DtObserverSettingsManager();

      int registerGlobalObserverSetting( const std::string& stringKey, 
         const std::string& iconName="" );

      void registerGlobalObserverSetting( const std::string& stringKey,
         int intKey,  const std::string& iconName="" );

      int registerProjectionSpecificObserverSetting( const std::string& 
         stringKey, bool is2D, const std::string& iconName="" );

      void registerProjectionSpecificObserverSetting( const std::string& stringKey,
         int intKey, bool is2D, const std::string& iconName="" );

      int registerModelSetSpecificObserverSetting( const std::string& stringKey,
         ModelSetList modelSets, const std::string& iconName="" );

      void registerModelSetSpecificObserverSetting( const std::string& stringKey, 
         int intKey, ModelSetList modelSets, const std::string& iconName=""  );

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

      const std::string* findObserverSettingStringKey( int intKey ) const;

      const DtUnicode* findObserverSettingDisplayName( int intKey ) const;

      const DtUnicode* findObserverSettingToolTip( int intKey ) const;

      bool findObserverSettingVisualType(int intKey) const;

      const std::string* findObserverSettingIcon( int intKey ) const;

      const GlobalSettingsList& globalSettings() const;

      const ProjectionSettingsList& projectionSpecificSettings( bool is2D ) const;

      const ModelSetSettingsList& modelSetSpecificSettings( int modelSet ) const;

      bool isSettingValid( bool projection, int modelSet, int settingKey );

      inline DtObserverSettingsDisplayNameProvider& displayNameProvider() const
      {
         return *myDisplayNameProvider;
      }

   protected:

      void registerSettingKey( ModelSetList modelSets, int key );

      DtObserverSettingsManager(DtDe&);

      // Stuff needed by multiple public functions
      void registerProjectionSetting( bool projection, int key );
      void registerModelSetSetting( int modelSet, int key );
      void registerIconName( int key, const std::string& iconName );

   protected:     

      typedef std::map<bool, ProjectionSettingsList> ProjectionSettingsMap;
      typedef std::map<int,  ModelSetSettingsList> ModelSetSettingsMap;
      typedef std::map<int, std::string> IconNameMap;
      typedef std::map<int, bool> InclusionMap;

      DtDe& myDe;
      DtSharedVisualizerTypeMappingsManager& myMappingSharer;
      DtObserverSettingsDisplayNameProvider* myDisplayNameProvider;
      DtStringKeyConverter myKeyConverter;
      GlobalSettingsList myGlobalSettings;
      ProjectionSettingsMap myProjectionSpecificSettings;
      ModelSetSettingsMap myModelSetSpecificSettings;

      ProjectionSettingsList myEmptyProjectionList;
      ModelSetSettingsList myEmptyModelSetList;
      IconNameMap myIconNameMap;
   }; 

   class DT_DLL_VRVCORE DtObserverSettingsManagerCreator : public DtVirtualBaseClass
   {
   public:
      DtObserverSettingsManagerCreator();

      virtual ~DtObserverSettingsManagerCreator();

      static DtObserverSettingsManagerCreator& instance(DtDe& de);

      virtual DtObserverSettingsManager* create(DtDe&);
   };
}