createObjectPaletteLogic.h

Go to the documentation of this file.

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

 
#pragma once

#include <vrfGuiCoreQt/vrfGuiCoreQt.h>
#include <vrfGuiCore/entityMapperKey.h>
#include <vrvCore/DtMenuPath.h>
#include <vrvUtil/DtSignalConnectionManager.h>
#include <vrvUtil/DtVirtualBaseClass.h>

#include <QtCore/QString>

#include <vector>
#include <set>

#include <QString>

#include <boost/signals2.hpp>

class DtSimulationAddress;
class QString;

namespace makVrv
{
   class DtDe;
}

class DtModelSetEntry;

namespace makVrf
{
   class DtVrfBackendState;
   class DtPaletteFilter;

   class DtCreateObjectPaletteInterface;
   struct DtCreateObjectPaletteItem;

   typedef std::shared_ptr<DtCreateObjectPaletteItem> DtCreateObjectPaletteItemHandle;

   class DT_DLL_VRFGUICOREQT DtCreateObjectPaletteLogic
   {

   public: 
      
      DtCreateObjectPaletteLogic(makVrv::DtDe& de, DtCreateObjectPaletteInterface* iFace );

      virtual ~DtCreateObjectPaletteLogic();

      virtual void createAndAddItem(const std::string& name,
        const DtEntityMapperKey& key,const std::set<std::string>& categories,const std::vector<int>& forces,
        const std::string& description = "", int itemsToCreate = 0, const std::string& topLevelTag = "", const QString& shortName = "");

      virtual void removeItem(const DtEntityMapperKey& key, bool matchesPattern = false);

      virtual void disconnectCreationSignal(bool disconnect);

      virtual void setFavorite(const DtEntityMapperKey&, bool);

      static void addGlobalPaletteFilter(const DtPaletteFilter&);
      static void removeGlobalPaletteFilter(const DtPaletteFilter&);

      virtual void addLocalPaletteFilter(const DtPaletteFilter&);
      virtual void removeLocalPaletteFilter(const DtPaletteFilter&);

      bool showNonCreatableUnits() const { return myShowNonCreatableUnits; };
      virtual void setShowNonCreatableUnits(bool);

      virtual void addIgnore(const DtEntityType&);
      
      virtual void clearIgnore();

      virtual const std::vector<DtEntityType>& ignoring() const;

      virtual void setIgnore(const std::vector<DtEntityType>&);

      virtual void slot_defaultIconListChanged();

   protected:

      virtual void slot_postInitialize(makVrv::DtDe& de);
      virtual void slot_modelSetChanged();
      virtual void slot_categoriesChanged(std::vector<std::string> newCategories);
      virtual void slot_deployedCountryChanged(std::string newCategory);
      virtual void slot_executeFilter();

      virtual void slot_selectedBackEndChanged(const DtSimulationAddress& old, const DtSimulationAddress& newaddr);
      virtual void slot_backendUpdated(const DtVrfBackendState&, int);

      virtual void slot_createObject(const DtEntityMapperKey&);

      virtual bool modelIsCreatable(DtModelSetEntry*) const;

      virtual bool ignoreType(const DtEntityType&) const;

      virtual bool forceCanBeCreatedByUser(int) const;

      virtual bool shouldAddCreationItem(const DtCreateObjectPaletteItem&, const std::set<std::string>& categories, const std::string& deployedCountry, int force) const;
      virtual void enablePalette(int terrainPatchOffset = 0);
      virtual void slot_terrainPatchToBeDeleted();
      virtual void slot_terrainPatchAdded();
      virtual void slot_sessionStatusChanged();

      virtual void slot_forceChanged();

      virtual bool includeModelOnPage(DtModelSetEntry* model) const;

      virtual void delayedExecuteFilter();
      virtual void addAllItems();

   protected:
      makVrv::DtDe& myDe;
      DtCreateObjectPaletteInterface* myInterface;
      typedef std::map<std::string, std::set<DtCreateObjectPaletteItemHandle> > CategoriesMap;
      CategoriesMap myCategoriesMap;
      std::vector<DtCreateObjectPaletteItemHandle> myItems;
      makVrv::DtMenuPath myOrderedPath;
      bool myAllowOverlays;
      std::vector<std::string> myCategoriesToResetTo;

      static std::vector<DtPaletteFilter*> theGlobalPaletteFilters;
      std::vector<DtPaletteFilter*> myLocalPaletteFilters;
      std::map<int, std::string> myPotentialForces;
      makVrv::DtSignalConnectionManager myConnectionManager;
      std::vector<DtEntityType> myRemoveItems;
      bool myShowNonCreatableUnits;

      boost::signals2::scoped_connection myDelayedExecuteFilterConnection;

      std::vector<DtEntityType> myToIgnore;
      std::set<DtString> myTopLevelTags;
      int myCurrentlySelectedForce = -1;
      bool myItemsCreated = false;
   };

   class DT_DLL_VRFGUICOREQT DtCreateObjectPaletteLogicCreator : public makVrv::DtVirtualBaseClass
   {
   public:
      DtCreateObjectPaletteLogicCreator(makVrv::DtDe&);

      virtual ~DtCreateObjectPaletteLogicCreator() override;

      virtual DtCreateObjectPaletteLogic* create(DtCreateObjectPaletteInterface*);

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

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