include/vrvCore/DtSharedDisplayUnitsSettings.h

Go to the documentation of this file.

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


#pragma once

#include <vrvCore/vrvCore.h>

#include <vrvCore/DtSharedSettings.h>
#include <vrvCore/DtRecordSettingsBackup.h>

#include <makArchives/DtDisplayUnitsSettingsRecord.h>

#include <vrvUtil/DtUnitConverterCollection.h>
#include <vrvUtil/DtUnicode.h>

#include <boost/unordered_map.hpp>

#include <vector>

namespace makVrv
{

   class DtCoordinateSystem;
   class DtSharedDisplayUnitsSettings;

   typedef DtSharedRecordSettingsBackup<DtSharedDisplayUnitsSettings,
      makArchives::DtDisplayUnitsSettingsRecord> DtDisplayUnitsSettingsBackup;

   class DT_DLL_VRVCORE DtSharedDisplayUnitsSettings : public DtSharedSettings
   {
   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;

      struct UnitEntry
      {
         DtUnicode myUnitname;
         DtUnicode myNotation;
         int myDecimals;

         UnitEntry( DtUnicode name, DtUnicode notation, int decimals )
         {
            myUnitname = name;
            myNotation = notation;
            myDecimals = decimals;
         }
      };

      struct DisplayAttributes
      {
         std::vector<UnitEntry> myUnits;
         int myCurrentIndex;

         DisplayAttributes()
            : myCurrentIndex( 0 )
         {
         }

         std::string currentDisplayUnitNotation() const
         {
            std::string str;
            myUnits[myCurrentIndex].myNotation.toUtf8(str);
            return str;
         }
      };

      typedef boost::unordered_map<CoordSys, int> CoordSysDecimalsMap;
      typedef boost::unordered_map<CoordSys, DtUnicode> CoordSysNotationsMap;

      struct CoordinateSystemAttributes
      {
         CoordSysDecimalsMap myDecimals;
         CoordSysNotationsMap myNotations;
         CoordSys myCurrentIndex;
         CoordinateSystemAttributes()
         : myCurrentIndex( makArchives::DtDisplayUnitsSettingsRecord::CoordSysDatabase )
         {
         }
      };

      virtual ~DtSharedDisplayUnitsSettings();


      void setDisplayUnitAttributes( DtUnitConverterCollection::DisplayUnitType attr, 
         const DisplayAttributes& data );

      bool getDisplayUnitAttributes(
         DtUnitConverterCollection::DisplayUnitType attr,
         DisplayAttributes& value ) const;

      DisplayAttributes* findDisplayUnitAttributes( 
         DtUnitConverterCollection::DisplayUnitType attr );

      const DisplayAttributes* findDisplayUnitAttributes( 
         DtUnitConverterCollection::DisplayUnitType attr ) const;

      void setCoordinateSystemAttributes( const CoordinateSystemAttributes& data );

      CoordinateSystemAttributes* coordSysAttributes();

      const CoordinateSystemAttributes* coordinateSystemAttributes() const;

      void getCoordinateSystemAttributes( CoordinateSystemAttributes& csAttr ) const;


      void setCoordinateSystem( CoordSys cs );
      void setDistanceUnits( DistanceUnits distUnits );
      void setAltitudeUnits( DistanceUnits altUnits );
      void setVelocityUnits( VelocityUnits velocityUnits );
      void setOrientationUnits( OrientationUnits oriUnits );
      void setAccelerationUnits( AccelerationUnits accelUnits );
      void setRotationalVelocityUnits( RotVelocityUnits wUnits );

      void setCoordinateSystemDecimals( CoordSys cs, int decimals );
      void setDistanceUnitDecimals( DistanceUnits distUnit, int decimals );
      void setAltitudeUnitDecimals( DistanceUnits altUnit, int decimals );
      void setVelocityUnitDecimals( VelocityUnits velocityUnit, int decimals );
      void setOrientationUnitDecimals( OrientationUnits oriUnit, int decimals );
      void setAccelerationUnitDecimals( AccelerationUnits accelUnit, int decimals );
      void setRotationalVelocityUnitDecimals( RotVelocityUnits wUnit, int decimals );



      int coordinateSystemDecimals( CoordSys cs ) const;
      int distanceUnitDecimals( DistanceUnits distUnit ) const;
      int altitudeUnitDecimals( DistanceUnits altUnit ) const;
      int velocityUnitDecimals( VelocityUnits velocityUnit ) const;
      int orientationUnitDecimals( OrientationUnits oriUnit ) const;
      int accelerationUnitDecimals( AccelerationUnits accelUnit ) const;
      int rotationalVelocityUnitDecimals( RotVelocityUnits wUnit ) const;

      DtUnicode coordinateSystemNotation( CoordSys cs ) const;
      DtUnicode distanceUnitNotation( DistanceUnits distUnit ) const;
      DtUnicode altitudeUnitNotation( DistanceUnits altUnit ) const;
      DtUnicode velocityUnitNotation( VelocityUnits velocityUnit ) const;
      DtUnicode orientationUnitNotation( OrientationUnits oriUnit ) const;
      DtUnicode accelerationUnitNotation( AccelerationUnits accelUnit ) const;
      DtUnicode rotationalVelocityUnitNotation( RotVelocityUnits wUnit ) const;



      CoordSys currentCoordinateSystem() const;
      DistanceUnits currentDistanceUnits() const;
      DistanceUnits currentAltitudeUnits() const;
      VelocityUnits currentVelocityUnits() const;
      OrientationUnits currentOrientationUnits() const;
      AccelerationUnits currentAccelerationUnits() const;
      RotVelocityUnits currentRotationalVelocityUnits() const;

      int currentCoordinateSystemDecimals() const;
      int currentDistanceUnitDecimals() const;
      int currentAltitudeUnitDecimals() const;
      int currentVelocityUnitDecimals() const;
      int currentOrientationUnitDecimals() const;
      int currentAccelerationUnitDecimals() const;
      int currentRotationalVelocityUnitDecimals() const;

      DtUnicode currentCoordinateSystemNotation() const;
      DtUnicode currentDistanceUnitNotation() const;
      DtUnicode currentAltitudeUnitNotation() const;
      DtUnicode currentVelocityUnitNotation() const;
      DtUnicode currentOrientationUnitNotation() const;
      DtUnicode currentAccelerationUnitNotation() const;
      DtUnicode currentRotationalVelocityUnitNotation() const;


      void coordinateSystemLabels( const DtCoordinateSystem& displayCS,
         DtUnicode& x, DtUnicode& y, DtUnicode& z ) const;

      void coordinateSystemLabels( const DtCoordinateSystem& displayCS,
         CoordSys coordSys,
         DtUnicode& x, DtUnicode& y, DtUnicode& z ) const;

      DtUnicode xyUnitNotation(
         const DtCoordinateSystem& displayCS ) const;

      DtUnicode xyUnitNotation( const DtCoordinateSystem& displayCS,
         CoordSys coordSys ) const;

      DtUnicode zUnitNotation(
         const DtCoordinateSystem& displayCS ) const;

      DtUnicode zUnitNotation( const DtCoordinateSystem& displayCS,
         CoordSys coordSys ) const;

      std::vector<std::string> convertPositionToStringList( 
         const DtCoordinateSystem& displayCS,
         CoordSys coordSys,
         const DtVector& pos ) const;

      std::vector<std::string> convertPositionToStringList(
         const DtCoordinateSystem& displayCS, const DtVector& pos ) const;


      void setFromRecord( const makArchives::DtDisplayUnitsSettingsRecord& rec );

      void getRecord( makArchives::DtDisplayUnitsSettingsRecord& rec ) const;

      virtual const DtDisplayUnitsSettingsBackup* settingsBackup() const;

      virtual DtDisplayUnitsSettingsBackup* settingsBackup();

      virtual void backup();


   protected:

      friend class DtReadSettingsLock<DtSharedDisplayUnitsSettings>;
      friend class DtWriteSettingsLock<DtSharedDisplayUnitsSettings>;

      DtSharedDisplayUnitsSettings( DtSharedSettingsManager& manager );

      CoordSys currentCoordSysIndex() const;

      int currentCoordSysDecimals() const;


      int currentDisplayUnitIndex( 
         DtUnitConverterCollection::DisplayUnitType attr ) const;

      int currentDisplayUnitDecimals( 
         DtUnitConverterCollection::DisplayUnitType attr ) const;

      DtUnicode currentDisplayUnitNotation( 
         DtUnitConverterCollection::DisplayUnitType attr ) const;

      DtUnicode currentDisplayUnitName( 
         DtUnitConverterCollection::DisplayUnitType attr ) const;

      void currentDisplayUnitData( 
         DtUnitConverterCollection::DisplayUnitType attr, int& index,
         DtUnicode& name, DtUnicode& notation, int& decimals ) const;


      std::string valueToText( double value, int decimals ) const;

      static std::string className();

      void initEntries();

   protected:

      typedef boost::unordered_map<DtUnitConverterCollection::DisplayUnitType,
         DisplayAttributes> EntryMap;

      EntryMap myEntries;

      CoordinateSystemAttributes myCoordSysEntries;

      DtDisplayUnitsSettingsBackup* mySettingsBackup;

   };

}