DtHATLineVisualizer.h

Go to the documentation of this file.

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


#pragma once

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

#include <makArchives/DtAltitudeBasedScaleConfigurationRecord.h>

namespace makVrv
{

   class Dt3DSegmentedLineModelAgent;
   class DtWidgetLabelAgent;
   class DtSceneObjectAgent;
   class DtAttachableHatUpdaterAgent;
   class DtProjectedWidgetModelAgent;
   class DtAttachableHatTextUpdaterAgent;
   class DtObjectTypeStateListener;

   class DT_DLL_VRVCORE DtHATLineVisualizer : public DtStateVisualizer
   {
   public:
      DtHATLineVisualizer( DtBaseConnection& simulation, DtStateListener& listener, 
         DtSceneObjectAgent* sceneObject, DtModelSetId modelSet );

      virtual ~DtHATLineVisualizer();

      DtHATLineVisualizer() = delete;

      DtHATLineVisualizer(const DtHATLineVisualizer&) = delete;

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

   public:

      virtual void initialize() override;

      virtual void setVisualDefinitionEnabled( bool );

      // Set / Get the text color.  Can use 0.0-1.0 or 0-255
      virtual void setTextColor(float r, float g, float b, float a);
      virtual void getTextColor(float& r, float& g, float& b, float& a) const;

      // Set / Get the size of the box the text is positioned in, in pixels.
      virtual void setTextBoxSize( unsigned int textWidth, unsigned int textHeight );
      virtual void getTextBoxSize( unsigned int& textWidth, unsigned int& textHeight ) const;

      // Set / Get a pixel offset from the top of the line for the text box.
      virtual void setOriginOffset( int offsetX, int offsetY );
      virtual void getOriginOffset( int& offsetX, int& offsetY ) const;


      // Set / Get the horizontal alignment of the text within the text box. 
      // Values come from DtWidgetLabel
      virtual void setHorizontalAlignment (DtWidgetLabel::TextHorizontalAlignmentPolicy horizontalAlignment );
      virtual DtWidgetLabel::TextHorizontalAlignmentPolicy horizontalAlignment() const;

      // Set / Get the name of the font to use for the height text.
      virtual void setTextFont( const std::string& textFont) ;
      virtual std::string textFont() const;
      
      // Set / Get the point size of the font used for height text
      virtual void setTextFontSize( unsigned int textFontSize );
      virtual unsigned int textFontSize() const;
      
      // Set / Get the scale to apply to the font point size for height text.
      // This is only used if setIsAltitudeBasedScalingEnabled(false).
      virtual void setTextFontScale( float textFontScale );
      virtual float textFontScale() const;

      virtual void setHatLinePeriod( unsigned int frames );
      virtual unsigned int hatLinePeriod() const;

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

      virtual void setLodOutAltitude(double lodOutAltitude);
      virtual double lodOutAltitude() const;

      virtual void setIsPinned(bool myPinned);

      virtual void setIsAltitudeBasedScalingEnabled(bool isAltitudeBasedScalingEnabled);

      // This is only used if setIsAltitudeBasedScalingEnabled(true).
      virtual void setAltitudeBasedConfigurations(
         const makArchives::DtAltitudeBasedScaleConfigurationRecordCollection& collection);

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

      virtual void slot_setSelected(bool b) override;
   protected:

      virtual DtObjectTypeStateListener& objectTypeStateListener();

      virtual void createModelAgents() override;

      virtual void destroyModelAgents() override;

      virtual void updateAltitudeBasedScalingProperties();

      virtual void updateForcedAltitudeBasedConfigurationEnabledState();

      virtual void updateLodOutAltitudeProperties();
      
      virtual void updateIsLodOutAltitudeEnabledState();

      virtual void setModelDefinitionForAgents() override;

      virtual void connectToListenerSignals() override;

      virtual void setInitialValuesFromVisualizerDefinition() override;

      virtual void slot_displayUnitCollectionChanged();
   protected:
      DtObjectTypeStateListener* myObjectTypeStateListener;
      Dt3DSegmentedLineModelAgent* myHatLineAgent;
      DtSceneObjectAgent* myHatLineObjectAgent;
      DtAttachableHatUpdaterAgent* myHatLineUpdaterAgent;

      DtSceneObjectAgent* myHatTextObjectAgent;
      DtProjectedWidgetModelAgent* myHatTextModelAgent;
      DtWidgetLabelAgent* myHatTextWidgetAgent;
      DtAttachableHatTextUpdaterAgent* myHatTextUpdaterAgent;

      bool myHasMouseCursor;

      bool myPinnedFlag;

      bool myLODOutAltitudeEnabled;

      double myLodOutAltitude;

      bool myLodOutAltitudeOverridden;

      bool myIsAltitudeBasedScalingEnabled;

      float myTextFontScale;

      makArchives::DtAltitudeBasedScaleConfigurationRecordCollection myTextFontScalesByMinimumAltitude;

      // bool myHatLineEnabled;
      bool myVisualDefinitionEnabled;
      bool myUseHighestTerrainLod;
      double myTextPosition; // proportion, 0. to 1., 0. at top
      unsigned int myTextBoxSize[2]; // default is 150 x 25 pixels
      DtWidgetLabel::TextHorizontalAlignmentPolicy myTextHorizontalAlignment; // default is center
      std::string myTextFont; // default is "FreeMono.otf"
      std::string myDisplayUnitCollectionName;
      unsigned int myTextFontSize; // default is 14
      float myTextColor[4]; // default is 1., 1., 0., 1.
      int myOriginOffset[2]; // default is 0, -30
      unsigned int myHatLinePeriod;
      
   };

}