DtGridLinesLogic.h

Go to the documentation of this file.

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


#pragma once

#include <vrvCoreQt/vrvCoreQt.h>

#include <vrvCoreQt/DtGridLinesInterface.h>

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

#include <makArchives/DtGridLinesSettingsRecord.h>

namespace makVrv
{

   class DtSettingsBackup;
   class DtPersistenceControlsInterface;
   class DtCoordinateDisplay;

   class DT_DLL_VRVCOREQT DtGridLinesLogic : public DtVirtualBaseClass
   {
   public:

      friend class DtGridLinesLogicCreator;

      virtual ~DtGridLinesLogic();

      virtual void sendSettingsToGui();

      virtual void slot_northSouthColorChanged( double r, double g, double b, double a );
      virtual void slot_eastWestColorChanged( double r, double g, double b, double a );
      virtual void slot_onMinimalGridlineLabelsToggled( bool isMinimalEnabled );
      virtual void slot_onAutoSpacingChanged( bool isAutoSpacingEnabled );
      virtual void slot_onFixedSpacingAmountChanged(double fixedSpacingAmount);
      virtual void slot_onGarsFixedSpacingIndexChanged(int index);
      virtual void slot_onMgrsMapSheetFixedSpacingIndexChanged(int index);
      virtual void slot_onMinSpacingChanged( int minSpacingAmount );
      virtual void slot_onGridTypeChanged( makArchives::DtDisplayUnitsSettingsRecord::CoordSys cs );
      virtual void slot_onUnitTypeChanged( makArchives::DtDisplayUnitsSettingsRecord::DistanceUnits unit );
      virtual void slot_onAngularUnitTypeChanged( makArchives::DtDisplayUnitsSettingsRecord::OrientationUnits unit );
      virtual void slot_onXOffsetChanged( double xOffset );
      virtual void slot_onYOffsetChanged( double yOffset );
      virtual void slot_onDecimalsChanged( unsigned int decimals );
      virtual void slot_onlatLonLabelsCenteringCutoffChanged(double latitude);
      virtual void slot_onPolarLatitudeCutoffChanged(double altitude);
      virtual void slot_onMgrsMapSheetCutoffChanged(double altitude);
      virtual void slot_onGridOnToolbarChanged(bool onOrOff);

      virtual void on_import();
      virtual void on_export();
      virtual void on_importFilePathChosen(const std::string& filePath);
      virtual void on_exportFilePathChosen(const std::string& filePath);
      virtual void settingsRestored(const DtSettingsBackup* b);

   protected:

      DtGridLinesLogic(DtDe& de, DtPersistenceControlsInterface& persistenceControls,
         DtGridLinesInterface& iface);

      // Used by sendSettingsToGui to send all the known grid types to the gui
      virtual void sendGridTypesToGui();

      // Used by sendSettingsToGui to send all the known unit types to the gui
      virtual void sendUnitTypesToGui();

      // Determine if the specified grid type uses angular units (or linear, otherwise)
      bool gridTypeUsesAngularUnits( makArchives::DtDisplayUnitsSettingsRecord::CoordSys gridType ) const;

      virtual void processCurrentCoordinateSystem();

      virtual void processCurrentGridType();

      virtual double fixedSpacingAmount();

      // find the correct combo box index to display the current gars fixed spacing
      virtual int garsFixedSpacingIndex() const;

      // find the correct combo box index to display the current mgrs fixed spacing
      virtual int mgrsMapSheetFixedSpacingIndex() const;

      virtual double xOffset();

      virtual double yOffset();

      virtual unsigned decimals();

      virtual void setMinAndMaxFixedSpacing( const DtCoordinateDisplay* display );

   protected:

      DtDe& myDe;
      DtGridLinesInterface& myWidget;
      DtPersistenceControlsInterface& myPersistenceControls;
      DtSignalConnectionManager mySignals;
      bool myTerrainIsLoaded;

      class DtFixedSpacingEntry
      {
      public:
         double myValue;
         std::string myLabel;
      };

      std::vector<DtFixedSpacingEntry> myGarsFixedSpacingElements;
      std::vector<DtFixedSpacingEntry> myMgrsMapSheetFixedSpacingElements;

   };

   class DT_DLL_VRVCOREQT DtGridLinesLogicCreator
      : public DtVirtualBaseClass
   {
   public:

      // Get the creator instance for this DE object.  Creates instance if none found
      static DtGridLinesLogicCreator& instance( DtDe& de );

      static void registerInstance( DtDe& de, DtGridLinesLogicCreator* creator );

      //Create the widget's logic.
      static DtVirtualBaseClass* create( DtDe& de,
         DtPersistenceControlsInterface& persistenceControls, DtGridLinesInterface& iface ) ;

   };

}