informationDialogManager.h

Go to the documentation of this file.

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



#pragma once


#include <boost/signals2.hpp>

#include <vrfGuiCore/orderedEntityTypeList.h>
#include <vrfGuiObjectInformationQt/vrfGuiObjectInformationQt.h>
#include <vrfGuiCore/informationPagePath.h>
#include <vrfGuiCore/informationPageConfiguration.h>
#include <vrfGuiObjectInformationQt/informationPageAssembler.h>

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

#include <vrvCore/DtSelectionManager.h>
#include <vrvCore/DtUniqueID.h>

#include <vrvCore/DtPageConfiguration.h>

#include <vlpi/entityType.h>

namespace makVrv
{
   class DtDe;
}

#define DtInformationDialogToken "ShowInformationDialog"

namespace makVrf
{
   class DtGuiSimObject;

   namespace makVrfGuiObjectInformationQt
   {
      const makVrv::DtPageConfiguration::PageCollectionLocation DtInformationDialogWithObjectConsole =
         (makVrv::DtPageConfiguration::PageCollectionLocation)(makVrv::DtPageConfiguration::Location_End );
      const makVrv::DtPageConfiguration::PageCollectionLocation DtInformationDialogWithoutObjectConsole =
         (makVrv::DtPageConfiguration::PageCollectionLocation)(makVrv::DtPageConfiguration::Location_End + 1 );

      class DtInformationDialog;
      class DtInformationSectionedDialog;

      class DT_DLL_VRFGUIOBJECTINFORMATIONQT DtInformationDialogManager : public makVrv::DtVirtualBaseClass
      {
      public:

         DtInformationDialogManager(makVrv::DtDe&);
         virtual ~DtInformationDialogManager() override;

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

      public:
         virtual void showDialogsFor(const makVrv::DtSelectionManager::IdSet&);
         virtual void showDialogFor(const makVrv::DtUniqueID&);
         virtual void scenarioEventStarted(DtSimObjectReference);

         virtual void showInformationDialogFor(makVrv::DtUniqueID, const std::string& page);

         virtual void addDialogCreator(makVrv::DtElementEntry::ObjectType, const std::string&);

         virtual void addDialogCreator(const DtEntityType&, const std::string&);

         virtual void removeDialogCreator(const DtEntityType&);

         virtual bool hasDialogFor(const makVrv::DtSelectionManager::IdSet& idSet) const;
         virtual bool hasDialogFor(const makVrv::DtUniqueID&) const;

         virtual DtInformationDialogWidgetSection* createDialogWidgetSection(makVrv::DtUniqueID);
         virtual DtInformationDialogWidgetSection* createDialogWidgetSection(const std::string& creator,
            DtSimObjectReference);

         virtual std::string dialogCreatorForElementType(makVrv::DtElementEntry::ObjectType) const;
         virtual std::string dialogCreatorFor(const DtEntityType&) const;
         virtual std::string dialogCreatorFor(makVrv::DtUniqueID id) const;

         DtInformationPageConfiguration& informationPageConfiguration();
         const DtInformationPageConfiguration& informationPageConfiguration() const;
         DtInformationPageAssembler& informationPageAssembler();

         virtual DtInformationDialogPage* createPage(const std::string& pageName);

         virtual std::string pageForInformationItem(const std::string& item) const;

         virtual DtInformationDialogHandler* createInformationDialog(const std::string& collection, DtSimObjectReference);

         virtual void removeAllInformationDialogs();

         boost::signals2::signal<void (DtInformationDialogHandler*, const DtEntityType&)> signal_dialogAboutToBeCreated;

         boost::signals2::signal<void (DtInformationDialogHandler*, const DtEntityType&)> signal_dialogCreated;


         virtual void addSelectedObjectInformationCreator(makVrv::DtElementEntry::ObjectType, const std::string&);

         virtual void addSelectedObjectInformationCreator(const DtEntityType&, const std::string&);

         virtual void removeSelectedObjectInformationCreator(const DtEntityType&);

         virtual bool hasSelectedObjectInformationFor(const makVrv::DtUniqueID&) const;

         virtual std::string selectedObjectInformationCreatorForElementType(makVrv::DtElementEntry::ObjectType) const;
         virtual std::string selectedObjectInformationCreatorFor(const DtEntityType&) const;
         virtual std::string selectedObjectInformationCreatorFor(makVrv::DtUniqueID id) const;

         virtual std::string proposedCreator(makVrv::DtUniqueID) const;
         virtual DtInformationDialogWidgetSection* createSelectedObjectInformationWidgetSection(makVrv::DtUniqueID, const std::string& useCreator = "");
         virtual DtInformationDialogWidgetSection* createSelectedObjectInformationWidgetSection(const std::string& creator,
            DtSimObjectReference);

         virtual void setMaximumSectionsPerDialog(int);
         int maximumSectionsPerDialog() const
         {
            return myMaximumSectionsPerDialog;
         }

         boost::signals2::signal<void ()> signal_informationDialogSetupComplete;

      protected:
         virtual void slot_safeToAccessData();
         virtual void scenarioRewinding();
         virtual void slot_onStateAboutToBeRemoved(DtSimObjectReference);
         virtual void slot_objectAdded(DtSimObjectReference);

         virtual void slot_infoDialogDestroyed(DtInformationDialogHandler* dlg, const makVrv::DtUniqueID&, bool keepSettingsData = false);

         virtual void slot_guiInstalled(bool lockStage);

         virtual void scenarioEventConcluded(DtSimObjectReference);
         virtual void multiSelectionDialogDestroyed(DtInformationDialogHandler*);
         virtual void initializeConnections();

         virtual bool keepInformationDialogUpOnRewind(const std::string& content) const;

         virtual bool isExternalState(makVrv::DtUniqueID) const;

      protected:
         typedef std::map<makVrv::DtElementEntry::ObjectType, std::string> DtDialogTypeCreatorList;

         makVrv::DtDe&                                      myDe;
         DtDialogTypeCreatorList                            myDialogCreators;
         DtDialogTypeCreatorList                            mySelectedObjectInformationCreators;

         DtOrderedEntityTypeList<std::string*>              myDialogCreatorsByEntityType;
         DtOrderedEntityTypeList<std::string*>              mySelectedObjectInformationCreatorsByEntityType;

         std::map<makVrv::DtUniqueID, DtInformationDialogHandler*>             myDialogs;
         DtInformationPageConfiguration                     myPageConfiguration;
         DtInformationPageAssembler                         myPageAssembler;

         typedef std::set<DtInformationSectionedDialog*>    MultipleSelectionDialogs;
         MultipleSelectionDialogs                           myMultipleSelectionDialogs;
         makVrv::DtSignalConnectionManager                  myConnections;
         int                                                myMaximumSectionsPerDialog;
         std::map<makVrv::DtUniqueID, std::string>          myWaitingForSimEntries;
         boost::signals2::scoped_connection                 mySimEntryAddedConnection;
      };
   }
}