vrfExtendedEntitySettings.h

Go to the documentation of this file.

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

#pragma once

#include <vrfGuiCore/vrfGuiCore.h>
#include <vrfGuiCore/vrfGuiApplicationSettings.h>

#include <vrvCore/DtObserverSettingsManager.h>

namespace makVrv
{
   class DtDe;
}

namespace makVrf
{
   const makVrv::DtObserverSettingsManager::ObserverSetting DtVrfGuiEntityExtentsShowType = makVrv::DtObserverSettingsManager::ObserverSetting(202);

   class DT_DLL_VRFGUICORE DtVrfExtendedEntitySettingsData : public DtVrfGuiApplicationSetting
   {
   protected:
      enum Flags
      {
         DisplayObjectConsoleWarningIcon = 0x00000001,
         DisplayBoundingBoxesWhenSelected = 0x00000002,
         AllowNonVrfEntitiesToBeTasked = 0x00000010,
         DisplayAttackLines = 0x00000020,
         DisplayAttackAnimation = 0x00000040,
         DisplaySupplyLines = 0x00000080,
         DisplayGumballs = 0x00000100,
         DisplayTaskVisualizationsWhenSelected = 0x00000200,
         DisplayColorVerticesByForce = 0x00000400,
         AutomaticallSelectDeselectAggregateExpansionChanges = 0x00000800,
         DisplayHealth = 0x00001000,

         Defaults = DisplayObjectConsoleWarningIcon | DisplayAttackLines | DisplayAttackAnimation |
                    DisplaySupplyLines | DisplayHealth | DisplayHealth | DisplayTaskVisualizationsWhenSelected | DisplayColorVerticesByForce |
                    AutomaticallSelectDeselectAggregateExpansionChanges
      };

   public:
      DtVrfExtendedEntitySettingsData(makVrv::DtDe* = 0);
      DtVrfExtendedEntitySettingsData(const DtVrfExtendedEntitySettingsData&);

      virtual ~DtVrfExtendedEntitySettingsData();

      virtual void setDisplayObjectConsoleWarningIcon(bool);
      virtual bool displayObjectConsoleWarningIcon() const;

      virtual void setShowGumballs(bool);
      virtual bool showGumballs() const;

      virtual void setShowHealth(bool);
      virtual bool showHealth() const;

      virtual void setColorVerticesByForce(bool);
      virtual bool colorVerticesByForce() const;

      virtual void setDisplayAttackLines(bool);
      virtual bool displayAttackLines() const;

      virtual void setDisplayAttackAnimation(bool);
      virtual bool displayAttackAnimation() const;

      virtual void setDisplaySupplyLines(bool);
      virtual bool displaySupplyLines() const;

      virtual void setDisplayBoundingBoxesWhenSelected(bool);
      virtual bool displayBoundingBoxesWhenSelected() const;

      virtual void setAutomaticallSelectDeselectAggregateExpansionChanges(bool);
      virtual bool automaticallSelectDeselectAggregateExpansionChanges() const;

      virtual void setDisplayTaskVisualizationsWhenSelected(bool);
      virtual bool displayTaskVisualizationsWhenSelected() const;

      virtual void setAllowNonVrfObjectsToBeTasked(bool);
      virtual bool allowNonVrfObjectsToBeTasked() const;

      virtual DtVrfGuiApplicationSetting* clone() const;

      virtual std::string classType() const;

      virtual void write(boost::archive::xml_oarchive& out, const unsigned int);
      virtual void read(boost::archive::xml_iarchive& in, const unsigned int);

      virtual void setFlags(int);
      virtual int flags() const;

      virtual int dataVersion() { return 2; };

   protected:
      virtual void setFlag(Flags, bool);

   protected:
      int   myFlags;
   };

   class DT_DLL_VRFGUICORE DtVrfExtendedEntitySettings : public makVrv::DtVirtualBaseClass
   {
   public:
      DtVrfExtendedEntitySettings(makVrv::DtDe&);

      virtual ~DtVrfExtendedEntitySettings();

      virtual void setDisplayObjectConsoleWarningIcon(bool);
      virtual bool displayObjectConsoleWarningIcon() const;

      virtual void setDisplayAttackLines(bool);
      virtual bool displayAttackLines() const;

      virtual void setDisplayAttackAnimation(bool);
      virtual bool displayAttackAnimation() const;

      virtual void setDisplaySupplyLines(bool);
      virtual bool displaySupplyLines() const;

      virtual void setDisplayBoundingBoxesWhenSelected(bool);
      virtual bool displayBoundingBoxesWhenSelected() const;

      virtual void setDisplayTaskVisualizationsWhenSelected(bool);
      virtual bool displayTaskVisualizationsWhenSelected() const;

      virtual void setAutomaticallSelectDeselectAggregateExpansionChanges(bool);
      virtual bool automaticallSelectDeselectAggregateExpansionChanges() const;

      virtual void setShowGumballs(bool);
      virtual bool showGumballs() const;

      virtual void setShowHealth(bool);
      virtual bool showHealth() const;

      virtual void setPromptBeforeAbandoningPlan(bool);
      virtual bool promptBeforeAbandoningPlan() const;

      virtual void setPromptBeforeInterruptingTask(bool);
      virtual bool promptBeforeInterruptingTask() const;

      virtual void setAllowNonVrfObjectsToBeTasked(bool);
      virtual bool allowNonVrfObjectsToBeTasked() const;

      virtual void setColorVerticesByForce(bool);
      virtual bool colorVerticesByForce() const;

      virtual void setFlags(int);
      virtual int flags() const;

      static DtVrfExtendedEntitySettings& instance( makVrv::DtDe& de );
      static void registerInstance(makVrv::DtDe&, DtVrfExtendedEntitySettings*);

      virtual void setImageFileForCategory(const std::string&, const std::string&);
      virtual std::string imageFileForCategory(const std::string&) const;

      boost::signals2::signal<void ()> signal_extendedEntityOptionsChanged;
      boost::signals2::signal<void (bool)> signal_colorVerticesByForceChanged;
      boost::signals2::signal<void (bool)> signal_gumballSettingsChanged;
      boost::signals2::signal<void (bool)> signal_healthSettingsChanged;

   protected:
      makVrv::DtDe& myDe;
   };
}