DtSharedEntityDisplaySettings.h

Go to the documentation of this file.

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


#pragma once

#include <vrvCore/vrvCore.h>
#include <vrvCore/DtSharedSettings.h>
#include <vrvCore/DtRecordSettingsBackup.h>
#include <makArchives/DtEntitySettingsRecord.h>

class DtEntityType;

namespace makVrv
{
   class DtSharedEntityDisplaySettings;
   
   typedef DtSharedRecordSettingsBackup<DtSharedEntityDisplaySettings,
      makArchives::DtEntitySettingsRecord> DtEntityStateSettingsBackup;

   enum class DtHeightAboveTerrainMode
   {
      ShowHatForAll = 0,
      ShowHatForSelected = 1
   };

   enum class DtColorizedModelColorType
   {
      UsePrimaryColors = 0,
      UseIconColors = 1
   };

   class DT_DLL_VRVCORE DtSharedEntityDisplaySettings
      : public DtSharedSettings
   {

   public:

      virtual ~DtSharedEntityDisplaySettings();


      bool groundClampingEnabled() const;
      void setGroundClampingEnabled( bool enabled );

      float groundClampingRadiusScale() const;
      void setGroundClampingRadiusScale( float scale );

      bool groundClampingCullingEnabled() const;
      void setGroundClampingCullingEnabled( bool enabled );

      bool orientationClampingEnabled() const;
      void setOrientationClampingEnabled( bool enabled );

      bool lifeformsUprightEnabled() const;
      void setLifeformsUprightEnabled( bool enabled );

      bool smoothingEnabled() const;
      void setSmoothingEnabled( bool enabled );

      float smoothingPeriod() const;
      void setSmoothingPeriod( float period );

      bool artPartSmoothingEnabled() const;
      void setArtPartSmoothingEnabled(bool setting);

      float artPartSmoothingPeriod() const;
      void setArtPartSmoothingPeriod(float period);

      bool entityIndicatorEnabled() const;
      void setEntityIndicatorEnabled( bool shown );

      bool rotateEntitySymbols() const;
      void setRotateEntitySymbols( bool shown );

      bool showStealthsEnabled() const;
      void setShowStealthsEnabled( bool enabled );

      bool infoPopupsOnSelectEnabled() const;
      void setInfoPopupsOnSelectEnabled( bool enabled );

      bool fireDetonateLinesEnabled() const;
      void setFireDetonateLinesEnabled( bool enabled );

      bool entityEmitterVolumesEnabled() const;
      void setEntityEmitterVolumesEnabled( bool enabled );

      bool entityHeightAboveTerrainLinesEnabled() const;
      void setEntityHeightAboveTerrainLinesEnabled( bool enabled );

      DtHeightAboveTerrainMode entityHeightAboveTerrainMode() const;
      void setEntityHeightAboveTerrainMode( DtHeightAboveTerrainMode mode );

      bool entitySimDataEnabled() const;
      void setEntitySimDataEnabled( bool enabled );

      DtColorizedModelColorType colorizedModelColorType() const;
      void setColorizedModelColorType( DtColorizedModelColorType colorType );

      makArchives::DtDynamicScaleConfigurationCollection& getOrCreateDynamicScaleCollection(const std::string& collectionName);
      bool findDynamicScaleCollectionByName(const std::string& collectionName, makArchives::DtDynamicScaleConfigurationCollection& collection) const;

      void setDynamicScaleCollectionMap(const makArchives::DtDynamicScaleConfigurationCollectionMap& collectionMap);
      const makArchives::DtDynamicScaleConfigurationCollectionMap& dynamicScaleCollectionMap() const;

      bool fixedEntityIconScalingEnabled() const;
      void setFixedEntityIconScalingEnabled( bool enabled );
      
      float entityIconScale() const;
      void setEntityIconScale( float scale );

      bool hideEmbarked2DObjects() const;
      void setHideEmbarked2DObjects( bool hide );

      bool entityOceanWakesEnabled() const;
      void setEntityOceanWakesEnabled( bool enabled );

      bool entityHullSprayEffectsEnabled() const;
      void setEntityHullSprayEffectsEnabled( bool enabled );

      bool entityBuoyancyModelsEnabled() const;
      void setEntityBuoyancyModelsEnabled( bool enabled );

      float buoyancyDefaultLODDistance() const;
      void setBuoyancyDefaultLODDistance( float distance );

      float wakeDefaultLODDistance() const;
      void setWakeDefaultLODDistance( float distance );

      float buoyancyMinimumCullDistance() const;
      void setBuoyancyMinimumCullDistance( float distance );

      makArchives::DtEntitySettingsRecord::BuoyancyCullType buoyancyCullType() const;
      void setBuoyancyCullType(makArchives::DtEntitySettingsRecord::BuoyancyCullType cullType );

      bool buoyAndBeaconIconsEnabled() const;
      void setBuoyAndBeaconIconsEnabled( bool enabled );

      unsigned int heightAboveTerrainPeriod() const;
      void setHeightAboveTerrainPeriod( unsigned int period );

      bool rotorWashEnabled() const;
      void setRotorWashEnabled(bool enabled);

      bool occupantsVisible() const;
      void setOccupantsVisible(bool visible);

      bool wheelRotationEnabled() const;
      void setWheelRotationEnabled(bool setting);

      bool adaptiveTickRateEnabled() const;
      void setAdaptiveTickRateEnabled(bool setting);


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

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

      virtual const DtEntityStateSettingsBackup* settingsBackup() const;

      virtual DtEntityStateSettingsBackup* settingsBackup();

      virtual void backup();

      static const std::string& className();

   protected:

      friend class DtReadSettingsLock<DtSharedEntityDisplaySettings>;
      friend class DtWriteSettingsLock<DtSharedEntityDisplaySettings>;

      DtSharedEntityDisplaySettings( DtSharedSettingsManager& manager );

   protected:

      bool myGroundClampingEnabled;
      float myGroundClampingRadiusScale;
      bool myGroundClampingCullingEnabled;
      bool myOrientationClampingEnabled;
      bool myLifeformsUprightEnabled;
      bool mySmoothingEnabled;
      float mySmoothingPeriod;
      bool myArtPartSmoothingEnabled;
      float myArtPartSmoothingPeriod;
      bool myShowEntityLabels;
      bool myShowStealthsEnabled;
      bool myInfoPopupsOnSelectEnabled;
      bool myFireDetonateLinesEnabled;
      bool myEntityEmitterVolumesEnabled;
      bool myEntityHeightAboveTerrainLinesEnabled;
      DtHeightAboveTerrainMode myEntityHeightAboveTerrainMode;
      bool myEntitySimDataEnabled;
      DtColorizedModelColorType myColorizedModelColorType;
      
      makArchives::DtDynamicScaleConfigurationCollectionMap myDynamicScaleCollections;
      bool myFixedEntityIconScalingEnabled;
      float myEntityIconScaleFactor;
      
      bool myHideEmbarked2DObjects;
      bool myRotateEntitySymbols;
      bool myOceanWakesEnabled;
      bool myHullSprayEffectsEnabled;
      bool myBuoyancyModelsEnabled;
      bool myBuoyAndBeaconIconsEnabled;
      unsigned int myHeightAboveTerrainPeriod;
      float myBuoyancyDefaultLODDistance;
      float myWakeDefaultLODDistance;
      float myBuoyancyMinimumCullDistance;
      makArchives::DtEntitySettingsRecord::BuoyancyCullType myBuoyancyCullType;
      bool myRotorWashEnabled;
      bool myOccupantsVisible;
      bool myWheelRotationEnabled;
      bool myAdaptiveTickRateEnabled;

      DtEntityStateSettingsBackup* myEntitySettingsBackup;
   };

}