DtOsgChannel3dViewCompassInstance.h

Go to the documentation of this file.

/****************************************************************************** 
** Copyright (c) 2021 MAK Technologies, Inc. 
** All rights reserved. 
******************************************************************************/ 
 
 
#pragma once
 
#include <vrvOsg/vrvOsg.h>
#include <vrvCore/DtChannel3dViewCompassInstance.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 DtQuad;
   class DtWindowConfiguration;
   class DtLineSegment;

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

      // \brief A stucture to define a set of characters and tickmark associated
      // with a direction on the compass.
      struct CompassSymbol
      {
         CompassSymbol()
            : numCharacters(0)
            , lightSide(0)
            , darkSide(0)
         {
            for (int i = 0; i < 3; ++i)
            {
               characterValue[i] = 0;
               characters[i] = 0;
            }
         }

         int numCharacters; // number of active characters (generally 1, 2, or 3)
         unsigned char characterValue[3];
         DtQuad* characters[3];
         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_update();

      bool updateCompassCharacter(const std::string& filename,
         DtQuad* quad, osg::ref_ptr<osg::Texture>& texture,
         const osg::Vec4& texCoords);

      // \brief Parse settings specific to the compass.
      virtual void parseModelDefinition(DtModelDefinition* definition);
         
      // \brief Create the compass resources
      virtual void createCompass();
      
      // \brief delete / clear the DtQuad and DtFilledPolygons, if they exist
      void destroyCompass();
      
      // \brief Calculates the compass center position based on Location enum, margins, current window size
      // and channel parameters
      osg::Vec2 calcCompassCenterPosition();

      DtLineSegment* createDarkSide( DtOverlayRenderer& overlay );
      DtLineSegment* createLightSide( DtOverlayRenderer& overlay );

      virtual void updateCompass();

      //  \brief Computes texture coordinates for the given character.
      virtual void computeCharacterCoords(const unsigned char value, osg::Vec4& coords);

      virtual void initCompassSymbolCharacterDisplay(CompassSymbol& symbol,
         unsigned char charA, unsigned char charB, unsigned char charC, DtOverlayRenderer& overlay);

      virtual void initPopoutSymbolCharacterDisplay(CompassSymbol& symbol,
         unsigned char charA, unsigned char charB, unsigned char charC, DtOverlayRenderer& overlay);

      virtual bool initCompassSymbolCharacters(CompassSymbol& symbol);

      // This type can be used to provide a list of vertices to the polygon objects
      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;
      };

      DtDe& myDe;
      DtSignalConnectionManager myConnections;
      DtSignalConnectionManager myPixelRatioConnection;

      DtOsgChannel* myChannel;

      bool myCompassIsMagnetic;

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

      osg::ref_ptr<osg::Texture> myCompassSymbolsTexture;
      osg::Vec2 myCompassCenterPosition;
      CompassSymbol myCompassSymbols[24];
      CompassSymbol myPopoutSymbol;
      TickMark myPopoutL;
      TickMark myPopoutR;
      bool myCompassDirty;
   }; 
}