vrfSpotReportManager.h

Go to the documentation of this file.

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



#pragma once

#include <vrfGuiCore/vrfGuiCore.h>
#include <vrfGuiCore/vrfGuiApplication.h>
#include <vrfGuiCore/vrfSpotReportsSettingsRecord.h>
#include <vrvCore/DtElementDefinitionManager.h>
#include <vrvCore/DtSelectionManager.h>
#include <vrvUtil/signalslib.h>
#include <vrfutil/rwUUID.h>

#include <vrvUtil/DtVirtualBaseClass.h>
#include <vrvCore/DtEntityState.h>

#include <boost/signal.hpp>

class DtVrfObjectMessage;

namespace makVrv
{
   class DtDe;
   class DtRecordSettingsBackupInterface;
   class DtObjectDictionary;
   class DtSharedSettingsManager;
   class DtElementDefinitionNew;
   class DtVisualizerDefinition;
}

namespace makVrf
{
   class DtSpotReportDataHandlerCreatorInterface;
   class DtSpotReportVisualHandlerCreatorInterface;
   class DtVrfSelectionFilter;
   class DtVrfSpotReportVisualizer;
   
   const makVrv::DtElementEntry::ElementType SpotReportsElementType = (makVrv::DtElementEntry::ElementType)(makVrv::DtElementDefinitionTypeManager::BuiltInElementTypes_End + 1);
   const makVrv::DtSelectionManager::SelectionType DtSpotReportSelectionType = makVrv::DtSelectionManager::SelectionType(100);

   class DT_DLL_VRFGUICORE DtVrfSpotReportManager : public makVrv::DtVirtualBaseClass
   {
   public:
      DtVrfSpotReportManager(makVrv::DtDe&);
      virtual ~DtVrfSpotReportManager();

      static DtVrfSpotReportManager& instance(makVrv::DtDe& de);

      void setAutoSave(bool b);
      bool autoSave() const;

      virtual void getRecord(DtVrfSpotReportsSettingsRecord& rec) const;

      virtual void setFromRecord(const DtVrfSpotReportsSettingsRecord& rec, bool updateFilter = true);

      virtual void requestSpotReports();

      virtual void requestSpotReportsFor(std::vector<int> forces);

      virtual void showPerspectiveForForce(const std::string&, bool autoSave = true);

   public:
      //{@
      void setDisplayReportingName(bool);
      bool displayReportingName() const;

      void setDisplayObservedName(bool);
      bool displayObservedName() const;

      void setDisplayLastContact(bool);
      bool displayLastContact() const;

      void setDisplayLocation(bool);
      bool displayLocation() const;

      void setDisplayVelocity(bool);
      bool displayVelocity() const;

      void setDisplayContactRadius(bool);
      bool displayContactRadius() const;

      void setDisplayContactRadiusIndicator(bool);
      bool displayContactRadiusIndicator() const;

      void setDisplayHeading(bool);
      bool displayHeading() const;

      void setDisplayEntityType(bool);
      bool displayEntityType() const;

      void setDisplayHeadingIndicator(bool);
      bool displayHeadingIndicator() const;

      void setDisplayVelocityIndicator(bool);
      bool displayVelocityIndicator() const;

      void setApplyToEnvironmentals(bool);
      bool applyToEnvironmentals() const;

      void setShowOnlyActiveEnvironmentals(bool);
      bool showOnlyActiveEnvironmentals() const;

      const std::vector<int>& certaintyLevels() const;
      void setCertaintyLevels(const std::vector<int>&);
      void setCertaintyLevel(int level, int time);

      virtual bool showSpotReportsForForce(int) const;
      virtual bool showGroundTruthForForce(int) const;

      virtual void setSpotReportGatherTime(double);
      virtual double spotReportGatherTime() const;

      virtual void addShowSpotReportFor(int);
      virtual void removeShowSpotReportFor(int);
      void setShowSpotReportsForForce(const std::vector<int>&);
      const std::vector<int> spotReportsFor() const;

      virtual void addShowGroundTruthFor(int);
      virtual void removeShowGroundTruthFor(int);
      void setShowGroundTruthForForce(const std::vector<int>&);
      const std::vector<int> groundTruthFor() const;

      virtual void setDisplayFlag(int, bool);
      
      virtual void setSpotReportsGloballyEnabled(bool enabled);

      void setSystemEnabled(bool);
      bool systemEnabled() const;

   public:
      virtual void loadDefaults(bool fromFactory = false);

      virtual void saveAsDefaults();

      const makVrv::DtRecordSettingsBackupInterface* settingsBackup() const
      {
         return mySettingsBackup;
      }

      makVrv::DtRecordSettingsBackupInterface* settingsBackup()
      {
         return mySettingsBackup;
      }

      void exportSettings(const std::string& fileName);

      void importSettings(const std::string& fileName);

      virtual void processReceiveSpotReport(const DtVrfObjectMessage* msg);
      virtual void processReceiveSpotReports(const DtVrfObjectMessage* msg);

      virtual bool addOrUpdateSpotReport(const std::string& type, void*, const DtUUID&);

   public:
      virtual void addFogOfWarFilter(const DtVrfSelectionFilter&);

      virtual void removeFogOfWarFilter(const std::string&);

      virtual bool passesFogOfWarFilters(const makVrv::DtVrlinkSimulatedBaseState*) const;
      virtual bool passesFogOfWarFilters(makVrv::DtUniqueID) const;

      virtual bool canShowScenarioEvent(makVrv::DtUniqueID) const;

      virtual bool blockSignals(bool);

   public:
      virtual void addSpotReportDataHandler(const std::string& s, DtSpotReportDataHandlerCreatorInterface*);

      virtual void removeSpotReport(makVrv::DtUniqueID);

      virtual void removeSpotReportDataHandler(const std::string& s);

      virtual void setSpotReportsSelectable(bool);
      virtual bool spotReportsSelectable() const;

      virtual int certaintyLevelForTime(double d) const;

      virtual void reset();

   public:
      virtual void addSpotReportVisualHandler(const std::string& s, DtSpotReportVisualHandlerCreatorInterface*);

      virtual void removeSpotReportVisualHandler(const std::string& s);

   public:
      boost::signal<void (const DtVrfSpotReportsSettingsRecord&)> signal_spotReportOptionsChanged;

      boost::signal<void (bool)> signal_spotReportsSelectableChanged;

      boost::signal<void (DtVrfSpotReportVisualizer*)> signal_spotReportCreated;

   protected:
      virtual void constructSpotReportDictionary();

      virtual bool upgradeFromDictionary(makVrv::DtElementDefinitionTypeManager::ElementDefinitionType dictType,
         bool force = false, const makVrv::DtUnicode& unknownName = makVrv::DtUnicode::fromAscii("Unknown"));

      virtual void mergeItemsFrom(const makVrv::DtElementDefinitionNew* source, makVrv::DtElementDefinitionNew* spotReport,
         const std::vector<int>& supportedSets);

      virtual bool isUnusedVisualizer(const makVrv::DtVisualizerDefinition*) const;

      virtual void enableDecoration(const std::string&, bool);
      virtual bool decorationIsEnabled(const std::string&) const;

   protected:
      makVrv::DtDe&           myDe;
      makVrv::DtRecordSettingsBackupInterface* mySettingsBackup;
      bool mySignalsBlocked;
      DtVrfSpotReportsSettingsRecord mySpotReportSettings;

      bool mySpotReportsSelectable;
      std::set<unsigned long> mySpotReportRequestIds;
      std::set<int> myAlreadyRequested;
      std::map<std::string, DtVrfSelectionFilter*> myModified;
      std::set<std::string> myRemoved;

      DtVrfSelectionFilter* myActiveEnvironmentalsFilter;
   };
}