DtOverlayManager.h

Go to the documentation of this file.

/****************************************************************************** 
** Copyright (c) 2023 MAK Technologies, Inc. 
** All rights reserved. 
******************************************************************************/ 
 
 
#pragma once
#include <vrvCore/vrvCore.h>
#include <vrvUtil/DtVirtualBaseClass.h>

#include <vrvUtil/signalslib.h>

namespace makVrv 
{ 
   class DtChannel;
   class DtDe;
   class DtMouseEvent;
   class DtRenderer;
   class DtOverlayRenderer;
   class DtOverlayRendererInterface;
   class DtWidgetPicker;
   enum class DtModelSetId;
   struct DtObserverRenderData;
   struct DtOverlayRenderData;

   class DT_DLL_VRVCORE DtOverlayManager 
   {
   public:
      enum DefaultOverlays
      {
         InvalidOverlay = 0,
         ModelSet_3D_Overlay,
         ModelSet_3D_XR_Overlay,
         ModelSet_3D_Sensor_Overlay,
         ModelSet_3D_Icons_Overlay,
         ModelSet_3D_Images_Overlay,
         ModelSet_2D_Icons_Overlay,
         ModelSet_2D_Images_Overlay,
         ModelSet_UserStart,
         //Allow 16 user set model sets.
         ModelSet_UserEnd = ModelSet_UserStart + 16,
         Channel_SpecificStart,
         //Allow for 128 channel specific overlays
         Channel_SpecificEnd = Channel_SpecificStart + 128,
         RemoteDisplayOverlay,
         RemoteDisplayWorldOverlay,
         SensorViewOverlay,
         UserStart
      };

   public:

      DtOverlayManager();

      virtual ~DtOverlayManager();

      DtOverlayManager(const DtOverlayManager&) = delete;

      DtOverlayManager& operator = (const DtOverlayManager&) = delete;

   public:

      virtual void render(DtChannel* channel,
         const DtOverlayRenderData& overlayRenderData,
         const DtObserverRenderData& channelRenderData,
         const double* currentProjectionMatrix) = 0;

      virtual void releaseResources() = 0;

      virtual DtOverlayRendererInterface& overlayRenderer(unsigned int layerId) = 0;

      virtual DtOverlayRendererInterface& overlayRendererEmptyScene(DtChannel* channel) = 0;
      virtual DtOverlayRendererInterface& overlayRenderer(DtChannel* channel) = 0;
      virtual DtOverlayRendererInterface& overlayRenderer3D(DtChannel* channel) = 0;
      virtual DtOverlayRendererInterface& overlayRenderer2DNormalized(DtChannel* channel) = 0;

      virtual DtOverlayRendererInterface& overlayRenderer(DtChannel* channel, DtModelSetId modelSet) = 0;

      virtual DtWidgetPicker& widgetPicker(unsigned int layerId) = 0;

      virtual DtWidgetPicker& widgetPicker(DtChannel* channel) = 0;
      virtual DtWidgetPicker& widgetPicker3D(DtChannel* channel) = 0;
      virtual DtWidgetPicker& widgetPicker2DNormalized(DtChannel* channel) = 0;

      virtual DtWidgetPicker& widgetPicker(DtChannel* channel, DtModelSetId modelSet) = 0;

      static DefaultOverlays modelSetToOverlay(DtModelSetId modelSet);

      virtual void enableOverlayOnChannel(unsigned int layerId, bool enabled, 
         DtChannel& channel) = 0;

      virtual bool handleMouseEvent(const DtMouseEvent& ev, 
         DtChannel& channel) = 0;

      virtual void destroyOverlayLayer(unsigned int layerId) = 0;

      virtual bool overlayLayerIsVisible(unsigned int layerId) const = 0;

      virtual void setOverlayLayerVisibility(unsigned int layerId, 
         bool visible) = 0;

      boost::signalslib::signal<void (DtChannel* channel, DefaultOverlays overlay)> signal_overlayAboutToBeRendered;

   };

   class DT_DLL_VRVCORE DtOverlayManagerCreator : public DtVirtualBaseClass
   {
   public:

      static DtOverlayManagerCreator& instance(DtDe&);

      static void registerInstance(DtDe& de,DtOverlayManagerCreator*);

      virtual DtOverlayManager* create(DtDe& de) = 0;
   };
}