DtIntervisibilitySettingsRecord.h

Go to the documentation of this file.

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


#pragma once

#include <makArchives/makArchives.h>

namespace makArchives
{

   class DT_DLL_MAKARCHIVES DtIntervisibilitySettingsRecord
   {
   public:

      DtIntervisibilitySettingsRecord();

      DtIntervisibilitySettingsRecord( const DtIntervisibilitySettingsRecord& copy );

      DtIntervisibilitySettingsRecord& operator = ( const DtIntervisibilitySettingsRecord& obj );

      ~DtIntervisibilitySettingsRecord();

      bool operator == ( const DtIntervisibilitySettingsRecord& rhs ) const;

      inline bool operator != ( const DtIntervisibilitySettingsRecord& rhs ) const
      {
         return !( *this == rhs );
      }


      void setIntervisibilityEnabled( bool enabled );
      bool intervisibilityEnabled() const;

      void setLeftClickMakesObjectsPermanent( bool enabled );
      bool leftClickMakesObjectsPermanent() const;

      void setOriginIntervisibilityElevation( double height );
      double originIntervisibilityElevation() const;

      void setEndPointIntervisibilityElevation( double height );
      double endPointIntervisibilityElevation() const;

      void setFanModeSamplingRate( double radAngle );
      double fanModeSamplingRate() const;

      void setEntityFanUpdateRate( double interval );
      double entityFanUpdateRate() const;

      void setHatLinesEnabled( bool hatEnabled );
      bool hatLinesEnabled() const;

      void setHatLinesOnSelectionOnly( bool selOnly );
      bool hatLinesOnSelectionOnly() const;

      void setVisibleColor( float r, float g, float b, float a );
      void visibleColor( float& r, float& g, float& b, float& a ) const;

      void setBlockedColor( float r, float g, float b, float a );
      void blockedColor( float& r, float& g, float& b, float& a ) const;

      void setCircleColor( float r, float g, float b, float a );
      void circleColor( float& r, float& g, float& b, float& a ) const;

      void setRangeInfoLabelsEnabled( bool enabled );
      bool rangeInfoLabelsEnabled() const;

      void setRangeInfoLabelBackgroundColor( float r, float g, float b, float a );
      void rangeInfoLabelBackgroundColor( float& r, float& g, float& b, float& a ) const;

      void setRangeInfoAltChangeFieldEnabled( bool enabled );
      bool rangeInfoAltChangeFieldEnabled() const;

      void setRangeInfoLocationFieldEnabled( bool enabled );
      bool rangeInfoLocationFieldEnabled() const;

      void setRangeInfoHeadingFieldEnabled( bool enabled );
      bool rangeInfoHeadingFieldEnabled() const;

      void setRangeInfoRangeFieldEnabled( bool enabled );
      bool rangeInfoRangeFieldEnabled() const;


   protected:

      friend class boost::serialization::access;

      template<class Archive>
         void serialize(Archive & ar, const unsigned int version)
      {
         ar & BOOST_SERIALIZATION_NVP(myLeftClickMakesObjectsPermanent);
         ar & BOOST_SERIALIZATION_NVP(myOriginIntervisibilityElevation);
         ar & BOOST_SERIALIZATION_NVP(myEndPointIntervisibilityElevation);
         ar & BOOST_SERIALIZATION_NVP(myFanModeSamplingRate);
         ar & BOOST_SERIALIZATION_NVP(myEntityFanUpdateRate);
         ar & BOOST_SERIALIZATION_NVP(myHatLinesEnabled);
         ar & BOOST_SERIALIZATION_NVP(myHatLinesOnSelectionOnly);

         ar & BOOST_SERIALIZATION_NVP(myVisibleColorR);
         ar & BOOST_SERIALIZATION_NVP(myVisibleColorG);
         ar & BOOST_SERIALIZATION_NVP(myVisibleColorB);
         ar & BOOST_SERIALIZATION_NVP(myVisibleColorA);

         ar & BOOST_SERIALIZATION_NVP(myBlockedColorR);
         ar & BOOST_SERIALIZATION_NVP(myBlockedColorG);
         ar & BOOST_SERIALIZATION_NVP(myBlockedColorB);
         ar & BOOST_SERIALIZATION_NVP(myBlockedColorA);

         ar & BOOST_SERIALIZATION_NVP(myCircleColorR);
         ar & BOOST_SERIALIZATION_NVP(myCircleColorG);
         ar & BOOST_SERIALIZATION_NVP(myCircleColorB);
         ar & BOOST_SERIALIZATION_NVP(myCircleColorA);

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

         if ( version >= 3 )
         {
            ar & BOOST_SERIALIZATION_NVP( myRangeInfoLabelsEnabled );
            ar & BOOST_SERIALIZATION_NVP( myRangeInfoLabelBackgroundColorR );
            ar & BOOST_SERIALIZATION_NVP( myRangeInfoLabelBackgroundColorG );
            ar & BOOST_SERIALIZATION_NVP( myRangeInfoLabelBackgroundColorB );
            ar & BOOST_SERIALIZATION_NVP( myRangeInfoLabelBackgroundColorA );
            ar & BOOST_SERIALIZATION_NVP( myRangeInfoAltChangeFieldEnabledFlag );
            ar & BOOST_SERIALIZATION_NVP( myRangeInfoLocationFieldEnabledFlag );
            ar & BOOST_SERIALIZATION_NVP( myRangeInfoHeadingFieldEnabledFlag );
            ar & BOOST_SERIALIZATION_NVP( myRangeInfoRangeFieldEnabledFlag );
         }
      }

   protected:

      bool myIntervisibilityEnabled;
      bool myLeftClickMakesObjectsPermanent;

      bool myHatLinesEnabled;
      bool myHatLinesOnSelectionOnly;

      double myOriginIntervisibilityElevation;
      double myEndPointIntervisibilityElevation;
      double myFanModeSamplingRate;
      double myEntityFanUpdateRate;

      float myVisibleColorR, myVisibleColorG, myVisibleColorB, myVisibleColorA;
      float myBlockedColorR, myBlockedColorG, myBlockedColorB, myBlockedColorA;
      float myCircleColorR, myCircleColorG, myCircleColorB, myCircleColorA;

      bool myRangeInfoLabelsEnabled;

      float myRangeInfoLabelBackgroundColorR, myRangeInfoLabelBackgroundColorG;
      float myRangeInfoLabelBackgroundColorB, myRangeInfoLabelBackgroundColorA;

      bool myRangeInfoAltChangeFieldEnabledFlag;
      bool myRangeInfoLocationFieldEnabledFlag;
      bool myRangeInfoHeadingFieldEnabledFlag;
      bool myRangeInfoRangeFieldEnabledFlag;

   };

}

BOOST_CLASS_VERSION( makArchives::DtIntervisibilitySettingsRecord, 3 )