vrfGuiSymbolMapper.h

Go to the documentation of this file.

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



#pragma once

#include <vrfGuiCommonQt/vrfGuiCommonQt.h>
#include <vrvCore/DtVisualizerDefinitionSet.h>
#include <vrfGuiCore/guiSimObject.h>

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

#include <vrvCore/DtForceManager.h>
#include <vrvCoreQt/DtWidgetIconStyleManager.h>

#include <string>
#include <vector>

#include <QtGui/QPixmap>
#include <QtGui/QImage>
#include <QtCore/QCache>
#include <QtCore/QString>

#include <boost/unordered_map.hpp>

class DtUUID;

namespace makVrv
{
   class DtDe;
   class DtVisualizerDefinitionSet;
   class DtVisualizerDefinition;
}

namespace makVrf
{
   class DtEntityMapperKey;

   class DT_DLL_VRFGUICOMMONQT DtGuiSVGSymbolColorizerRule
   {
   public:
      DtGuiSVGSymbolColorizerRule(makVrv::DtDe& de) : myDe(de) {}
      DtGuiSVGSymbolColorizerRule(const DtGuiSVGSymbolColorizerRule& orig) : myDe(orig.myDe) {}
      virtual ~DtGuiSVGSymbolColorizerRule() {};

      virtual bool colorReplacementRule(const DtEntityMapperKey& key, std::pair<QColor, QColor>&) const = 0;
      virtual const char* colorizerName() const = 0;
      virtual DtGuiSVGSymbolColorizerRule* clone() const = 0;

   protected:
      makVrv::DtDe& myDe;
   };

   class DT_DLL_VRFGUICOMMONQT DtSVGColorSubstituteColorizerRule : public DtGuiSVGSymbolColorizerRule
   {
   public:
      DtSVGColorSubstituteColorizerRule(makVrv::DtDe& de, const std::string& colorizerName, const QColor& source, const QColor& destination);
      DtSVGColorSubstituteColorizerRule(const DtSVGColorSubstituteColorizerRule& orig);

      virtual bool colorReplacementRule(const DtEntityMapperKey& key, std::pair<QColor, QColor>&) const override;
      virtual const char* colorizerName() const override { return myColorizerName.c_str(); }
      virtual DtGuiSVGSymbolColorizerRule* clone() const override
      { return new DtSVGColorSubstituteColorizerRule(*this); }

   protected:
      QColor mySource;
      QColor myDestination;
      std::string myColorizerName;
   };

   class DT_DLL_VRFGUICOMMONQT DtSVGForceColorizerRule : public DtGuiSVGSymbolColorizerRule
   {
   public:
      DtSVGForceColorizerRule(makVrv::DtDe& de);
      DtSVGForceColorizerRule(const DtSVGForceColorizerRule& orig);

      virtual bool colorReplacementRule(const DtEntityMapperKey& key, std::pair<QColor, QColor>&) const override;
      virtual const char* colorizerName() const override { return "DtSVGForceColorizerRule"; }
      virtual DtGuiSVGSymbolColorizerRule* clone() const override { return new DtSVGForceColorizerRule(*this); }
   };

      class DT_DLL_VRFGUICOMMONQT DtSVGTopLevelCategoryColorizerRule : public DtGuiSVGSymbolColorizerRule
   {
   public:
      DtSVGTopLevelCategoryColorizerRule(makVrv::DtDe& de);
      DtSVGTopLevelCategoryColorizerRule(const DtSVGTopLevelCategoryColorizerRule& orig);

      virtual bool colorReplacementRule(const DtEntityMapperKey& key, std::pair<QColor, QColor>&) const override;
      virtual const char* colorizerName() const override { return "DtSVGTopLevelCategoryColorizerRule"; }
      virtual DtGuiSVGSymbolColorizerRule* clone() const override
      { return new DtSVGTopLevelCategoryColorizerRule(*this); }
   };

   class DT_DLL_VRFGUICOMMONQT DtVrfGuiSymbolMapper : public makVrv::DtVirtualBaseClass
   {
   public:
      DtVrfGuiSymbolMapper(makVrv::DtDe&);
      virtual ~DtVrfGuiSymbolMapper() override;

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

      virtual void clear();

      virtual void clearIcons(const DtEntityMapperKey&);

      virtual QPixmap getIcon(const DtEntityMapperKey&, bool destroyed = false, int pointSize = 48, bool sizeToFont = false,
         DtSimObjectReference baseState = DtSimObjectReference::nullReference(), const QSize& rescaleToIconSize = QSize(), bool isSpotReport = false,
         const QColor& milStdOutlineColor = Qt::black, bool fillMilStdSymbol = true, bool ignoreMenuIcon = false,
         const QColor& fillColor = Qt::transparent);

      virtual QPixmap getIcon(const DtUUID&, int pointSize = 48, bool sizeToFont = false,
         DtSimObjectReference baseState = DtSimObjectReference::nullReference(), const QSize& rescaleToIconSize = QSize(), bool isSpotReport = false,
         const QColor& milStdOutlineColor = Qt::black, bool fillMilStdSymbol = true, bool ignoreMenuIcon = false);

      virtual int addFont(const QString&);

      void setIconSize(int w, int h)
      {
         myIconSize = QSize(w, h);
      }

      const QSize& iconSize() const
      {
         return myIconSize;
      }

      virtual void addSVGColorizerRule(const DtGuiSVGSymbolColorizerRule&);
      virtual void removeSVGColorizerRule(const std::string&);
      virtual void removeAllSVGColorizerRules();

      virtual QImage iconImageForIcon(const DtEntityMapperKey&, const QColor& fillColor = Qt::transparent, const QSize& iconSize = QSize(16,16)) const;
      
      virtual QPixmap forceColorSwatch(int force);

      virtual QImage convertSvgUsingColorizerRules(const DtEntityMapperKey&, const QSize& pixmapSize, const std::string& image) const;

   protected:
      typedef boost::unordered_map<std::string, std::string> PathListMap;

      virtual const makVrv::DtVisualizerDefinitionSet* visualDefinitionSetThatBestMatches(const DtEntityMapperKey&, bool isSpotReport);
      virtual unsigned short echelonGlyphFor(const DtEntityMapperKey& key, const makVrv::DtVisualizerDefinition* set) const;

      virtual QImage milStdRender(const makVrv::DtVisualizerDefinition*, const DtEntityMapperKey& key, bool destroyed, int pointSize,
         const QColor& outlineColor = Qt::black, bool fillMilStdSymbol = true, DtSimObjectReference baseState = DtSimObjectReference::nullReference(),
         const QColor& fillColor = Qt::transparent) const;
      virtual QImage imageSymbolRender(const makVrv::DtVisualizerDefinition*, const DtEntityMapperKey& key, bool destroyed,
         DtSimObjectReference baseState = DtSimObjectReference::nullReference(), const QSize& iconSize = QSize(16,16)) const;

      virtual QImage imageFromModelDefinition(const std::string&, const QSize& iconSize = QSize(16,16)) const;

      virtual DtEntityType menuItemIconIsObjectType(const DtEntityMapperKey&) const;

      virtual void composeMilStdImage(QPainter& painter, int left, int base,
         unsigned short fillGlyph, unsigned short outlineGlyph, unsigned short echelonGlyph, unsigned short destroyedGlyph,
         makVrv::DtForceManager::RGBAColor fillColor, makVrv::DtForceManager::RGBAColor outlineColor,
         DtSimObjectReference baseState = DtSimObjectReference::nullReference()) const;

      virtual QImage menuItemIcon(const DtEntityMapperKey&, const QSize& iconSize = QSize()) const;

   protected:
      makVrv::DtDe& myDe;
      QHash<QString, QPixmap*>   myIconCache;
      QHash<int, QPixmap*>       myForceSwatchCache;
      QHash<int, QString>        myFontMap;
      QSize                      myIconSize;

      PathListMap myAggregateMap;
      PathListMap myTacticalMap;
      PathListMap myEntityMap;

      makVrv::DtSignalConnectionManager myConnectionManager;

      typedef std::map<std::string, DtGuiSVGSymbolColorizerRule*> SVGColorizerRules;
      SVGColorizerRules mySVGColorizerRules;
   };
}