DtObserverViewsManager.h

Go to the documentation of this file.

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


#pragma once

#include <makArchives/DtObserverStateRecordsList.h>

#include <vrvCore/vrvCore.h>

#include <vrvUtil/DtVirtualBaseClass.h>
#include <vrvUtil/DtSignalConnectionManager.h>

namespace makVrv
{

   class DtDe;
   class DtObserver;
   class DtUnicode;

   class DT_DLL_VRVCORE DtObserverViewsManager
   {

   public:

      friend class DtObserverViewsManagerCreator;

      enum ViewProjection
      {
         Projection2D,
         Projection3D
      };

      virtual ~DtObserverViewsManager();

      virtual void loadTerrainObserverViewsFile(const DtUnicode& pathTofile, bool reload);

      virtual void loadObserverViewsFile(const DtUnicode& pathTofile);

      virtual std::string generateUniqueNameForObserverViewRecord(const makArchives::DtObserverStateRecord&) const;

      virtual void addObserverViewRecordToList(const makArchives::DtObserverStateRecord& observerStateRecord);

      virtual void setObserverViewByName(const std::string& observerViewName, bool animate = false);

      virtual void setObserverViewByNameAndMode(const std::string& observerViewName, ViewProjection projection, bool animate = false);

      // it doesn't support terrain patches
      virtual void associateObserverViewsToTerrain(bool associate);

      virtual const std::string& observerView3DDefaultRecordName() const;

      virtual void setObserverView3DDefaultRecordName(const std::string& val);

      virtual const std::string& observerView2DDefaultRecordName() const;

      virtual void setObserverView2DDefaultRecordName(const std::string& val);

      virtual bool getTerrainDefaultObserverView(std::string& defaultView, ViewProjection& projection);

      virtual void setTerrainDefaultObserverView();

      virtual void setSuppressDefaultView(const std::string& observerName);

      virtual const makArchives::DtObserverStateRecordsList& observerViewList();

      virtual void setObserverViewList(const makArchives::DtObserverStateRecordsList& val);

      virtual void saveObserverViewsFile(const DtUnicode& filename);

      virtual void saveObserverViewFile(const DtUnicode& filename, const std::string& observerViewName, ViewProjection projection);

      virtual bool renameObserverRecord(const std::string& newName, const std::string& oldName, ViewProjection projection);

      virtual void setDefaultObserverViewRecord(const std::string& recordName, ViewProjection projection);

      virtual void unSetDefaultObserverViewRecord(const std::string& recordName, ViewProjection projection);

      virtual void clearObserverViewList();

      virtual bool removeObserverViewRecord(const std::string& observerViewName, ViewProjection projection);

      virtual bool isRecordAssociatedToTerrain(const std::string& recordDisplayName);


      virtual void setIsDefaultObserverViewRecord(const std::string& newName, bool isDefault);

      virtual void setIsDefaultObserverViewRecord(const makArchives::DtObserverStateRecord& record, bool isDefault);

      virtual bool setAssociateObserverViewRecord(const std::string&, bool associate);

      virtual unsigned int countAssociatedViews() const;

      // adds it to the observer view list
      virtual void captureAndAddObserverView();

      virtual const std::string& rightClickedObserverViewName() const;

      virtual void setRightClickedObserverViewName(const std::string& val);

      virtual ViewProjection rightClickedObserverViewProjection() const;

      virtual void setRightClickedObserverViewProjection(ViewProjection projection);

      virtual bool rightClickedObserverViewIsAttached() const;

      virtual void setRightClickedObserverViewIsAttached(bool val);

      virtual void setRightClickedObserverViewIsAttached(const std::string& recordName);

      virtual bool rightClickedObserverViewIsAssociated() const;

      virtual void setRightClickedObserverViewIsAssociated(bool val);

      virtual void setRightClickedObserverViewIsAssociated(const std::string& recordName);

      virtual const std::string& observerViewsFile() const;

      virtual void setObserverViewsFile(const std::string& val);

      virtual bool isDirty() const;

      virtual void setDirty(bool val);

      virtual bool areDefaultsDirty() const;

      virtual void setDefaultsDirty(bool val);

      virtual const std::string& terrainObserverViewRecordsFileName() const;

      virtual void setTerrainObserverViewRecordsFileName(const std::string& val);

      virtual void setObserverViewRecordsFromIntializer();

      virtual bool findObserverViewByNameAndMode(const std::string& observerName, ViewProjection projection, makArchives::DtObserverStateRecord& record);

      virtual void setObserverViewByrecord(makArchives::DtObserverStateRecord& record, bool animate = false);

   private:
      DtObserverViewsManager();

   protected:
      DtObserverViewsManager(DtDe& myDe);

   protected:

      virtual bool readObserverViewListFromFile(const DtUnicode& fileName, makArchives::DtObserverStateRecordsList& recordList);

      virtual void slot_terrainCleared(bool reload);

      virtual void slot_onApplicationQuit();

      virtual void slot_closeConfirmationMessageToBeDisplayed();

      virtual void processObserverViewRecordsList(makArchives::DtObserverStateRecordsList& incomingList, bool associated);

      virtual DtObserver* findObserverToUse();

      virtual bool observerOnSuppressList(const std::string& observerName);

   protected:

      DtDe& myDe;

      std::string myObserverView3DDefaultRecordName;

      std::string myObserverView2DDefaultRecordName;

      makArchives::DtObserverStateRecordsList  myObserverViewList;

      std::string myTerrainObserverViewRecordsFileName;

      // \brief gui uses this variable to retrieve the observer view record name where the system called a 
      // right click event.
      std::string myRightClickedObserverViewName;

      // \brief gui uses this variable to retrieve the observer view record mode where the system called a 
      // right click event.
      ViewProjection myRightClickedObserverViewProjection;

      // \brief gui uses this variable to check if the observer view  record where the system called a 
      // right click event is attached to an entity.
      bool myRightClickedObserverViewIsAttached;

      // \brief gui uses this variable to check if the observer view  record where the system called a 
      // right click event is associated to the opened terrain in the scene
      bool myRightClickedObserverViewIsAssociated;

      // \brief observers views list
      std::string myObserverViewsFile;

      // default 2d observer view name 
      //std::string myDefault2DObserverViewDisplayName;

      // default 3d observer view name 
      //std::string myDefault3DObserverViewDisplayName;

      DtSignalConnectionManager myConnections;

      bool myHasSetupObserverRecords;

      bool myIsDirty;

      bool myDefaultsDirty;

      bool myApplicationIsClosing;

      std::list<std::string> myObserversSuppressDefaultView;
   };


   class DT_DLL_VRVCORE DtObserverViewsManagerCreator : public DtVirtualBaseClass
   {
   public:

      virtual ~DtObserverViewsManagerCreator();

      static DtObserverViewsManagerCreator& instance(DtDe&);

      static void registerInstance(DtDe& de, DtObserverViewsManagerCreator*);

      virtual DtObserverViewsManager* create(DtDe& de);
   };

   class DT_DLL_VRVCORE DtObserverViewManagerSignaler : public DtVirtualBaseClass
   {
   public:

      static DtObserverViewManagerSignaler& instance(DtDe&);

      virtual ~DtObserverViewManagerSignaler();

      boost::signal<void()> signal_observerViewListIsDirty;

      boost::signal<void(DtObserverViewsManager::ViewProjection projection, const std::string& viewName)> signal_defaultViewChanged;

      boost::signal<void(const makArchives::DtObserverStateRecord& observerView)> signal_capturedObserverViewAdded;

      boost::signal<void(const makArchives::DtObserverStateRecord& observerView)> signal_observerViewRemoved;

      boost::signal<void(const std::string& oldName, const makArchives::DtObserverStateRecord& observerView)> signal_observerViewNameModified;

      boost::signal<void()> signal_observerViewsAssociatedToTerrain;

      boost::signal<void(const makArchives::DtObserverStateRecordsList& observerView)> signal_observerViewDissociatedToTerrain;

      boost::signal<void(const makArchives::DtObserverStateRecordsList& observerViewList)> signal_observerViewsImportedAndMerge;

      boost::signal<void(const makArchives::DtObserverStateRecordsList& observerViewList)> signal_observerViewsImportedAndReplaced;

      boost::signal<void(const makArchives::DtObserverStateRecordsList& observerViewList)> signal_associatedViewsToTerrainLoaded;

      boost::signal<void(const makArchives::DtObserverStateRecordsList& observerViewList)> signal_associatedViewsToTerrainUnLoaded;

      boost::signal<void()> signal_observerViewsAboutToBeCleared;

      boost::signal<void()> signal_observerViewsCleared;

      boost::signal<void(const makArchives::DtObserverStateRecord&)> signal_setDefaultObserverViewRecord;

      boost::signal<void(const makArchives::DtObserverStateRecord&)> signal_unSetDefaultObserverViewRecord;

   protected:

      DtObserverViewManagerSignaler();

   };
}