DtObserverStateRecord.h

Go to the documentation of this file.

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


#pragma once

#include <makArchives/makArchives.h>
#include <makArchives/DtObserverSettingsRecord.h>
#include <set>

namespace makArchives
{
   class DT_DLL_MAKARCHIVES DtObserverStateRecord
   {

   public:

      DtObserverStateRecord();

      DtObserverStateRecord(const DtObserverStateRecord& orig);

      DtObserverStateRecord& operator=(const DtObserverStateRecord& orig);

      ~DtObserverStateRecord();

      void setObserverSettingsRecord(const DtObserverSettingsRecord& rec);

      const DtObserverSettingsRecord& observerSettingsRecord() const;
      DtObserverSettingsRecord& observerSettingsRecord();

      void setAttachedToDisplayNames( const std::set<std::string>& displayNames );      

      const std::set<std::string>& attachedToDisplayNames() const; 

      void setSecondaryAttachedToDisplayNames( const std::set<std::string>& displayNames );      

      const std::set<std::string>& secondaryAttachedToDisplayNames() const; 

      void getLocationTrackAttachment(  double& x, double& y, double& z ) const;

      void setLocationTrackAttachment(  double x, double y, double z );

      void getObserverOffsetVector( double& x, double& y, double& z ) const;

      void setObserverOffsetVector( double x, double y, double z );

      void getObserverRotationOffset( double& x, double& y, double& z, double& w ) const;

      void setObserverRotationOffset( double x, double y, double z, double w );

      void getPosition( double &x, double &y, double& z ) const;

      void setPosition( double x, double y, double z );

      void getOrientation( double& x, double& y, double& z, double& w ) const;

      void setOrientation( double x, double y, double z, double w );

      void setDisplayName(const std::string&);

      const std::string& displayName() const;
      
      void setViewResolution(double resolution);

      double viewResolution() const;

      void setViewMagnification( double magnification );

      double viewMagnification() const;

      void setSetIntoObserver(bool);

      bool setIntoObserver() const;

      void setPartAttachment(int partId);

      int partAttachment() const;

      void setIsDefaultObserverView(bool useICO);

      bool isDefaultObserverView() const;

      bool associatedToTerrain() const;

      void setAssociatedToTerrain(bool val);

      void setEntityLodScale(float scale);
      float entityLodScale() const;
      
      void setTerrainLodScale(float scale);
      float terrainLodScale() const;

      void setPaperMapLayer(const std::string& paperMapLayer);
      std::string paperMapLayer() const;

   protected:

      friend class boost::serialization::access;

      template<class Archive>
         void serialize(Archive & ar, const unsigned int version)
      {
         ar & BOOST_SERIALIZATION_NVP(myObserverSettingsRecord);
         ar & BOOST_SERIALIZATION_NVP(myAttachedToDisplayNames);
         ar & BOOST_SERIALIZATION_NVP(myObserverOffsetVectorX);
         ar & BOOST_SERIALIZATION_NVP(myObserverOffsetVectorY);
         ar & BOOST_SERIALIZATION_NVP(myObserverOffsetVectorZ);
         ar & BOOST_SERIALIZATION_NVP(myObserverRotationOffsetX);
         ar & BOOST_SERIALIZATION_NVP(myObserverRotationOffsetY);
         ar & BOOST_SERIALIZATION_NVP(myObserverRotationOffsetZ);
         ar & BOOST_SERIALIZATION_NVP(myObserverRotationOffsetW);
         ar & BOOST_SERIALIZATION_NVP(myPosX);
         ar & BOOST_SERIALIZATION_NVP(myPosY);
         ar & BOOST_SERIALIZATION_NVP(myPosZ);
         ar & BOOST_SERIALIZATION_NVP(myOrientationX);
         ar & BOOST_SERIALIZATION_NVP(myOrientationY);
         ar & BOOST_SERIALIZATION_NVP(myOrientationZ);
         ar & BOOST_SERIALIZATION_NVP(myOrientationW);

         if (version >= 1)
         {
            ar & BOOST_SERIALIZATION_NVP(myDisplayName);
         }
         
         if ( version >= 2)
         {
            if(version < 6)
            {
               ar & boost::serialization::make_nvp("myZoomFactor",myViewResolution);
            }
            else
            {
               ar & BOOST_SERIALIZATION_NVP(myViewResolution);
            }
         }

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

         if ( version >= 4)
         {
            ar & BOOST_SERIALIZATION_NVP(myPartAttachment);
         }

         if ( version >= 5 )
         {
            ar & BOOST_SERIALIZATION_NVP( myViewMagnification );
         }
         
         if ( version >= 7 )
         {
            ar & BOOST_SERIALIZATION_NVP( myLocationTrackAttachmentX );
            ar & BOOST_SERIALIZATION_NVP( myLocationTrackAttachmentY );
            ar & BOOST_SERIALIZATION_NVP( myLocationTrackAttachmentZ );
         }
         if (version >= 8)
         {
            ar & BOOST_SERIALIZATION_NVP(myIsDefaultObserverView);
         }
         if (version >= 9 && version <= 10)
         {
            ar & BOOST_SERIALIZATION_NVP(myLodScale);
            myTerrainLodScale = myLodScale;
         }
         if (version >= 10)
         {
            ar& BOOST_SERIALIZATION_NVP(myPaperMapLayer);
         }
         if (version >= 11)
         {
            ar& BOOST_SERIALIZATION_NVP(myEntityLodScale);
            ar& BOOST_SERIALIZATION_NVP(myTerrainLodScale);
         }
      }

   protected:

      DtObserverSettingsRecord myObserverSettingsRecord;
      std::set<std::string> myAttachedToDisplayNames;
      double myObserverOffsetVectorX;
      double myObserverOffsetVectorY;
      double myObserverOffsetVectorZ;
      double myObserverRotationOffsetX;
      double myObserverRotationOffsetY;
      double myObserverRotationOffsetZ;
      double myObserverRotationOffsetW;
      double myPosX;
      double myPosY;
      double myPosZ;
      double myOrientationX;
      double myOrientationY;
      double myOrientationZ;
      double myOrientationW;
      std::string myDisplayName;
      double myViewResolution;
      std::set<std::string> mySecondaryAttachedToDisplayNames;
      int myPartAttachment;
      double myViewMagnification;
      double myLocationTrackAttachmentX;
      double myLocationTrackAttachmentY;
      double myLocationTrackAttachmentZ;
      bool myIsDefaultObserverView;
      float myLodScale;
      float myEntityLodScale;
      float myTerrainLodScale;
      std::string myPaperMapLayer;

      bool mySetIntoObserver;

      bool myAssociatedToTerrain;
   };
}

BOOST_CLASS_VERSION(makArchives::DtObserverStateRecord,11)