vrfHierarchyPageLogic.h

Go to the documentation of this file.

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



#pragma once

#include <vrfGuiCoreQt/vrfGuiCoreQt.h>
#include <vrfGuiCoreQt/vrfObjectListViewItem.h>
#include <vrvCore/DtElementIDHierarchy.h>
#include <vrvCore/DtElementData.h>
#include <vrvCore/DtElementAttributeManager.h>
#include <vrvCore/DtSelectionManager.h>
#include <vrfGuiCore/sharedVrfVrlApplicationSettings.h>
#include <vrfGuiCore/vrfSelectionFilters.h>
#include <vrvUtil/DtSignalConnectionManager.h>
#include <boost/signals2.hpp>
#include <vrfutil/rwColor.h>
#include <vlutil/vlPerformanceStats.h>

#include <QtCore/QPoint>
#include <QtCore/QObject>

#include <map>
#include <unordered_map>
#include <unordered_set>

class QTreeWidgetItem;
class QModelIndex;

namespace makVrv
{
   class DtDe;
   class DtElementIDHierarchyNode;
};

namespace makVrf
{
   class DtVrfHierarchyPage;
   class DtObjectListViewItem;
   class DtVrfStateViewCollectionManager;
   class DtExpandCollapseButton;

   class DT_DLL_VRFGUICOREQT DtVrfChildToParentSelectionFilter : public DtVrfSelectionFilter
   {
   public:
      DtVrfChildToParentSelectionFilter();
      DtVrfChildToParentSelectionFilter(const DtVrfChildToParentSelectionFilter&);

      void setParentItem(DtObjectListViewItem*);
      void setForce(int) {};

   protected:
      DtObjectListViewItem* myParentItem;
   };

   class DT_DLL_VRFGUICOREQT DtVrfHierarchyPageLogic : public QObject
   {
      Q_OBJECT

   public:
      enum ParentNodeContext
      {
         Aerodrome = 1,
         UserStart = 16
      };

   public:
      DtVrfHierarchyPageLogic( makVrv::DtDe& de, DtVrfHierarchyPage* iface );
      virtual ~DtVrfHierarchyPageLogic();

   public:
      virtual void slot_itemSelectionChanged();
      virtual void slot_rightClickOnItem(QPoint global);
      virtual QTreeWidgetItem* itemForState(const DtObjectListViewItem::DtVrfObjectState s) const;
      virtual void expandToLevel(unsigned int i);
      virtual void collapseToLevel(unsigned int i);
      virtual void viewItemExpanded(QTreeWidgetItem* i);
      virtual void viewItemCollapsed(QTreeWidgetItem* i);
      virtual DtObjectListViewItem* itemByUUID(const DtUUID& uuid) const;

      virtual bool isForceRootNode(makVrv::DtUniqueID) const;
      virtual bool isOrganizedRootNode(QTreeWidgetItem*) const;
      virtual int forceForRootNode(makVrv::DtUniqueID) const;

      virtual void deparent(const QStringList&) = 0;
      virtual void reparent(const QStringList& children, makVrv::DtUniqueID parentId) = 0;
      virtual bool hierarchyStateFor(makVrv::DtUniqueID, makVrv::DtElementIDHierarchyState&) const = 0;

      virtual bool processHierarchyItem(makVrv::DtElementIDHierarchyNode*, bool force = false);

      virtual void setShowObjectConsoleWarning(bool b);
      virtual bool showObjectConsoleWarningIcon() const;

      virtual void setTextFilter(const QString&);

      virtual void setShowCountsOnObjectList(bool);

      virtual void setShowEchelonIdColumn(bool);
      virtual bool showEchelonIdColumn() const;
      virtual QTreeWidgetItem* rootNodeForItem(DtObjectListViewItem*) const;
      virtual QTreeWidgetItem* parentNodeForItem(DtObjectListViewItem*) const;

      virtual void activate();

      virtual int sortColumn() const;

      virtual int initialSortColumn() const;

      virtual void setDoubleClickAttachesAndCenters(bool b)
      {
         myDoubleClickAttachesAndCenters = b;
      }

      bool doubleClickAttachesAndCenters() const
      {
         return myDoubleClickAttachesAndCenters;
      }

      virtual void setInitiallyExpand(bool);
      bool initiallyExpand() const
      {
         return myInitiallyExpand;
      }

      virtual void setGrayOutHiddenItems(bool);
      bool grayOutHiddenItems() const
      {
         return myGrayOutHiddenItems;
      }

      virtual DtObjectListViewItem* addOrganizedRootNode(const QString& name, const DtFilename& iconFile, const DtVrfSelectionFilter& filter, int index = -1,
         const QString& beforeItem = "", bool keepUnderThisNodeIfTacticalGraphic = false);

      virtual bool removeOrganizedRootNode(const QString&);

      virtual void addOrganizedParentNode(ParentNodeContext, const DtVrfSelectionFilter& potentialParent, const DtVrfSelectionFilter& potentialChild);
      virtual void removeOrganizedParentNode(ParentNodeContext);

      virtual bool showCountsOnObjectList() const;

      virtual bool canDisplayChildCounts() const;

      boost::signals2::signal<void (makVrv::DtUniqueID)> signal_itemRemoved;

   protected slots:
      virtual void addToChildCount(const QModelIndex&, int, int);
      virtual void removeFromChildCount(const QModelIndex&, int, int);

   protected:
      virtual void enableChildCount();
      virtual void disableChildCount();

      virtual bool handleStealthObjects() const;

      virtual void slot_gumballSettingsChanged(bool b);

      virtual void checkForInitialExpansion(DtObjectListViewItem*);
      virtual bool passesFogOfWarFilters(const makVrv::DtStateView<makVrv::DtVrlinkSimulatedBaseState>* s) const;
      virtual void scenarioClosed();
      virtual void moveItemToNewForceNode(makVrv::DtUniqueID, int force);
      virtual makVrv::DtSimEntryUpdater::UpdateRate currentUpdateRate(makVrv::DtStateView<makVrv::DtVrlinkSimulatedBaseState>* sv) const;
      void clearChildrenInAdvanceOfDelete(DtObjectListViewItem* item);

      virtual void entityStateChanged(makVrv::DtElementID, DtSharedVrfVrlApplicationSettings::EntityStates, bool);

      virtual void slot_onTick();

      virtual void slot_onStateViewAdded(const makVrv::DtStateView<makVrv::DtVrlinkSimulatedBaseState>* s);

      virtual bool addNode(makVrv::DtElementIDHierarchyNode*) const;

      virtual bool isValidState(makVrv::DtUniqueID) const;
      virtual bool isValidState(const makVrv::DtStateView<makVrv::DtVrlinkSimulatedBaseState>* s) const;
      
      virtual void filterItems();

      virtual void filterTDLItems();

      virtual void stateViewUpdated();

      virtual void resorted();

      virtual DtVrfStateViewCollectionManager& vrfStateViewCollectionManager() const;

      virtual DtObjectListViewItem* addForceLevelRootNode(int, const DtString& forceName, bool includeUnkownForForce = false);


      virtual void hookOrganizedParentToChildren();
      virtual void onDataChanged(DtObjectListViewItem* item);

   protected:
      virtual void forcesChanged();
      virtual void unhandledStateView(const makVrv::DtStateView<makVrv::DtVrlinkSimulatedBaseState>*);

      virtual void slot_itemDoubleClicked(QTreeWidgetItem*);

      virtual void clearExpansionStateFor(DtObjectListViewItem*);

      virtual void removeNode(makVrv::DtElementID);
      virtual bool positionNodeInHierarchy(makVrv::DtElementIDHierarchyNode*, bool force = false);
      virtual void hookChildToParent(makVrv::DtElementIDHierarchyNode*, bool forceUpdate = false);
      virtual void hookParentToChildren(makVrv::DtElementIDHierarchyNode*, bool forceUpdate = false);
      virtual DtObjectListViewItem* createItemFor(makVrv::DtElementIDHierarchyNode*);
      virtual QVariant echelonId(const DtObjectListViewItem*) const;
      virtual void slot_stateViewAboutToBeRemoved(const makVrv::DtStateView<DtVrfObjectDataState>& s);

      virtual void cleanupHierarchyItem(DtObjectListViewItem* item);
      virtual void createdHierarchyItem(DtObjectListViewItem* item);

      virtual void deferredItemSelectionChanged();

   protected:
      virtual bool performOperationsImmediately() const;
      virtual void addDataFunctions(DtObjectListViewItem* item);
      virtual void addSortingFunctions(DtObjectListViewItem* item);
      virtual void slot_externalSelectionChanged(
         const makVrv::DtSelectionManager::IdSet& selected,
         const makVrv::DtSelectionManager::IdSet& deselected );

      virtual void updateCollapseButtons();
      virtual void updateCollapseButtons(QTreeWidgetItem*);

      virtual void createCollapseButton(unsigned int);
      virtual void expandToLevel(unsigned int level, QTreeWidgetItem* lvi);
      virtual void collapseToLevel(unsigned int level, QTreeWidgetItem* lvi);

      virtual void hierarchyItemsModified(const makVrv::DtElementAttributeManager::EntryAttributesList&) = 0;
      virtual short supportsAttribute() const = 0;

      virtual void hierarchyItemsRemoved(const makVrv::DtElementData::UniqueIdList&);
      virtual void setupForceRootNodes();
      virtual bool sortBySubordinatePosition(const DtObjectListViewItem& rhs, const DtObjectListViewItem& lhs);

      virtual void checkPendingOperations();
      virtual void checkFogOfWar(DtObjectListViewItem*, int oldForce = -1, int newForce = -1);
      virtual void onForceChanged(DtObjectListViewItem*, int oldForce = -1, int newForce = -1);
      virtual void onDamageStateChanged(DtObjectListViewItem*, bool isDestroyed = false);
      virtual void onActivatedStateChanged(DtObjectListViewItem*, bool isActivated = true);
      virtual void onMarkingTextFilterChanged(DtObjectListViewItem*);
      virtual void slot_extendedApplicationOptionsChanged();
      virtual void updateRootNodeVisibility(DtObjectListViewItem*);

      virtual DtObjectListViewItem* itemFor(makVrv::DtElementIDHierarchyNode* node) const;

      virtual void slot_onUpdateRateChanged(makVrv::DtUniqueID id, int rate);
      virtual void completeRateChange(makVrv::DtUniqueID id);

      virtual void itemPositioned(DtObjectListViewItem*);

      virtual void checkParentVisibility(DtObjectListViewItem*);

      virtual void restoreExpansionState(QTreeWidgetItem*, bool expanded);

      virtual void initialize();
      
      virtual void resetVisuals();
     virtual void resetIconColor(DtRwColor, const std::vector<makVrv::DtUniqueID>& ids);

      virtual void slot_uuidChanged(makVrv::DtUniqueID id, const DtUUID& oldUUID, const DtUUID& newUUID);

      virtual void slot_objectVisibilityChanged(makVrv::DtUniqueID id, bool);

      virtual void addToPotentialParents(DtObjectListViewItem*);
      virtual void removeFromPotentialParents(DtObjectListViewItem*);

   protected:
      typedef std::unordered_map<makVrv::DtElementID, DtObjectListViewItem*>  DtHierarchyListItemMap;
      typedef std::unordered_map<makVrv::DtElementID, double> PendingOperationsMap;

      makVrv::DtDe&           myDe;
      DtVrfHierarchyPage*     myInterface;
      std::vector<DtExpandCollapseButton*> myCollapseButtonVector;
      boost::signals2::connection myGrayIfHiddenConnection;
      DtHierarchyListItemMap  myItems;
      std::set<DtObjectListViewItem*>  myItemsToCheckForFurtherOrgainization;

      bool                 myUpdateCollapseButtons;
      bool                 myShowEchelonIdColumn;
      bool                 myFirstTick;
      bool                 myInitiallyExpand;
      bool                 myDoubleClickAttachesAndCenters;
      bool                 myNeedsResort;
      bool                 myHideForceLevelNodesWhenNoChildren;
      std::set<QTreeWidgetItem*> myRootNodesForVisibilityCheck;

      bool                 myUseForceRootOrganization;
      PendingOperationsMap myPendingOperations;
      makVrv::DtSignalConnectionManager myConnectionManager;
      boost::signals2::scoped_connection myDeferredSelectionSignalConnection;
      boost::signals2::scoped_connection myRightClickSignalConnection;

      bool myShowObjectConsoleWarningIcon;

      std::map<DtUUID, bool> myExpandedNodes;
      std::map<DtUUID, DtObjectListViewItem*> myItemsByUUID;

      struct OrganizedRootNode
      {
         OrganizedRootNode() : selectionFilter(nullptr), stateData(nullptr), uniqueID(0), objectListViewItem(nullptr), keepUnderThisNodeIfTacticalGraphic(false) {};

         DtVrfSelectionFilter* selectionFilter;
         DtSimpleObjectDataState* stateData;
         makVrv::DtUniqueID uniqueID;
         DtObjectListViewItem* objectListViewItem;
         bool keepUnderThisNodeIfTacticalGraphic;
      };

      typedef std::vector<OrganizedRootNode> OrganizationOrder;
      OrganizationOrder myOrganizationOrder;

      typedef std::map<makVrv::DtUniqueID, OrganizedRootNode> OrganizedRootNodes;
      OrganizedRootNodes  myOrganizedRootNodes;

      typedef std::map<int, OrganizedRootNode> ForceRootNodes;
      ForceRootNodes myForceRootNodes;

      struct OrganizedParentNode
      {
         OrganizedParentNode() : parentFilter(nullptr), childFilter(nullptr) {};
         virtual ~OrganizedParentNode();

         std::shared_ptr<DtVrfSelectionFilter> parentFilter;
         std::shared_ptr<DtVrfSelectionFilter> childFilter;
         std::set<DtObjectListViewItem*> parentNodes;
      };

      typedef std::map<ParentNodeContext, OrganizedParentNode> OrganizedParentNodes;
      OrganizedParentNodes myOrganizedParentNodes;

      std::map<makVrv::DtUniqueID, makVrv::DtSignalConnectionManager*> myRateChanges;

      mutable DtVrfStateViewCollectionManager* myVrfStateViewCollectionManager;

      QString myTextFilter;

      bool myGrayOutHiddenItems;
      int myLastForceType;
      int myDeferredSelectionCounter;
      bool myWaitForStateAddition = false;
      int myLastPendingOperationsSize = 0;
   };
}