include/makArchives/DtObserverSettingsRecord.h

Go to the documentation of this file.

/******************************************************************************
** Copyright (c) 2008 MAK Technologies, Inc.
** All rights reserved.
******************************************************************************/
/******************************************************************************
** $RCSfile: DtObserverSettingsRecord.h,v $ $Revision: 1.5 $ $State: Exp $
******************************************************************************/


#ifndef DtObserverSettingsRecord_H_
#define DtObserverSettingsRecord_H_

#include <makArchives/makArchives.h>

#include <string>

namespace makArchives
{
   class DT_DLL_MAKARCHIVES DtObserverSettingsRecord
   {
   public:

       enum AttachType
       {
          AttachTypeTether,
          AttachTypeMimic,
          AttachTypeFollow,
          AttachTypeTrack,
          AttachTypeTetherTrack,
          AttachTypeMimicTrack,
          AttachTypeModelView,
          AttachTypeSpaceFollow
       };

      DtObserverSettingsRecord();

      DtObserverSettingsRecord(const DtObserverSettingsRecord& orig);

      DtObserverSettingsRecord& operator=(const DtObserverSettingsRecord& orig);

      ~DtObserverSettingsRecord();



      void setObserverMode( const std::string& observerMode );
      const std::string& observerMode() const;

      void setAttachType( AttachType type );
      AttachType attachType() const;

      void setHideModelOnAttach( bool hide );
      bool hideModelOnAttach() const;

      void setOrientToTargetConstraint( bool orient );
      bool orientToTargetConstraint() const;

      void setOrbitSpeedGain( int gain );
      int orbitSpeedGain() const;

      void setRotationSpeedGain( int gain );
      int rotationSpeedGain() const;

      void setLinearScaledSpeedGain( int gain );
      int linearScaledSpeedGain() const;

      void setLinearUnscaledSpeedGain( int gain );
      int linearUnscaledSpeedGain() const;


      void setOrbitSpeed( double speed );
      double orbitSpeed() const;

      void setRotationSpeed( double speed );
      double rotationSpeed() const;

      void setLinearSpeed( double speed );
      double linearSpeed() const;



   protected:

      friend class boost::serialization::access;

      template<class Archive>
         void serialize(Archive & ar, const unsigned int version)
      {
         ar & BOOST_SERIALIZATION_NVP(myAttachType);
         ar & BOOST_SERIALIZATION_NVP(myHideModelOnAttach);
         ar & BOOST_SERIALIZATION_NVP(myOrientToTargetConstraint);
         // no longer used
         ar & BOOST_SERIALIZATION_NVP(mySpeedScaling);
         // no longer used
         ar & BOOST_SERIALIZATION_NVP(myConstrainToTerrain);
         ar & BOOST_SERIALIZATION_NVP(myOrbitSpeedGain);
         ar & BOOST_SERIALIZATION_NVP(myRotationSpeedGain);
         ar & BOOST_SERIALIZATION_NVP(myLinearScaledSpeedGain);
         ar & BOOST_SERIALIZATION_NVP(myLinearUnscaledSpeedGain);
         //ar & BOOST_SERIALIZATION_NVP(myGainPrecision);
         ar & BOOST_SERIALIZATION_NVP(myOrbitSpeed);
         ar & BOOST_SERIALIZATION_NVP(myRotationSpeed);
         ar & BOOST_SERIALIZATION_NVP(myLinearSpeed);
         if ( version >= 2 )
         {
            ar & BOOST_SERIALIZATION_NVP(myObserverMode);
         }
      }

   protected:

      std::string myObserverMode;
      AttachType myAttachType;
      bool myHideModelOnAttach;
      bool myOrientToTargetConstraint;
      bool mySpeedScaling;
      bool myConstrainToTerrain;
      int myOrbitSpeedGain;
      int myRotationSpeedGain;
      int myLinearScaledSpeedGain;
      int myLinearUnscaledSpeedGain;
      //int myGainPrecision;
      double myOrbitSpeed;
      double myRotationSpeed;
      double myLinearSpeed;

   };
}

BOOST_CLASS_VERSION(makArchives::DtObserverSettingsRecord, 2)

#endif