DtSymbolDecorationSettings.h

Go to the documentation of this file.

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


#pragma once

#include <vrvCore/DtSharedSettings.h>
#include <makArchives/DtSymbolDecorationSettingsRecord.h>

#include <vrvCore/DtRecordSettingsBackup.h>
#include <vrvCore/DtModelSetEnums.h>

#include <vrvUtil/DtBaseSettingsManager.h>

#include <string>
#include <unordered_map>

namespace makVrv
{

   class DtDe;
   class DtSymbolDecorationSettings;

   typedef DtSharedRecordSettingsBackup<DtSymbolDecorationSettings,
      makArchives::DtSymbolDecorationSettingsRecord>
      DtSymbolDecorationSettingsBackup;

   class DT_DLL_VRVCORE DtSymbolDecorationSettings : public DtSharedSettings
   {
   public:

      using DecorationSet = makArchives::DtSymbolDecorationSettingsRecord::DecorationSet;
      using NamedDecorationSetMap = makArchives::DtSymbolDecorationSettingsRecord::NamedDecorationSetMap;
      using TypeToDecorationMap = std::unordered_map<std::string, DecorationSet>;
      using ModelSetAndTypeSymbolDecorationMap = makArchives::DtSymbolDecorationSettingsRecord::ModelSetAndTypeSymbolDecorationMap;

      const static std::string theDefaultEntityDecorationSetName;
      const static std::string theDefaultSurfaceEntityDecorationSetName;
      const static std::string theDefaultSubsurfaceEntityDecorationSetName;
      const static std::string theDefaultGroundEntityDecorationSetName;
      const static std::string theDefaultAirEntityDecorationSetName;
      const static std::string theDefaultMunitionEntityDecorationSetName;
      const static std::string theDefaultPropDecorationSetName;
      const static std::string theDefaultTacticalGraphicDecorationSetName;

   public:

      virtual ~DtSymbolDecorationSettings();


      void setAllPossibleSymbolDecorationsByName(const std::list<std::string>& allPossibleSymbolDecorations);

      DecorationSet getOrCreateDecorationSet( const std::string& setId ) const;

      void setDecorationSet( const std::string& setId, DecorationSet& decorationSet );

      void enableDecoration( DtModelSetId modelSet, const std::string& type, const std::string& decorationCreator );

      void disableDecoration( DtModelSetId modelSet, const std::string& type, const std::string& decorationCreator );

      bool decorationEnabled( DtModelSetId modelSet, const std::string& type, const std::string& decorationCreator ) const;

      const DecorationSet& decorationSettings(DtModelSetId modelSet, const std::string& type ) const;

      DecorationSet enabledDecorationsInSet( DtModelSetId modelSet, const std::string& type, const std::string& setId ) const;

      bool decorationEnabledForSet( DtModelSetId modelSet, const std::string& type, const std::string& setId, const std::string& decorationCreator ) const;

      void setForegroundColor( float r, float g, float b );
      void foregroundColor( float& r, float& g, float& b ) const;

      void setBackgroundColor( float r, float g, float b );
      void backgroundColor( float& r, float& g, float& b ) const;

      void setBackgroundOpacity( float opacity );
      float backgroundOpacity() const;
      
      void setLodOutAltitude(double altitude);
      double lodOutAltitude() const;

      void setShadowText( bool enabled );
      bool shadowText() const;

      void setColorByForce(bool enabled);

      bool colorByForce() const;

      const DecorationSet& enabledMouseOverDecorations(DtModelSetId modelSet, const std::string& type ) const;

      void enableMouseOverDecoration( DtModelSetId modelSet, const std::string& type, const std::string& decorationCreator );

      void disableMouseOverDecoration( DtModelSetId modelSet, const std::string& type, const std::string& decorationCreator );

      bool mouseOverDecorationEnabled( DtModelSetId modelSet, const std::string& type, const std::string& decorationCreator ) const;



      void setFromRecord( const makArchives::DtSymbolDecorationSettingsRecord& rec );

      void getRecord(
         makArchives::DtSymbolDecorationSettingsRecord& rec ) const;

      const DtSymbolDecorationSettingsBackup* settingsBackup() const;

      DtSymbolDecorationSettingsBackup* settingsBackup();

      virtual void backup();


      static const std::string& className();

   protected:

      friend class DtReadSettingsLock<DtSymbolDecorationSettings>;
      friend class DtWriteSettingsLock<DtSymbolDecorationSettings>;
      friend class DtBaseSharedSettingsManager<makArchives::DtSymbolDecorationSettingsRecord, DtSymbolDecorationSettings>;
      friend class DtSharedSettingsManager;

      DtSymbolDecorationSettings(DtSharedSettingsManager& manager);

      bool applyFactoryOverrides(
         makArchives::DtSymbolDecorationSettingsRecord& rec) const;

   protected:
      ModelSetAndTypeSymbolDecorationMap myModelSetAndTypeSymbolDecorationMap;
      ModelSetAndTypeSymbolDecorationMap myModelSetAndTypeMouseOverSymbolDecorationMap;

      std::list<std::string> myPossibleSymbolDecorations;

      NamedDecorationSetMap myNamedDecorationSettings;

      float myForegroundColorR;
      float myForegroundColorG;
      float myForegroundColorB;

      float myBackgroundColorR;
      float myBackgroundColorG;
      float myBackgroundColorB;
      float myBackgroundColorA;

      double myLodOutAltitude;

      bool myColorByForce;
      bool myShadowTextFlag;

      DtSymbolDecorationSettingsBackup* mySettingsBackup;

   };

}