rangeRingsSettingsRecord.h

Go to the documentation of this file.

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



#pragma once

#include <vrfGuiCore/vrfGuiCore.h>
#include <vrvUtil/DtUnicode.h>

#include <boost/serialization/access.hpp>
#include <boost/serialization/nvp.hpp>
#include <boost/serialization/list.hpp>
#include <boost/serialization/map.hpp>
#include <boost/serialization/vector.hpp>
#include <boost/serialization/string.hpp>

namespace makVrf
{
   const int USING_FORCE_COLOR = 0x00666666;
   const int DEFAULT_OPACITY = 0x66000000;

   class DT_DLL_VRFGUICORE DtRangeRingsSettingsRecord
   {
   public:
      enum RangeRingsDisplayOptions
      {
         DtRangeRingsNone = 0,
         DtRangeRingsFill2D =  0x00000001,
         DtRangeRingsShowRangeSphere = 0x00000002,
         DtRangeRingsShowWeaponNameLabel = 0x00000004,
         DtRangeRingsShowEntityNameLabel = 0x00000008,
         DtRangeRingsShowRangeValueLabel = 0x00000010,
         DtRangeRingsShowByDefault = 0x00000020,
         DtRangeRingsShowWhenSelected = 0x00000040,
         DtRangeRingsShowPhysicalFootprint = 0x00000080,
      };

      struct ColorOption
      {
         ColorOption() : color(USING_FORCE_COLOR), label(makVrv::DtUnicode::tr("Unknown")), visible(true) {};
         ColorOption(int c, const makVrv::DtUnicode& v, bool visible = true) : color(c), label(v), visible(true) {};
         ColorOption(const ColorOption& c) : color(c.color), label(c.label), visible(c.visible) {};

         ColorOption& operator=(const ColorOption& c) { color = c.color; label = c.label; visible = c.visible; return *this; };

         bool operator==(const ColorOption& c) const { return ((c.color == color) && (c.label == label) && (c.visible == visible)); };
         int color;
         makVrv::DtUnicode label;
         bool visible;

      protected:
         friend class boost::serialization::access;

         template<class Archive>
            void serialize(Archive & ar, const unsigned int version)
         {
            ar & BOOST_SERIALIZATION_NVP(color);

            if (Archive::is_loading::value)
            {
               std::string serLabel;
               ar & BOOST_SERIALIZATION_NVP(serLabel);

               label = makVrv::DtUnicode::fromAscii(serLabel.c_str());
            }
            else
            {
               std::string serLabel = label.toAscii();
               ar & BOOST_SERIALIZATION_NVP(serLabel);
            }

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

      typedef std::map<std::string, ColorOption> ColorOptions;

   public:
      DtRangeRingsSettingsRecord();
      DtRangeRingsSettingsRecord(const DtRangeRingsSettingsRecord& orig);

      virtual ~DtRangeRingsSettingsRecord();

   public:

      virtual void setFlag(int flag, bool set);
      RangeRingsDisplayOptions displayOptions() const;

      void setFill2D(bool);
      bool fill2D() const;

      void setShowRangeSphere( bool );
      bool showRangeSphere() const;

      void setShowWeaponNameLabel( bool );
      bool showWeaponNameLabel() const;

      void setShowEntityNameLabel( bool );
      bool showEntityNameLabel() const;

      void setShowRangeValueLabel( bool );
      bool showRangeValueLabel() const;

      void setShowByDefault( bool );
      bool showByDefault() const;

      void setShowForSelected( bool );
      bool showForSelected() const;

      void setShowPhysicalFootprint( bool );
      bool showPhysicalFootprint() const;

      void addColorOption(const std::string& type, int color, const makVrv::DtUnicode&);
      bool getColorOption(const std::string& type, int& color, makVrv::DtUnicode&) const;
      void setColorOptions(const ColorOptions&);
      void removeColorOption(const std::string& type);

      void setVisible(const std::string& type, bool);
      bool visible(const std::string& type) const;

      void setSphereOpacityModifier(double);
      double sphereOpacityModifier() const;

      virtual bool operator==(const DtRangeRingsSettingsRecord&) const;
      bool operator!=(const DtRangeRingsSettingsRecord&) const;

      const ColorOptions& colorOptions() const
      {
         return myColorOptionsNew;
      }

   protected:
      friend class boost::serialization::access;

      template<class Archive>
         void serialize(Archive & ar, const unsigned int version)
      {
         ar & BOOST_SERIALIZATION_NVP(myDisplayOptions);
         if (version > 1)
         {
            ar & BOOST_SERIALIZATION_NVP(myColorOptionsNew);

            if (Archive::is_loading::value && (version < 3))
            {
               setShowForSelected(true);
               setShowPhysicalFootprint(true);
            }

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

   protected:
      ColorOptions myColorOptionsNew;
      RangeRingsDisplayOptions   myDisplayOptions;
      double mySphereOpacityModifier;
   };
}

BOOST_CLASS_VERSION(makVrf::DtRangeRingsSettingsRecord,4)
BOOST_CLASS_VERSION(makVrf::DtRangeRingsSettingsRecord::ColorOption,2)