DtEntitySettingsRecord.h

Go to the documentation of this file.

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


#pragma once

#include <makArchives/makArchives.h>
#include <makArchives/DtSerialize.h>

#include <limits>
#include <string>
#include <map>

namespace makArchives
{
   class DT_DLL_MAKARCHIVES DtDynamicScaleConfiguration
   {
      friend class boost::serialization::access;

   public:
      DtDynamicScaleConfiguration(double altitude, float scale)
         : myAltitude(altitude)
         , myScale(scale)
      { }

      DtDynamicScaleConfiguration()
         : myAltitude(std::numeric_limits<double>::min())
         , myScale(1.0)
      { }

      ~DtDynamicScaleConfiguration() = default;
      DtDynamicScaleConfiguration(
         const DtDynamicScaleConfiguration &other) = default;
      DtDynamicScaleConfiguration &operator=(
         const DtDynamicScaleConfiguration &other) = default;

      template <typename Archive>
      void serialize(Archive& ar, unsigned int version)
      {
         ar & BOOST_SERIALIZATION_NVP(myAltitude);
         ar & BOOST_SERIALIZATION_NVP(myScale);
      }

   public:
      double myAltitude;
      float myScale;
   };

   typedef std::vector<DtDynamicScaleConfiguration> DtDynamicScaleConfigurationCollection;

   // Mapping between a display unit's name and its configuration
   typedef std::map<std::string, DtDynamicScaleConfigurationCollection> DtDynamicScaleConfigurationCollectionMap;

   class DT_DLL_MAKARCHIVES DtEntitySettingsRecord
   {
   public:
      enum BuoyancyCullType { BuoyancyCullNone, BuoyancyCullFrontFacing, BuoyancyCullFrustum };

      DtEntitySettingsRecord();

      DtEntitySettingsRecord( const DtEntitySettingsRecord& copy );

      DtEntitySettingsRecord& operator = ( const DtEntitySettingsRecord& obj );

      ~DtEntitySettingsRecord();


      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 showEntityLabels() const;
      void setShowEntityLabels( bool show );

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

      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 );

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

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

      unsigned colorizedModelColorType() const;
      void setColorizedModelColorType( unsigned type );

      float entityIconScale() const;
      void setEntityIconScale( float scale );

      bool fixedEntityIconScalingEnabled() const;
      void setFixedEntityIconScalingEnabled(bool enabled);

      void setDynamicScaleCollectionMap(const DtDynamicScaleConfigurationCollectionMap&);
      const DtDynamicScaleConfigurationCollectionMap& dynamicScaleCollectionMap() const;
      DtDynamicScaleConfigurationCollectionMap& dynamicScaleCollectionMap();

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

      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 );

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

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

      float buoyancyMinimumCullDistance() const;

      void setBuoyancyMinimumCullDistance( float distance );

      void setBuoyancyCullType( BuoyancyCullType cullType );
      BuoyancyCullType buoyancyCullType() const;

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

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

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

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


   protected:

      friend class boost::serialization::access;

      template<class Archive>
         void serialize(Archive & ar, const unsigned int version)
      {
         if ( version <= 6 )
         {
            //Deprecated
            bool myTrailingEffectsEnabled;
            bool myTrackHistoryEnabled;
            bool myDecalEffectsEnabled;
            ar & BOOST_SERIALIZATION_NVP(myTrailingEffectsEnabled);
            ar & BOOST_SERIALIZATION_NVP(myTrackHistoryEnabled);
            ar & BOOST_SERIALIZATION_NVP(myDecalEffectsEnabled);
         }
         ar & BOOST_SERIALIZATION_NVP(myGroundClampingEnabled);
         ar & BOOST_SERIALIZATION_NVP(myGroundClampingRadiusScale);
         ar & BOOST_SERIALIZATION_NVP(mySmoothingEnabled);
         ar & BOOST_SERIALIZATION_NVP(mySmoothingPeriod);
         if (version >= 24)
         {
            ar & BOOST_SERIALIZATION_NVP(myArtPartSmoothingEnabled);
            ar & BOOST_SERIALIZATION_NVP(myArtPartSmoothingPeriod);
         }
         ar & BOOST_SERIALIZATION_NVP(myOrientationClampingEnabled);
         ar & BOOST_SERIALIZATION_NVP(myLifeformsUprightEnabled);

         if(version >= 1 && version != 7 )
         {
            ar & BOOST_SERIALIZATION_NVP(myShowEntityLabels);
         }

         if (version >= 2)
         {
            ar & BOOST_SERIALIZATION_NVP(myShowStealthsEnabled);
         }

         if (version >= 3)
         {
            ar & BOOST_SERIALIZATION_NVP(myInfoPopupsOnSelectEnabled);
         }

         if (version >= 4 && version != 7 )
         {
            ar & BOOST_SERIALIZATION_NVP(myFireDetonateLinesEnabled);
         }
         
         if (version >= 5)
         {
            if ( version != 7 )
            {
               ar & BOOST_SERIALIZATION_NVP(myEntityHeightAboveTerrainLinesEnabled);
            }
            ar & BOOST_SERIALIZATION_NVP(myEntityHeightAboveTerrainMode);
         }
         
         if (version >=6)
         {
            ar& BOOST_SERIALIZATION_NVP(myEntitySimDataEnabled);
         }
         
         if (version >= 9 )
         {
            ar & BOOST_SERIALIZATION_NVP(myColorizedModelColorType);
         }

         if (version == 10 )
         {
            int myEntityIconScale = 1;
            ar & BOOST_SERIALIZATION_NVP(myEntityIconScale);
            myEntityIconScaleFactor =
               pow(1.25, ((float)myEntityIconScale / 10.0) - 5);
         }

         if (version >= 11 )
         {
            ar & BOOST_SERIALIZATION_NVP(myHideEmbarked2DObjects);
         }

         if (version >= 27)
         {
            ar & BOOST_SERIALIZATION_NVP(myFixedEntityIconScalingEnabled);
         }
         if (version >= 26)
         {
            ar & BOOST_SERIALIZATION_NVP(myDynamicScaleFactorCollectionMap);
         }
         if (version >= 12)
         {
            ar & BOOST_SERIALIZATION_NVP(myEntityIconScaleFactor);
         }
         if ( version >= 13 )
         {
            ar & BOOST_SERIALIZATION_NVP(myEntitySensorVolumesEnabled);
         }
         if ( version >= 14 )
         {
            ar & BOOST_SERIALIZATION_NVP(myGroundClampingCullingEnabled);
         }
         else
         {
            myGroundClampingCullingEnabled = ( myGroundClampingRadiusScale < 100 );
         }
         if ( version >= 15 )
         {
            ar & BOOST_SERIALIZATION_NVP(myRotateEntitySymbols);
         }
         if ( version >= 16 )
         {
            ar & BOOST_SERIALIZATION_NVP(myOceanWakesEnabled);
            ar & BOOST_SERIALIZATION_NVP(myHullSprayEffectsEnabled);
            ar & BOOST_SERIALIZATION_NVP(myBuoyancyModelsEnabled);
         }
         if ( version >= 17 )
         {
            ar & BOOST_SERIALIZATION_NVP( myBuoyAndBeaconIconsEnabled );
         }
         if ( version >= 18 )
         {
            ar & BOOST_SERIALIZATION_NVP( myHeightAboveTerrainPeriod );
         }
         if ( version >= 19 )
         {
            ar & BOOST_SERIALIZATION_NVP( myBuoyancyDefaultLODDistance );
         }
         if ( version >= 20 )
         {
            ar & BOOST_SERIALIZATION_NVP( myBuoyancyMinimumCullDistance );
            ar & BOOST_SERIALIZATION_NVP( myBuoyancyCullType );
         }
         if (version >= 21)
         {
            ar & BOOST_SERIALIZATION_NVP(myWakeDefaultLODDistance);
         }
         if (version >= 22)
         {
            ar & BOOST_SERIALIZATION_NVP(myRotorWashEnabled);
         }
         if (version >= 23)
         {
             ar & BOOST_SERIALIZATION_NVP(myOccupantsVisible);
         }
         if (version >= 24)
         {
            ar & BOOST_SERIALIZATION_NVP(myWheelRotationEnabled);
         }
         if (version >= 25)
         {
            ar& BOOST_SERIALIZATION_NVP(myAdaptiveTickRateEnabled);
         }
      }

   protected:

      unsigned myColorizedModelColorType;
      unsigned myEntityHeightAboveTerrainMode;
      float myGroundClampingRadiusScale;
      bool mySmoothingEnabled;
      float mySmoothingPeriod;
      bool myArtPartSmoothingEnabled;
      float myArtPartSmoothingPeriod;
      
      bool myFixedEntityIconScalingEnabled;
      DtDynamicScaleConfigurationCollectionMap myDynamicScaleFactorCollectionMap;
      float myEntityIconScaleFactor;
      
      bool myGroundClampingEnabled;
      bool myGroundClampingCullingEnabled;
      bool myOrientationClampingEnabled;
      bool myLifeformsUprightEnabled;
      bool myShowEntityLabels;
      bool myShowStealthsEnabled;
      bool myInfoPopupsOnSelectEnabled;
      bool myFireDetonateLinesEnabled;
      bool myEntitySensorVolumesEnabled;     // also referred to as 'EmitterVolumes'.
      bool myEntityHeightAboveTerrainLinesEnabled;
      bool myEntitySimDataEnabled;
      bool myHideEmbarked2DObjects;
      bool myRotateEntitySymbols;
      bool myOceanWakesEnabled;
      bool myHullSprayEffectsEnabled;
      bool myBuoyancyModelsEnabled;
      bool myBuoyAndBeaconIconsEnabled;
      unsigned int myHeightAboveTerrainPeriod;
      float myBuoyancyDefaultLODDistance;
      float myWakeDefaultLODDistance;
      float myBuoyancyMinimumCullDistance;
      BuoyancyCullType myBuoyancyCullType;
      bool myRotorWashEnabled;
      bool myOccupantsVisible;
      bool myWheelRotationEnabled;
      bool myAdaptiveTickRateEnabled;
   };

}

BOOST_CLASS_VERSION( makArchives::DtEntitySettingsRecord, 27 )