include/vrvUtil/DtCoordinateDisplay.h

Go to the documentation of this file.

/*********************************************************************
 * Copyright (c) 2011 MaK Technologies, Inc.
 * All rights reserved.
 ********************************************************************/
/*********************************************************************
 * $RCSfile: DtCoordinateDisplay.h,v $ $Revision: 1.8 $ $State: Exp $
 ********************************************************************/


#pragma once
#include <vrvUtil/vrvUtil.h>
#include <vrvUtil/DtUnicode.h>
#include <makArchives/DtDisplayUnitsSettingsRecord.h>

class DtVector;
class DtTaitBryan;

namespace makVrv
{
   class DtCoordinateSystem;

   class DT_DLL_VRVUTIL DtCoordinateDisplay
   {
   public:

      typedef makArchives::DtDisplayUnitsSettingsRecord::CoordSys CoordSys;
      typedef makArchives::DtDisplayUnitsSettingsRecord::DistanceUnits DistanceUnits;
      typedef makArchives::DtDisplayUnitsSettingsRecord::VelocityUnits VelocityUnits;
      typedef makArchives::DtDisplayUnitsSettingsRecord::AccelerationUnits AccelerationUnits;
      typedef makArchives::DtDisplayUnitsSettingsRecord::OrientationUnits OrientationUnits;
      typedef makArchives::DtDisplayUnitsSettingsRecord::RotVelocityUnits RotVelocityUnits;
      typedef std::list<DistanceUnits> SupportedPositionDistanceUnits;
      typedef std::list<OrientationUnits> SupportedPositionAngularUnits;
      typedef std::list<std::string> SupportedCSForGridLines;


      DtCoordinateDisplay( const DtCoordinateSystem& coordSys );

      virtual ~DtCoordinateDisplay();

      virtual DtCoordinateDisplay* clone() const = 0;

      virtual DtUnicode name() = 0;

      virtual DtUnicode gridBoxLabel(const DtVector& lowerLeftGeocPos,
         const DtVector& upperRightGeocPos );
      
      // Deriving systems need to override one or the other of these,
      // depending on which type of position units they use.  GridSpacing
      // is provided for autoPrecision implementations

      virtual DtUnicode northSouthGridLabel( DistanceUnits unit,
         const DtVector& geocPos, int decimals, double gridSpacing );
      
      virtual DtUnicode northSouthGridLabel( OrientationUnits unit,
         const DtVector& geocPos, int decimals, double gridSpacing );

      virtual DtUnicode eastWestGridLabel( DistanceUnits unit,
         const DtVector& geocPos, int decimals, double gridSpacing );
      
      virtual DtUnicode eastWestGridLabel( OrientationUnits unit,
         const DtVector& geocPos, int decimals, double gridSpacing );

      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 );

      virtual void shiftGridLineAnchors( double xSpacing, double ySpacing, 
         double& shiftX, double& shifY );

      virtual bool usesDecimalsOnGridLines() const;

      virtual double maxGridSpacing() const;

      virtual double minGridSpacing() const;

      virtual DistanceUnits xUnitsFor( DistanceUnits unit ) = 0;

      virtual DistanceUnits yUnitsFor( DistanceUnits unit ) = 0;

      virtual DistanceUnits zUnitsFor( DistanceUnits unit ) = 0;

      virtual DtUnicode xAxisLabel() = 0;
      virtual DtUnicode yAxisLabel() = 0;
      virtual DtUnicode zAxisLabel() = 0;

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

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

      virtual DtVector convertFromGeocentric( const DtVector& vector ) const = 0;

      virtual DtTaitBryan headingPitchRollFor( const DtVector& geocPos,
         const DtTaitBryan& geocOri ) const = 0;

      virtual DtTaitBryan localOrientationFor( const DtVector& location,
         const DtTaitBryan& geocOri ) const = 0;

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

      virtual DtTaitBryan topoOrientationFor( const DtVector& geocPos, 
         const DtTaitBryan& geocOri ) const;

      virtual DtVector geocToLocalVector(const DtVector& geocLoc, 
         const DtVector& geocVec ) const;

      const SupportedPositionDistanceUnits& supportedPositionDistanceUnits() const;

      bool isSupportedPositionUnit( DistanceUnits unit) const;

      void addSupportedPositionUnit( DistanceUnits unitToSupport );

      void removeSupportedPositionUnit( DistanceUnits unitToRemove );

      const SupportedPositionAngularUnits& supportedPositionAngularUnits() const;

      bool isSupportedPositionUnit( OrientationUnits unit) const;

      void addSupportedPositionUnit( OrientationUnits unitToSupport );

      void removeSupportedPositionUnit( OrientationUnits unitToRemove );
      
      const SupportedCSForGridLines& supportedCSForGridLines() const;

      bool isSupportedCSForGridLines( const std::string& cs ) const;

      void addSupportedCSForGridLines( const std::string& cs );

      void removeSupportedCSForGridLines( const std::string& cs );

   protected:

      const DtCoordinateSystem& myCoordinateSystem;
      SupportedPositionDistanceUnits mySupportedPositionDistanceUnits;
      SupportedPositionAngularUnits mySupportedPositionAngularUnits;
      SupportedCSForGridLines mySupportedCSForGridLines;

   };

}