DtChannelKeywordGridLines.h

Go to the documentation of this file.

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


#pragma once

#include <vrvCore/vrvCore.h>

#include <makArchives/DtGridLinesSettingsRecord.h>

#include <vrvUtil/DtSignalConnectionManager.h>

#include <vrvCore/DtChannelKeywordObject.h>

#include <string>

namespace makVrv
{

   class DtDe;
   class DtChannelConfiguration;
   class DtWindowConfiguration;
   class DtChannelGridLinesAgent;
   class DtObserver;
   class DtInputDriver;

   class DT_DLL_VRVCORE DtChannelKeywordGridLines : public DtChannelKeywordObject
   {
   public:

      friend class DtChannelKeywordGridLinesCreator;

      virtual ~DtChannelKeywordGridLines();
   
      virtual void channelNameChanged( const std::string& displayName, 
         const std::string& windowName,  const std::string& channelName );

      virtual void channelConfigurationChanged( 
         const DtChannelConfiguration& config );

      virtual void windowConfigurationChanged( 
         const DtWindowConfiguration& config ) {}

   protected:
        
      // Slots for responding to observer-related signals

      virtual void slot_observerCreated( DtInputDriver* inputDriver, DtObserver* observer );
      
      virtual void slot_observerToBeDestroyed( DtInputDriver* inputDriver, DtObserver* observer );
      
      virtual void slot_observerModeChanged( DtObserver* observer, int newMode );

      virtual void slot_observerModeSettingChanged( int mode, int setting );

      virtual void slot_observerModeIs2DChanged( int mode );

      virtual void slot_coordinateSystemChanged( const std::string&, const std::string& );

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

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

      virtual void slot_minimalGridlineLabelsEnabled( bool isMinimalEnabled );

      virtual void slot_autoSpacingSet( bool isAutoSpacingSet );

      virtual void slot_fixedSpacingAmountSet( makArchives::DtDisplayUnitsSettingsRecord::DistanceUnits unit, double fixedSpacingAmount );

      virtual void slot_fixedAngularSpacingAmountSet( makArchives::DtDisplayUnitsSettingsRecord::OrientationUnits unit, double fixedAngularSpacingAmount );

      virtual void slot_gridTypeSet( makArchives::DtDisplayUnitsSettingsRecord::CoordSys cs );

      virtual void slot_unitTypeSet( makArchives::DtDisplayUnitsSettingsRecord::DistanceUnits unit );

      virtual void slot_angularUnitTypeSet( makArchives::DtDisplayUnitsSettingsRecord::OrientationUnits unit );

      virtual void slot_minSpacingSet( int minSpacing );

      virtual void slot_xOffsetSet( makArchives::DtDisplayUnitsSettingsRecord::DistanceUnits unit, double xOffset);

      virtual void slot_yOffsetSet( makArchives::DtDisplayUnitsSettingsRecord::DistanceUnits unit, double yOffset );

      virtual void slot_longitudeOffsetSet(makArchives::DtDisplayUnitsSettingsRecord::OrientationUnits unit, double lonOffset );

      virtual void slot_latitudeOffsetSet( makArchives::DtDisplayUnitsSettingsRecord::OrientationUnits unit, double latOffset );

      virtual void slot_decimalPlacesSet( makArchives::DtDisplayUnitsSettingsRecord::CoordSys cs, makArchives::DtDisplayUnitsSettingsRecord::DistanceUnits unit, unsigned int decimals );

      virtual void slot_angularDecimalPlacesSet( makArchives::DtDisplayUnitsSettingsRecord::CoordSys cs, makArchives::DtDisplayUnitsSettingsRecord::OrientationUnits unit, unsigned int decimals );

      virtual void slot_latLonLabelsCenteringCutoffSet(double altitude);

      virtual void slot_mgrsMapSheetCutoffSet(double altitude);

      virtual void slot_garsPolarLatitudeCutoffSet(double latitude);

      virtual void slot_garsFixedSpacingSet(double degrees);

      virtual void slot_mgrsMapSheetFixedSpacingSet(double meters);

      // Helper methods

      // Set myObserver to the specified observer and connect to the observerModeChanged
      // signal
      virtual void connectToObserver( DtObserver* observer );

      // Look up the observer by name, cache the observer name, and call connectToObserver
      // with the found observer
      virtual void connectToObserver( const std::string& observerName );

      // Disconnect from the current observer's observerModeChanged signal, delete the
      // the grid line agent if it exists, and set myObserver and myGridLineAgent
      // to Null
      virtual void disconnectFromObserver();

      // This function looks up the display grid lines observer setting value and creates 
      // or destroys a grid line object as needed
      virtual void updateGridLinesState();

      virtual bool validateGridType();

      virtual bool validateUnitType();

   protected:

      DtChannelKeywordGridLines( DtDe& de, const std::string& keyword,
         const std::string& displayName, const std::string& windowName,
         const DtChannelConfiguration& channelConfig );

      makArchives::DtDisplayUnitsSettingsRecord::CoordSys defaultForCoordSys( 
         const std::string& type );

      // Returns true if we are currently using this unit type
      bool currentUnits( makArchives::DtDisplayUnitsSettingsRecord::DistanceUnits unit ) const;
      bool currentUnits( makArchives::DtDisplayUnitsSettingsRecord::OrientationUnits unit ) const;

   protected:

      DtChannelGridLinesAgent* myGridLinesAgent;
      std::string myObserverName;
      DtObserver* myObserver;
      std::string myKeyword;
      std::string myDisplayName;
      std::string myWindowName;
      std::string myChannelName;
      DtSignalConnectionManager myConnections;
      makArchives::DtDisplayUnitsSettingsRecord::CoordSys myGridType;
   };

   class DT_DLL_VRVCORE DtChannelKeywordGridLinesCreator
      : public DtChannelKeywordObjectCreator
   {
   public:

      DtChannelKeywordGridLinesCreator();

      virtual ~DtChannelKeywordGridLinesCreator();

      virtual DtChannelKeywordObject* createChannelKeywordObject(DtDe& de,
         const std::string& displayName, const std::string& windowName,
         const DtChannelConfiguration& channelConfig );

   public:

      static std::string keyword();

   protected:

      std::string myKeyword;

   };

}