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/DtSelectionManager.h>
#include <vrvUtil/event_signal.h>

#include <vrfutil/rwUUID.h>
#include <vrfGuiCore/vrfExtendedElementAttributes.h>
#include <vrvUtil/DtSignalConnectionManager.h>

#include <vrvUtil/DtVirtualBaseClass.h>

#include "vlpi/entityType.h"

class DtVrfObjectMessage;

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

namespace makVrf
{
   class DtSpotReportDataHandlerCreatorInterface;
   class DtExternalDataVisualHandlerCreatorInterface;
   class DtVrfSelectionFilter;
   class DtGuiLocalObject;

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

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

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

      virtual DtSimObjectReference lookup(const DtUUID&) const;

      virtual void getRecord(DtVrfSpotReportsSettingsRecord& rec) const;

      virtual void getSplitRecord(std::vector<DtVrfSpotReportsSettingsRecord>& rec,
         std::vector<std::string>& fileNames) {};

      virtual void addRecords(DtVrfSpotReportsSettingsRecord& recs,
         DtVrfSpotReportsSettingsRecord& combinedRec) {};

      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:
      //{@
      virtual void setDisplayReportingName(bool);
      virtual bool displayReportingName() const;

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

      virtual void setDisplayTimeSinceLastReport(bool);
      virtual bool displayTimeSinceLastReport() const;

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

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

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

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

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

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

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

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

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

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

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

      virtual void setShow3DGroundTruth(bool);
      virtual bool show3DGroundTruth() const;

      virtual void setShowTrackHistories(bool);
      virtual bool showTrackHistories() const;

      virtual void setShowTrackHistoriesForSelected(bool);
      virtual bool showTrackHistoriesForSelected() const;

      virtual void setNumberOfTrackReports(int);
      virtual int numberOfTrackReports() 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 setKeepReportsForTimePeriod(bool);
      virtual bool keepReportsForTimePeriod() const;

      virtual void setKeepReportsForTime(int);
      virtual int keepReportsForTime() const;

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

      virtual bool isSpotReport(makVrv::DtUniqueID id) 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(DtSimObjectReference) const;
      virtual bool passesFogOfWarFilters(makVrv::DtUniqueID) const;
      virtual bool passesFogOfWarFilters(const DtUUID&) 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, DtExternalDataVisualHandlerCreatorInterface*);

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

      virtual bool passesAllFilters(DtSimObjectReference s) const;
      virtual bool passesAllFilters(makVrv::DtUniqueID id) const;

   public:
      boost::signals2::signal<void (DtGuiLocalObject*)> signal_spotReportCreated;
      boost::signals2::signal<void (DtGuiLocalObject*)> signal_spotReportUpdated;

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

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

      boost::signals2::signal<void (bool)> signal_showTrackHistoryForSelectedItemsChanged;

      boost::signals2::signal<void (int)> signal_numberOfTrackReportsChanged;

      boost::signals2::signal<void (bool)> signal_keepReportsForTimePeriodChanged;

      boost::signals2::signal<void (int)> signal_keepReportsForTimeChanged;

   protected:

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

      virtual void slot_observerModeAdded(int);

      virtual void setTrackHistoriesVisible(bool);
      virtual void slot_organizedCategoriesInitialized();

      virtual void showOnlyActiveEnvironmentalsChanged();

   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;

      boost::signals2::scoped_connection myShowOnlyActiveEnvironmentalsChangedConnection;
      DtVrfSelectionFilter* myActiveEnvironmentalsFilter;

      makVrv::DtSignalConnectionManager myConnections;
      DtEntityType myStealthType;
   };

   class DT_DLL_VRFGUICORE DtSharedSpotReportSignaler : public makVrv::DtVirtualBaseClass
   {
   public:

      static DtSharedSpotReportSignaler& instance(const makVrv::DtSharedSettingsManager&);

      static DtSharedSpotReportSignaler& instance(makVrv::DtEventQueueInterface&);

      static DtSharedSpotReportSignaler* findInstance(
         makVrv::DtEventQueueInterface*);

      virtual ~DtSharedSpotReportSignaler() override;

      //@name Signals

      makVrv::event_signal<void (bool)> signal_show3DGroundTruthChanged;

   protected:
      DtSharedSpotReportSignaler(makVrv::DtEventQueueInterface& eqi);
   };
}