DtOsgChannelCompassInstance.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/DtChannelCompassInstance.h>
#include <vrvUtil/DtSignalConnectionManager.h>
#include <osg/Vec2>
#include <osg/ref_ptr>
#include <memory>

namespace makVrv 
{
   class DtDe;
   class DtChannel;
   class DtChannelConfiguration;
   class DtChannelManager;
   class DtOsgChannel;
   class DtOverlayRendererInterface;
   class DtQuadProxyInterface;
   class DtWindowConfiguration;
   class DtLineSegment;
   class DtCoordinateSystem;
   class DtOsgTextureWrapper;

   class DT_DLL_VRVOSG DtOsgChannelCompassInstance : public DtChannelCompassInstance
   {
   public:

      DtOsgChannelCompassInstance(DtDe& de);

      virtual ~DtOsgChannelCompassInstance();

      DtOsgChannelCompassInstance() = delete;

      DtOsgChannelCompassInstance(const DtOsgChannelCompassInstance &other) = delete;

      DtOsgChannelCompassInstance &operator=(const DtOsgChannelCompassInstance &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);

      void updateLetter( bool &dirtyFlag, const std::string& filename, 
         int tickIndex, DtQuadProxyInterface* letterQuad,
         DtOsgTextureWrapper* letterTexture, bool& force );

      virtual void setNorthLetterFilename( const std::string& filename );
      
      virtual void setSouthLetterFilename( const std::string& filename );
      
      virtual void setEastLetterFilename( const std::string& filename );
      
      virtual void setWestLetterFilename( const std::string& filename );
 
      virtual void setStarFilename(const std::string& filename);

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

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

      virtual void setPixelRatio(float pixelRatio);
       
   protected:

      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_coordinateSystemChanged();
         
      // Create the compass frame
      void createCompass();
      
      // delete / clear the DtQuad and DtFilledPolygons, if they exist
      void destroyCompass();

      // Creates the compass texture objects.
      virtual void createTextures(DtDe& de);

      // Deletes the compass texture objects.
      virtual void destroyTextures();

      // Calculates a frame position based on Location enum, margins,  current window size
      // and channel parameters
      osg::Vec2 calcCenterPosition();
     
      void slot_update();
      
      DtLineSegment* createDarkSide( DtOverlayRendererInterface& overlay );
      DtLineSegment* createLightSide( DtOverlayRendererInterface& overlay );
         
      // This type can be used to provide a list of vertices to the polygon objects
      typedef std::vector<float> VertexList;
      
      static void rotate(const DtOsgChannelCompassInstance::VertexList& in, 
         double rad, DtOsgChannelCompassInstance::VertexList& out );

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

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

         DtLineSegment* lightSide;
         DtLineSegment* darkSide;
      };

      DtSignalConnectionManager myConnections;
      DtSignalConnectionManager myPixelRatioConnection;

      DtOsgChannel* myChannel;

      std::unique_ptr<DtOsgTextureWrapper> myNorthTexture;
      std::unique_ptr<DtOsgTextureWrapper> mySouthTexture;
      std::unique_ptr<DtOsgTextureWrapper> myEastTexture;
      std::unique_ptr<DtOsgTextureWrapper> myWestTexture;
      std::unique_ptr<DtOsgTextureWrapper> myStarTexture;

      DtQuadProxyInterface* myNorthLetter;
      DtQuadProxyInterface* mySouthLetter;
      DtQuadProxyInterface* myEastLetter;
      DtQuadProxyInterface* myWestLetter;
      DtQuadProxyInterface* myStarQuad;
      osg::Vec2 myCenterPosition;
      
      // Set to true at beginning and whenever the letter filename changes
      bool myNorthLetterDirty;
      bool mySouthLetterDirty;
      bool myEastLetterDirty;
      bool myWestLetterDirty;
      bool myStarDirty;
      
      // NW, NE, SW, SE +, if missing, E, S, and W
      TickMark myLargeTickMarks[7];
      
      // Every 15 degrees, skipping the 4 letters and 4 large tick marks
      TickMark mySmallTickMarks[16];

      float myPixelRatio;

      TickMark myTrueNorthMark;
      TickMark myMagneticNorthMark;
      TickMark myDaggerMark;

      DtCoordinateSystem* myCoordinateSystem = nullptr;
   }; 
}