objectListViewItem.h

Go to the documentation of this file.

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


#pragma once



#include <vrfGuiCommonQt/vrfGuiCommonQt.h>
#include <vrfutil/rwUUID.h>
#include <vrfGuiCore/guiSimObject.h>
#include <vrvUtil/DtVirtualBaseClass.h>

#include <string>

#include <vrvUtil/DtSignalConnectionManager.h>

#include <QtWidgets/QTreeWidget>
#include <QtCore/QVariant>

#include <boost/function.hpp>

namespace makVrv
{
   class DtDe;
   class DtGlobalIDHierarchyNode;
}

namespace makVrf
{
   class DtObjectVisibilityManager;

   class DT_DLL_VRFGUICOMMONQT DtObjectListViewItem : public QTreeWidgetItem
   {
   public:
      enum ShowHideFlags
      {
         FogOfWar = 1,
         NotInOrbat = 2,
         NoStateView = 3,
         NoChildren = 4,
         TextFilter = 5
      };

      enum Roles
      {
         AddedToChildCountRole = Qt::UserRole + 1022
      };

   public:
      DtObjectListViewItem(makVrv::DtDe& de, DtSimObjectReference state);

      virtual ~DtObjectListViewItem() override;

   public:
      virtual bool isMatchingItem(DtSimObjectReference state) const;
      virtual bool isDestroyed() const;
      virtual void setGrayIfHidden(bool);
      bool grayIfHidden() const
      {
         return myGrayIfHidden;
      }

      virtual QVariant data(int iCol, int iRole) const override;
      virtual void clearIcon();

      virtual void updateHiddenState(bool iterateChildren = false);

      virtual void setStateView(DtSimObjectReference);

      void clearStateView()
      {
         myStateView.reset();
      }

      bool isStealthObserver() const;
      bool isInactive() const;

      virtual bool canBeAttachedTo() const;

      void setStealthType(const DtEntityType& s)
      {
         myStealthType = s;
      }

      virtual bool isTDLItem() const;
      virtual bool sortByNameNumerical(const DtObjectListViewItem&, const DtObjectListViewItem&) const;
      virtual bool sortByEchelonId(const DtObjectListViewItem& lhs, const DtObjectListViewItem& rhs) const;
      virtual bool sortByForce(const DtObjectListViewItem& lhs, const DtObjectListViewItem& rhs) const;

      virtual bool sortByOrbatOrder(const DtObjectListViewItem& lhs, const DtObjectListViewItem& rhs) const;

      virtual void setShowObjectConsoleWarningIcon(bool, bool refresh = true);
      virtual void setHasMessagesAwaiting(bool, bool refresh = true);
      virtual void setHasQuestionsAwaiting(bool, bool refresh = true);
      virtual void setSignalOnForceChange(bool);
      virtual void setSignalOnActivatedStateChanged(bool);
      virtual void setSignalOnDamageStateChange(bool);

      virtual void checkTextFilter();

      virtual void checkTextFilterUpToParent();

      virtual void setShowGumballs(bool b);
      bool showGumballs() const
      {
         return myShowGumball;
      }

      virtual void setTextFilter(const QString&);
      const QString& textFilter() const
      {
         return myTextFilter;
      }

      virtual void setHidden(bool, ShowHideFlags);
      virtual bool isHidden() const;
      virtual bool isHiddenBy(ShowHideFlags f) const
      {
         return (myShowHideFlags.find(f) != myShowHideFlags.end());
      }

      virtual bool parseNumber(const DtObjectListViewItem&, int& number, QString& name) const;
      virtual bool parseNumber(const QString&, int& number, QString& name) const;

      virtual int force() const;

      const DtUUID& uuid() const
      {
         return myUUID;
      }

      virtual void setUUID(const DtUUID&);
      bool signalOnActivatedStateChanged() const;
      bool signalOnForceChange() const;
      bool signalOnDamageStateChange() const;

      const QString& markingTextWithoutNumber() const
      {
         return myMarkingTextWithoutNumber;
      }

      int markingTextNumber() const
      {
         return myMarkingTextNumber;
      }

      bool hasMarkingTextNumber() const
      {
         return myHasMarkingTextNumber;
      }

      makVrv::DtUniqueID stateViewId() const
      {
         return myStateViewId;
      }

      DtSimObjectReference stateView() const
      {
         return myStateView;
      }

      virtual std::map<std::string, std::string> extendedData() const;

      typedef boost::function<void (DtObjectListViewItem*, std::string)> DataChangedNotifyFunction;
      virtual void notifyOnExtendedDataChanged(const std::string&, DataChangedNotifyFunction f, bool onlyOnce = true);

      void addSortingFunction(int col, const boost::function<bool (const DtObjectListViewItem& rhs, const DtObjectListViewItem& lhs)>& f)
      {
         mySortingFunctions[col] = f;
      }

      void removeSortingFunction(int col)
      {
         DtSortingFunctionMap::iterator iter = mySortingFunctions.find(col);

         if (iter != mySortingFunctions.end())
         {
            mySortingFunctions.erase(iter);
         }
      }

      virtual bool blockChildCountDisplay(bool b);

      void addDataFunction(short col, short role, const boost::function<QVariant (const DtObjectListViewItem*)>& func)
      {
         myDataFunctionMap[makeKey(col, role)] = func;
      }

      void removeDataFunction(short col, short role)
      {
         DtDataFunctionMap::iterator iter = myDataFunctionMap.find(makeKey(col, role));

         if (iter != myDataFunctionMap.end())
         {
            myDataFunctionMap.erase(iter);
         }
      }

      virtual void setBaseIcon(QString);
      virtual void setBaseIcon(const QPixmap&);
      const QPixmap& baseIcon() const
      {
         return myBaseIcon;
      }

      virtual void setPrependToName(const QString&);
      const QString& prependToName() const
      {
         return myPrependToName;
      }

      virtual void setPrependPixmap(const QPixmap&);
      const QPixmap& prependPixmap() const
      {
         return myPrependPixmap;
      }

      virtual void enableChildCount();
      bool childCountEnabled() const
      {
         return myChildCountEnabled;
      }

      virtual void setDisplayChildCount(bool);
      bool displayChildCount() const
      {
         return myDisplayChildCount;
      }

      virtual void addToChildCount(int);

      virtual void setAppendToName(const QString&);
      virtual QString appendToName() const;

      virtual void setAppendPixmap(const QPixmap&);
      const QPixmap& appendPixmap() const
      {
         return myAppendPixmap;
      }

      virtual void setCanBeOrganized(bool);
      bool canBeOrganized() const
      {
         return myCanBeOrganized;
      }

      virtual void setSignalOnDataUpdates(bool);
      bool signalOnDataUpdates() const
      {
         return mySignalOnDataUpdates;
      }

      DtObjectVisibilityManager& objectVisibilityManager() const
      {
         return myObjectVisibilityManager;
      }

      virtual void addNameFunction(short col);
      virtual void removeNameFunction(short col);

      virtual void addTextColorIfHiddenFunction(short col);
      virtual void removeTextColorIfHiddenFunction(short col);

      virtual void addToolTipFunction(short col);
      virtual void removeToolTipFunction(short col);

      virtual void addIconFunction(short col);
      virtual void removeIconFunction(short col);

      virtual void addIconSizeHintFunction(short col);
      virtual void removeIconSizeHintFunction(short col);

      virtual void addIconAndGumballFunction(short col);
      virtual void removeIconAndGumballFunction(short col);

      virtual void addIconAndGumballSizeHintFunction(short col);
      virtual void removeIconAndGumballSizeHintFunction(short col);

      virtual bool operator<(const QTreeWidgetItem& other) const override;

      virtual bool hasGumball() const;

      virtual QString markingText() const;

      virtual void slot_stateViewAboutToBeRemoved();

      virtual void setIsOrbatEnabled(bool);
      virtual bool isOrbatEnabled() const;

      virtual void setSortOrder(int i);
      int sortOrder() const
      {
         return mySortOrder;
      }

      virtual void setShowNotInOrbat(bool);
      virtual bool showNotInOrbat() const;

      virtual void setOrderByOrbatOrder(bool);
      virtual bool orderByOrbatOrder() const;

      virtual void setEditText(const QString& s);
      virtual const QString& editText() const;

      virtual void updateOrbatState();
      virtual bool isOrbatViewOnly() const;
      virtual bool isCreated() const;
      virtual bool isInOrbatOnly() const;
      virtual QVariant iconFunction(const DtObjectListViewItem*) const;
      virtual void setIcon(const QPixmap&);
      virtual void setIcon(int column, const QPixmap&);

      virtual void setDisplayType(const DtEntityType&, int force);
      virtual void clearDisplayType();

      virtual bool isInOrbatView() const;
      virtual void updateChildCount();

      virtual QVariant laserDesignatorName(const DtObjectListViewItem*) const;

      virtual QVariant iconSizeHint(const DtObjectListViewItem*) const;

      boost::signals2::signal<void (DtObjectListViewItem*, int, int)> signal_forceChanged;
      boost::signals2::signal<void (DtObjectListViewItem*)> signal_itemUpdated;
      boost::signals2::signal<void (DtObjectListViewItem*)> signal_destroyed;
      boost::signals2::signal<void (DtObjectListViewItem*)> signal_markingTextFilterChanged;
      boost::signals2::signal<void (DtObjectListViewItem*)> signal_extendedDataChanged;
      boost::signals2::signal<void (DtObjectListViewItem*)> signal_statePropertiesChanged;
      boost::signals2::signal<void (DtObjectListViewItem*, bool)> signal_damageStateChanged;
      boost::signals2::signal<void (DtObjectListViewItem*, bool)> signal_activateStateChanged;

   protected:
      virtual void updateMarkingTextInformation();

      virtual void resetBaseIcon(QString);
      virtual void slot_onStateViewUpdated(DtSimObjectReference s);
      virtual std::string iconKeyString() const;
      virtual std::string gumballKeyString() const;

      virtual bool needsIconUpdate(std::string* resultKey = 0) const;
      virtual bool needsGumballUpdate(std::string* resultKey = 0) const;
      virtual void slot_orbatStateChanged(makVrv::DtUniqueID, bool);
      virtual int getDesignator(const std::string& echelon) const;
      virtual void updateChildCount(QTreeWidgetItem*);

   protected:
      virtual QVariant name(const DtObjectListViewItem*) const;

      virtual QVariant editRole(const DtObjectListViewItem* i) const;

      virtual QVariant gumball(const DtObjectListViewItem*) const;
      virtual QVariant iconAndGumball(const DtObjectListViewItem*) const;
      virtual QVariant iconAndGumballSizeHint(const DtObjectListViewItem*) const;
      virtual void finishUpdate();

      int makeKey(short col, short role) const
      {
         return (col << 16) | role;
      }

      virtual QVariant textColorForHiddenItem(const DtObjectListViewItem* item) const;

      virtual QPixmap adjustForHidden(const QPixmap&) const;
      virtual QImage adjustForHidden(const QImage&) const;

   public:
      static bool theShowUUIDForBlankName;

   protected:
      typedef std::map<int, boost::function<QVariant (const DtObjectListViewItem*)> > DtDataFunctionMap;
      typedef std::map<int, boost::function<bool (const DtObjectListViewItem& rhs, const DtObjectListViewItem& lhs)> > DtSortingFunctionMap;

      makVrv::DtDe&                       myDe;
      DtEntityType myStealthType;
      DtUUID myUUID;
      makVrv::DtUniqueID myStateViewId;
      DtSimObjectReference myStateView;
      int mySortOrder = 0;
      bool                                myIsDestroyed;
      bool                                mySignalOnForceChange;
      bool                                mySignalOnDamageStateChanged;
      bool                                mySignalOnActivatedStateChanged;
      bool                                myIsSimpleObjectDataState;
      bool                                myShowGumball;
      bool                                myHasGumball;
      bool                                myBlockChildCountDisplay = false;
      DtDataFunctionMap                   myDataFunctionMap;
      DtSortingFunctionMap                mySortingFunctions;
      makVrv::DtSignalConnectionManager   myConnections;
      makVrv::DtSignalConnectionManager   myIconConnections;
      makVrv::DtSignalConnectionManager   myOrbatConnections;
      makVrv::DtSignalConnectionManager   myStateViewUpdateConnections;
      boost::signals2::connection         myUpdateConnection;

      bool myShowObjectConsoleWarningIcon;
      bool myHasMessagesAwaiting;
      bool myHasQuestionsAwaiting;
      bool myIsOrbatEnabled;
      bool myShowNotInOrbat;
      bool myIsInOrbatView;
      bool myOrderByOrbatOrder;
      bool myUpdateForced;

      QString myEditText;

      mutable QPixmap myIcon;
      mutable QPixmap myGumball;
      mutable QPixmap myPixmap;
      mutable std::string myIconString;
      mutable std::string myGumballString;

      std::set<ShowHideFlags> myShowHideFlags;

      DtEntityType myDisplayType;
      int myDisplayForce;
      bool myUseDisplayType;
      bool myGrayIfHidden;

      QString myTextFilter;
      QString myPrependToName;
      QPixmap myPrependPixmap;
      QString myAppendToName;
      QPixmap myAppendPixmap;
      QPixmap myBaseIcon;

      mutable int myRightMargin;

      double myLastTimeStatePropertiesUpdated = 0.;
      bool myCanBeOrganized;
      bool mySignalOnDataUpdates;

      bool myHasMarkingTextNumber = false;
      QString myMarkingText;
      QString myMarkingTextWithoutNumber;
      int myMarkingTextNumber = 0;
      DtObjectVisibilityManager& myObjectVisibilityManager;

      bool myChildCountEnabled = false;
      bool myDisplayChildCount = false;
      int myChildCount = 0;

      typedef std::map<std::string, std::pair<DataChangedNotifyFunction, bool> > NotifyOnExtendedDataChangedMap;
      NotifyOnExtendedDataChangedMap myNotifyOnExtendedDataChangedMap;

      struct LastObjectUpdateData
      {
         std::string objectName;
         int forceType = -1;
         bool isDestroyed = false;
         bool activated = false;
         std::map<std::string, std::string> extendedData;
      };

      LastObjectUpdateData myLastObjectUpdateData;
   };

   class DT_DLL_VRFGUICOMMONQT DtObjectListViewItemCreator : public makVrv::DtVirtualBaseClass
   {
   public:
      DtObjectListViewItemCreator(makVrv::DtDe&);

      virtual ~DtObjectListViewItemCreator() override;

      virtual DtObjectListViewItem* create(DtSimObjectReference);

      static DtObjectListViewItemCreator& instance(makVrv::DtDe& de);
      static void registerInstance(makVrv::DtDe& de, DtObjectListViewItemCreator*);

   protected:
      makVrv::DtDe& myDe;
   };
}