DtOsgChannel3dViewCompassInstance.h

Go to the documentation of this file.

/****************************************************************************** 
** Copyright (c) 2024 MAK Technologies, Inc. 
** All rights reserved. 
******************************************************************************/ 
 
 
#pragma once
 
#include <vrvOsg/vrvOsg.h>
#include <vrvCore/DtChannel3dViewCompassInstance.h>
#include <vrvCore/DtSharedDisplayUnitsSettings.h>
#include <vrvUtil/DtSignalConnectionManager.h>
#include <osg/Vec2>
#include <osg/Vec4>
#include <osg/ref_ptr>

namespace osg
{
   class Texture;
}

namespace makVrv 
{
   class DtDe;
   class DtChannel;
   class DtChannelConfiguration;
   class DtChannelManager;
   class DtModelDefinition;
   class DtOsgChannel;
   class DtOverlayRenderer;
   class DtQuadProxy;
   class DtWindowConfiguration;
   class DtLineSegment;
   class DtCoordinateSystem;
   class DtOsgTextureWrapper;

   class DT_DLL_VRVOSG DtOsgChannel3dViewCompassInstance :
      public DtChannel3dViewCompassInstance
   {
   public:

      DtOsgChannel3dViewCompassInstance(DtDe& de);

      virtual ~DtOsgChannel3dViewCompassInstance();

      DtOsgChannel3dViewCompassInstance() = delete;

      DtOsgChannel3dViewCompassInstance(
         const DtOsgChannel3dViewCompassInstance &other) = delete;

      DtOsgChannel3dViewCompassInstance &operator=(
         const DtOsgChannel3dViewCompassInstance &other) = delete;
   
      virtual void setVisible(bool isVisible);

      virtual bool visible();

      virtual void setChannelName(const std::string& deName, 
         const std::string& winName, const std::string& channelName);
      
      virtual void setModelDefinition(const std::string& modelDefinition);
      
      virtual void updateCompass( bool force);

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

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

      virtual void setSymbolsFilename(const std::string& filename);

      virtual void setPixelRatio(float pixelRatio);

      // to override the pixel ratio
      virtual float getPixelRatio();
       
   protected:

      struct CompassSymbol
      {
         CompassSymbol()
            : numCharacters(0)
            , lightSide(0)
            , darkSide(0)
         {
            for (int i = 0; i < 4; ++i)
            {
               characterValue[i] = 0;
               characters[i] = 0;
            }
         }

         int numCharacters; 
         unsigned char characterValue[4];
         DtQuadProxy* characters[4];
         DtLineSegment* lightSide;
         DtLineSegment* darkSide;
      };

      virtual void slot_channelCreated(DtChannelManager*, DtChannel*);
      
      virtual void slot_channelToBeDestroyed(DtChannelManager*, DtChannel*);
  
      virtual void slot_channelConfigurationModified(const std::string& deName, 
         const std::string& winName, const std::string& oldChannelName, 
         const DtChannelConfiguration& config);
    
      virtual void slot_windowConfigurationModified( const std::string& deName, 
         const std::string& winName, const DtWindowConfiguration& config );

      virtual void slot_displayUnitUnitChanged(
         const DtUnicode& displayUnitCollectionName,
         const DtUnicode& displayUnitName, unsigned int newUnit,
         unsigned int oldUnit);

      virtual void slot_update();

      virtual void slot_coordinateSystemChanged();

      bool updateCompassCharacter(const std::string& filename,
         DtQuadProxy* quad, DtOsgTextureWrapper* texture,
         const osg::Vec4& texCoords);

      virtual void parseModelDefinition(const DtModelDefinition* definition);
         
      virtual void createCompass();
      
      void destroyCompass();
      
      osg::Vec2 calcCompassCenterPosition();

      DtLineSegment* createDarkSide(DtOverlayRenderer& overlay);

      DtLineSegment* createLightSide(DtOverlayRenderer& overlay);

      virtual bool updateOrientationUnits();

      virtual void updateCompass();

      virtual void computeCenteringOffsets(float* offsets,
         const int numCharacters, const float characterWidth);

      virtual void computeHeadingString(const float radHeading,
         std::string& outString);

      virtual void computeCharacterCoords(const unsigned char value,
         osg::Vec4& coords);

      virtual void initCompassSymbolCharacterDisplay(CompassSymbol& symbol,
         const std::string& text, DtOverlayRenderer& overlay);

      virtual void initPopoutSymbolCharacterDisplay(CompassSymbol& symbol,
         DtOverlayRenderer& overlay);

      virtual bool initCompassSymbolCharacters(CompassSymbol& symbol);

      typedef std::vector<float> VertexList;
      
      static void rotate(const DtOsgChannel3dViewCompassInstance::VertexList& in, 
         double rad, DtOsgChannel3dViewCompassInstance::VertexList& out);

      static void translate(
         const DtOsgChannel3dViewCompassInstance::VertexList& in, 
         const osg::Vec2& translation,
         DtOsgChannel3dViewCompassInstance::VertexList& out);

      static void scale(const DtOsgChannel3dViewCompassInstance::VertexList& in,
         double s, DtOsgChannel3dViewCompassInstance::VertexList& out);
      
   protected:
   
      struct TickMark
      {
         TickMark()
            : lightSide(0)
            , darkSide(0)
         {
            // intentional noop
         }

         DtLineSegment* lightSide;
         DtLineSegment* darkSide;
      };

      DtSignalConnectionManager myConnections;
      DtSignalConnectionManager myPixelRatioConnection;

      DtOsgChannel* myChannel;

      bool myCompassIsMagnetic;

      bool myIsExactHeadingAlwaysShown;

      int myCreateState; // 0 = need create, 1 = created, -1 = creation error
      
      float myPixelRatio;

      DtOsgTextureWrapper* myCompassSymbolsTexture;
      osg::Vec2 myCompassCenterPosition;
      CompassSymbol myCompassSymbols[24];
      CompassSymbol myPopoutSymbol;
      TickMark myPopoutL;
      TickMark myPopoutR;
      bool myCompassDirty;

      DtSharedDisplayUnitsSettings::OrientationUnits myOrientationUnit;

      DtCoordinateSystem* myCoordinateSystem = nullptr;
   }; 
}