DtSharedCockpitSettings.h

Go to the documentation of this file.

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


#pragma once
#include <vrvGlStudioShared/DtGlStudioShared.h>
#include <vrvGlStudioShared/DtGlStudioAttributeUpdaterFactory.h>
#include <makArchives/DtCockpitSettingsRecord.h>

#include <vrvCore/DtSharedSettings.h>
#include <vrvCore/DtUniqueID.h>
#include <vrvCore/DtRecordSettingsBackup.h>

#include <string>
#include <vector>

class DtEntityType;

namespace makVrv
{
   class DtEntityTypeMapper; 
   class DtEntityTypeMapperCreator;
   class DtModelDefinition;
   class DtDe;
   class DtObserver;
   class DtSharedCockpitSettings;

   typedef DtSharedRecordSettingsBackup<DtSharedCockpitSettings, makArchives::DtCockpitSettingsRecord> DtCockpitSettingsBackup;

   class DT_DLL_VRVGLSTUDIOSHARED DtSharedCockpitSettings : public DtSharedSettings
   {
   public:

      friend class DtReadSettingsLock<DtSharedCockpitSettings>;
      friend class DtWriteSettingsLock<DtSharedCockpitSettings>;
      friend class DtSharedSettingsManager;

      static std::string className();

      virtual ~DtSharedCockpitSettings();

      void setCockpitMapper(const DtEntityTypeMapper& cockpitTypeMapper);

      void setCockpitModelMapping(const DtEntityType& type, const std::string& definition);

      const std::vector<DtUnicode>&  mapCockpitModelDefinition(const DtEntityType& type) const;

      virtual void setDe(DtDe*);

      const DtModelDefinition* findCockpitDefinition(const std::string& str) const;

      virtual DtEntityTypeMapper* findMapperByName(const std::string& name);
      virtual const DtEntityTypeMapper* findMapperByName(const std::string& name) const;

      virtual DtEntityTypeMapper& cockpitTypeMapper();
      virtual const DtEntityTypeMapper& cockpitTypeMapper() const;

      virtual void setFromRecord(const makArchives::DtCockpitSettingsRecord& rec);

      virtual void getRecord(makArchives::DtCockpitSettingsRecord& rec ) const;

      virtual void mapperChanged(const DtEntityType& type, const DtUnicode& value, DtEntityTypeMapper& mapper);

      virtual void realizeCockpit(DtObserver* obs, DtUniqueID& id,
         const std::string& modelDefinition = "");

      virtual void unrealizeCockpit(DtObserver* obs);

      virtual void computePlatformDataPath(std::string& path) const;

      virtual const std::string& dataPath() const;

      virtual void setDataPath(const std::string& path);

      virtual void setCockpitsEnabled(bool enable);
      virtual bool cockpitsEnabled() const;

      virtual void hideEntity(const std::string& obsName);
      virtual void unHideEntity(const std::string& obsName);

      virtual void setAttachmentHas3DCockpit(const std::string& obsName,
         bool cockpit);

      virtual DtGlStudioAttributeUpdaterFactory& updaterFactory();

      virtual bool smoothingEnabled() const;
      virtual void setSmoothingEnabled(bool smooth);

      virtual double smoothingPeriod() const;
      virtual void setSmoothingPeriod(const double& period);

      const DtSettingsBackup* settingsBackup() const
      {
         return mySettingsBackup;
      }

      DtSettingsBackup* settingsBackup()
      {
         return mySettingsBackup;
      }

      virtual void backup();

   protected:

      DtSharedCockpitSettings(DtSharedSettingsManager& manager);

      //Empty vector, for returning the reference which will always be empty.
      std::vector<DtUnicode> myEmptyMappings;

      //Entity type mapping
      DtEntityTypeMapper* myCockpitTypeMapper;
      std::string myDataPath;
      bool myCockpitsEnabled;
      bool myCockpitSmoothingEnabled;
      double myCockpitSmoothingPeriod;

      DtDe* myDe;

      DtGlStudioAttributeUpdaterFactory myUpdaterFactory;
      DtCockpitSettingsBackup*                mySettingsBackup;
   };
}