DtMgrsCoordinateDisplay.h

Go to the documentation of this file.

/********************************************************************
 * Copyright (c) 2020 MaK Technologies, Inc.
 * All rights reserved.
 ********************************************************************/


#pragma once
#include <vrvUtil/DtUtmCoordinateDisplay.h>

class DtSpheroid;

namespace makVrv
{
   class DtUtmCoordinateConverter;

   class DT_DLL_VRVUTIL DtMgrsCoordinateDisplay : public DtUtmCoordinateDisplay
   {
   public:

      DtMgrsCoordinateDisplay( const DtCoordinateSystem& cs );

      virtual ~DtMgrsCoordinateDisplay();

      DtCoordinateDisplay* clone() const;

      virtual DtUnicode name() const;

      virtual makArchives::DtDisplayUnitsSettingsRecord::DistanceUnits
         xUnitsFor( makArchives::DtDisplayUnitsSettingsRecord::DistanceUnits units ) const;

      virtual makArchives::DtDisplayUnitsSettingsRecord::DistanceUnits
         yUnitsFor( makArchives::DtDisplayUnitsSettingsRecord::DistanceUnits units ) const;

      virtual makArchives::DtDisplayUnitsSettingsRecord::DistanceUnits
         zUnitsFor( makArchives::DtDisplayUnitsSettingsRecord::DistanceUnits units ) const;

      virtual DtUnicode xAxisLabel() const;
      virtual DtUnicode yAxisLabel() const;
      virtual DtUnicode zAxisLabel() const;

      virtual DtUnicode gridBoxLabel(const DtVector& lowerLeftGeocPos,
         const DtVector& upperRightGeocPos );
  
      virtual DtUnicode northSouthGridLabel( 
         makArchives::DtDisplayUnitsSettingsRecord::DistanceUnits unit,
         const DtVector& geocPos, int decimals, double gridSpacing, bool minimal = false) override;

      virtual DtUnicode eastWestGridLabel( 
         makArchives::DtDisplayUnitsSettingsRecord::DistanceUnits unit,
         const DtVector& geocPos, int decimals, double gridSpacing, bool minimal = false) override;

      virtual bool clipXToGrid( double inStartX, double inEndX, double constantY, 
         double& clippedStartX, double& clippedEndX );

      virtual bool clipYToGrid( double inStartY, double inEndY, double constantX, 
         double& clippedStartY, double& clippedEndY );

      // Maximum grid spacing allowed. Constrain to 100,000 (one map sheet)
      virtual double maxGridSpacing() const;

      // Minimum grid spacing allowed. Constrain to 1 meter
      virtual double minGridSpacing() const;

      virtual std::vector<std::string> convertPositionToStringList(
         makArchives::DtDisplayUnitsSettingsRecord::DistanceUnits unit,
         const DtVector& geocPos, int decimals ) const override;

      virtual std::vector<DtUnicode> convertPositionToNotatedStringList(
         DistanceUnits unit, DtUnicode unitNotation, const DtVector& geocPos, int decimals, bool minimal = false) const override;

      virtual void convertToGeocentric(
         const std::string& x, const std::string& y, const std::string& z,
         makArchives::DtDisplayUnitsSettingsRecord::DistanceUnits distUnits,
         makArchives::DtDisplayUnitsSettingsRecord::DistanceUnits altUnits,
         DtVector& vector );

      virtual void regularExpressionValidator( std::string& x,
         std::string& y, std::string& z );

   protected:

      virtual void initializeMilGridEllipsoid() const;

      virtual void adjustMeridianOffsets(DtUtmCoordinateConverter* conv,
         double utmXCoord, double utmYCoord, 
         double& meridianOffsetStart, double& meridianOffsetEnd);

      virtual void adjustStartEndDeg(DtUtmCoordinateConverter* conv, 
         double constantX, double clippedStartY, double clippedEndY,
         double& startDeg, double& endDeg);

      bool isInSpecialZoneLon(DtUtmCoordinateConverter* conv, 
         double constantX, double clippedStartY, double clippedEndY);

   protected:

      static bool spheroidsEqual( const DtSpheroid& sph1, const DtSpheroid& sph2 );

   };

}