DtSymbolDecorationVisualizer.h

Go to the documentation of this file.

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


#pragma once

#include <vrvCore/vrvCore.h>
#include <vrvCore/DtStateVisualizer.h>

#include <vrvCore/DtSymbolDecorationSettings.h>
#include <vrvCore/DtAttributeGroupWidget.h>

#include <vrvUtil/DtSignalConnectionManager.h>

#include <vrvMath/DtVector4.h>

#include <makArchives/DtAltitudeBasedScaleConfigurationRecord.h>

#include <vlutil/vlExceptions.h>

#include <matrix/vlVector.h>

#include <vector>
#include <string>
#include <unordered_map>

namespace makVrv
{

   class DtAttributeGroupWidgetAgent;
   class DtPinnableProjectedWidgetModelAgent;
   class DtSymbolDecorationUpdaterAgent;
   class DtOverlayDirectionLineModelAgent;
   class DtLineIndicatorSymbolDecorationUpdaterAgent;
   class DtLocationSymbolDecoration;
   class DtAccelerationSymbolDecoration;
   class DtVelocitySymbolDecoration;
   class DtOrientationSymbolDecoration;
   class DtObjectTypeStateListener;
   class DtSymbolDecoration;

   enum class DtSymbolDecorationQuadrant
   {
      TopRight,
      TopLeft,
      BottomLeft,
      BottomRight
   };

   class DT_DLL_VRVCORE DtSymbolDecorationVisualizer
      : public DtStateVisualizer
   {
   public:
      using DecorationIdMap = std::unordered_map<std::string, DtSymbolDecoration*>;

      using DecorationProperties = std::vector<std::string>;

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

      virtual ~DtSymbolDecorationVisualizer();

      DtSymbolDecorationVisualizer() = delete;

      DtSymbolDecorationVisualizer( const DtSymbolDecorationVisualizer& ) = delete;

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

   public:

      virtual void createModelAgents() override;

      virtual void destroyModelAgents() override;

      virtual void setModelDefinitionForAgents() override;

      virtual void setOrigin(const DtVector&);

      virtual void connectToListenerSignals() override;

      virtual void setInitialValuesFromVisualizerDefinition() override;

      virtual void slot_setSelected(bool) override;

      virtual DtAttributeGroupWidgetAgent* widget();

      virtual DtSymbolDecorationUpdaterAgent* widgetUpdater();

      virtual unsigned int nextLabelIndex();

      virtual void setLabelIndexForDecorationByName(unsigned int index, const std::string& name);
      
      virtual bool labelIndexForDecorationByName(unsigned int& index, const std::string& name) const;

      virtual void initialize() override;

      virtual DtSceneObjectAgent* sceneObject();

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

      virtual void setScale(float scale);

      virtual void setLineIndicatorScale(float scale);

      virtual int lineIndicatorWidth();

      virtual void setLineIndicatorWidth(int lineWidth);

      virtual DtVector4<float> headingLineIndicatorColor() const;

      virtual void setHeadingLineIndicatorColor(const DtVector4<float>& lineColor);
      
      virtual DtVector4<float> velocityLineIndicatorColor() const;

      virtual void setVelocityLineIndicatorColor(const DtVector4<float>& lineColor);

      virtual void setShowBorder(bool b);

      virtual bool useHighestTerrainLod() const;
      virtual void setUseHighestTerrainLod(bool trueOrFalse);

      virtual DtSymbolDecoration* findSymbolDecoration(
         const std::string& decorationId);

      virtual void setQuadrantLocation(DtSymbolDecorationQuadrant);

      virtual void setOffset(double x, double y);

      const DtVector& offset() const;

      virtual void setIsPinned(bool myPinned);

      virtual bool isPinned() const;

      virtual void setLodOutAltitude(double lodOutAltitude);

      virtual double lodOutAltitude() const;

      virtual void setFixedScalingEnabled(bool fixedScalingEnabled);

      virtual void setAltitudeBasedConfigurations(
         const makArchives::DtAltitudeBasedScaleConfigurationRecordCollection& collection);

      virtual void setHasMouseCursor(bool);
      virtual bool hasMouseCursor() const;

      virtual DtLineIndicatorSymbolDecorationUpdaterAgent* findOrCreateLineIndicatorSymbolDecorationUpdaterAgent();

      virtual void slot_decorationEnabled( DtModelSetId modelSet, const std::string& type, const std::string& decoration);

      virtual void slot_decorationDisabled( DtModelSetId modelSet, const std::string& type, const std::string& decoration);

      virtual void slot_mouseOverDecorationEnabled( DtModelSetId modelSet, const std::string& type, const std::string& decoration );
      virtual void slot_mouseOverDecorationDisabled( DtModelSetId modelSet, const std::string& type, const std::string& decoration );

      virtual void slot_foregroundColorChanged(float r, float g, float b);

      virtual void slot_backgroundColorChanged(float r, float g, float b);

      virtual void slot_backgroundOpacityChanged(float a);

      virtual void slot_lodOutAltitudeChanged(double a);

      virtual void slot_shadowTextChanged(bool enabled);

      virtual void slot_symbolDecorationSetChanged(const std::string& setId);

      virtual void slot_setScale(float scale);

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

      virtual void slot_colorByForceChanged(bool enabled);

      virtual void slot_displayUnitCollectionChanged(const std::string& displayUnitCollection );
   protected:

      virtual DtObjectTypeStateListener& objectTypeStateListener();

      virtual void updateAltitudeBasedHeadingIndicatorProperties();

      virtual void updateForcedAltitudeBasedConfigurationEnabledState();

      virtual void updateLodOutAltitudeProperties();

      virtual void updateLodOutAltitudeState();

      virtual void updateBackgroundState();
      
      virtual void setBorderState();

      virtual void updateColor();

      virtual void implementVisibility(bool visible) override;

      void cleanup();

   protected:

      DtSignalConnectionManager myModelAgentConns;

      DecorationProperties myDecorationProperties;

      DecorationIdMap myDecorationIdMap;
      DecorationIdMap myMouseOverDecorationIdMap;

      DtSymbolDecorationSettings::DecorationSet myDecorationSet;

      DtAttributeGroupWidgetAgent* myWidget;

      DtPinnableProjectedWidgetModelAgent* myWidgetModel;

      DtSymbolDecorationUpdaterAgent* myWidgetUpdater;
      
      DtLineIndicatorSymbolDecorationUpdaterAgent* myLineIndicatorUpdater;

      float myForegroundColor[3];

      float myBackgroundColor[4];

      float myBorderColor[4];

      bool myBackgroundHidden;

      float myForceColor[3];

      float myScale;

      DtAttributeGroupWidget::DtOriginPlacementPolicy myOriginPlacementPolicy;

      DtVector myWidgetOffsetUnscaled;

      float myFontSizeUnscaled;

      float myHeadingLineLengthUnscaled;

      float myWidgetColumnPadding;

      float myWidgetRowPadding;

      std::string myFontFile;

      std::string myDecorationSetName;

      std::string myDisplayUnitCollectionName;

      float myTextR;

      float myTextG;

      float myTextB;

      float myTextA;

      bool myEnabled;

      bool myInstanceEnabled;

      float myBorderWidth;

      bool myShowBorder;

      bool myShadowText;

      unsigned int myHoverGroupId;

      unsigned int myHoverTextGroupId;
      
      unsigned int mySelectedGroupId;

      unsigned int mySelectedTextGroupId;

      unsigned int mySymbolDecorationGroupId;

      unsigned int mySymbolDecorationTextGroupId;

      bool myColorByForce;

      bool myUseHighestTerrainLod;

      bool myHorizontalCenter;

      bool myVerticalCenter;

      bool myPinnedFlag;

      bool myApplyLodOutAltitudeToHeadingIndicatorEnabled;

      double myLodOutAltitude;

      bool myLodOutAltitudeOverridden;

      int myLineIndicatorWidth;

      bool myHeadingLineIndicatorColorOverridden;
      DtVector4<float> myHeadingLineIndicatorColor;

      bool myVelocityLineIndicatorColorOverridden;
      DtVector4<float> myVelocityLineIndicatorColor;

      bool myFixedScalingEnabled;

      bool myIndicatorOffsetSet;

      bool myHasMouseCursor;

      double myVelocityBasedScaleComputationFactor;
      double myVelocityIndicatorMinimumSpeed;

      makArchives::DtAltitudeBasedScaleConfigurationRecordCollection myHeadingIndicatorScalesByMinimumAltitude;
      DtObjectTypeStateListener* myObjectTypeStateListener;
   };

}