DtTacticalGraphicNameVisualizer.h

Go to the documentation of this file.

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


#pragma once

#include <vrvCore/vrvCore.h>
#include <vrvCore/DtTacticalGraphicStateListener.h>
#include <vrvCore/DtStateVisualizer.h>
#include <vrvCore/DtSymbolDecorationUpdaterAgent.hpp>
#include <vrvCore/DtSharedDisplayUnitsSettings.h>

namespace makVrv
{
   namespace vrvTacticalGraphicUtilities
   {
      enum class FriendlyForceColorStyle : unsigned int;
   }

   class DtWidgetLabelAgent;
   class DtPinnableProjectedWidgetModelAgent;

   class DT_DLL_VRVCORE DtTacticalGraphicNameVisualizer :
      public DtStateVisualizer
   {
   public:
      typedef std::vector<DtVector> VertexList;

      enum class DtArealInformationPositionPolicy
      {
         MidpointOfVertices,
         FirstVertex
      };

      enum class DtArealInformationWorldBoundsPolicy
      {
         MaxExtents,
         TwoTimesDistanceBetweenFirstAndSecondVertices
      };

      enum class DtLinearNamePositionPolicy
      {
         UpwardByLineHeight,
         UpwardByHalfLineHeight,
         Leading,
         Trailing,
         EndUpwardByLineHeight,
         EndUpwardByHalfLineHeight
      };
      
      enum class DtLinearNameWorldBoundsPolicy
      {
         DistanceBetweenFirstAndSecondVertices, // distance between vertex 0 and vertex 1
         EntireLengthOfLine // sum of distances between all vertices
      };

   public:
      DtTacticalGraphicNameVisualizer(DtBaseConnection& simulation,
         DtStateListener& listener, DtSceneObjectAgent* sceneObject, DtModelSetId modelSet);

      virtual ~DtTacticalGraphicNameVisualizer();

      DtTacticalGraphicNameVisualizer() = delete;

      DtTacticalGraphicNameVisualizer(const DtTacticalGraphicNameVisualizer&) = delete;

      DtTacticalGraphicNameVisualizer& operator=(const DtTacticalGraphicNameVisualizer&) = delete;

      virtual void initialize() override;

      virtual void connectToListenerSignals() override;

      virtual void setTacticalGraphicsNameEnabled( bool enabled, bool instanceOnly = false );

      virtual const DtStateVisualizer::TypeInfo& typeInfo() const;

      static const DtStateVisualizer::TypeInfo& theTypeInfo();

      virtual void createModelAgents() override;

      virtual void destroyModelAgents() override;

      virtual std::string fontFile();

      virtual void setFontFile(std::string fontFile);

      virtual int fontSize() const;

      virtual void setFontSize(int size);

      virtual void setLocalVertexList(const VertexList&);

      const VertexList& localVertexList() const;

      virtual void setColor(float r, float g, float b, float a);

      void getColor(float& r, float& g, float& b, float& a) const;

      virtual void setClosedFigure(bool);

      bool closedFigure() const;

      virtual void setLabelPosition(DtVector& labelPosition);

      const DtVector& labelPosition() const;

      virtual void setIsTimeSensitive(bool);

      virtual bool isTimeSensitive() const;

      virtual void slot_colorChanged(float r, float g, float b, float a);

      virtual void slot_fontChanged(const std::string& fontFile, int fontSize);
      
      virtual void slot_closedFigureChanged(bool isClosedFigure);

      virtual void slot_activationDeactivationTimeSet();

      virtual void slot_nameChanged(const std::string& name);

      virtual std::string createDateTimeLabel(time_t totalSeconds) const;

      virtual void setIsFriendlyForceColorOverrideEnabled(bool enabled);

      virtual bool isFriendlyForceColorOverrideEnabled() const;

      virtual void slot_vertexAdded(const DtVector&);

      virtual void slot_vertexRemoved(int index);

      virtual void slot_vertexInserted(int index, const DtVector&);

      virtual void slot_vertexMoved(int index, const DtVector&);

      virtual void slot_vertexListUpdated(const VertexList&);

      virtual void slot_physicalLineHeightChanged(float height);

      virtual void setLabelOffset( int xOffset, int yOffset );

   protected:
      virtual void setModelDefinitionForAgents() override;

      virtual void updateLabelPosition();
      
      virtual void updateLabelString();

      virtual void updateTextColor();

      virtual DtUnicode createAreaInformationString() const;
      
      virtual DtUnicode createLinearInformationString() const;
      
      virtual void calculateLineLabelAngle(const std::vector<DtVector>& vertexList);

      virtual void setInitialValuesFromVisualizerDefinition();

      void setFriendlyForceColorStyle(vrvTacticalGraphicUtilities::FriendlyForceColorStyle style);

   protected:
      VertexList  myVertexList;

      float myColor[4];

      float mySelectedColor[4];

      DtTacticalGraphicStateListener* myTacticalGraphicListener;

      DtWidgetLabelAgent* myWidget;

      DtPinnableProjectedWidgetModelAgent* myWidgetModel;

      DtLinearNamePositionPolicy myLinearNamePositionPolicy;
      DtLinearNameWorldBoundsPolicy myLinearNameWorldBoundsPolicy;
      DtArealInformationPositionPolicy myArealInformationPositionPolicy;
      DtArealInformationWorldBoundsPolicy myArealInformationWorldBoundsPolicy;

      double myMinimumWorldDistanceForNameLabels;

      std::string myFontFile;

      int myFontSize;

      int myArrowAscii;

      std::string myTitle;

      std::string myArrowTitle;

      std::string myTitleAndNameSeparationString;
      std::string myArrowTitleAndNameSeparationString;

      std::string myName;

      DtVector myLabelPosition;

      double myLabelAngle;

      double myLabelMaxWorldDistance;

      bool myIsLinearArrowRendered;

      bool myIsTimeSensitive;

      bool myIsLabelFlipped;

      bool myClosedFigure;

      bool myIsFriendlyForceColorOverrideEnabled;
      vrvTacticalGraphicUtilities::FriendlyForceColorStyle myFriendlyForceColorStyle;

      std::pair<int,int> myLabelOffset;
   };

   typedef DtStateVisualizerCreatorTemplate<DtTacticalGraphicNameVisualizer>
      DtTacticalGraphicNameVisualizerCreator;

}