DtWidgetPicker.h

Go to the documentation of this file.

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


#pragma once

#include <vrvGraphics/vrvGraphics.h>

#include <vrvUtil/DtVirtualBaseClass.h>
#include <vrvUtil/DtVirtualBaseClassCreator.h>

#include <unordered_map>

namespace makVrv
{
   class DtDecalProjectorComponentInterface;
   class DtFrameBufferObject;
   class DtLineRenderer;
   class DtLineSegment;
   class DtOverlayResourceProvider;
   class DtPickableTriangle;
   class DtPickableWidget;
   class DtPixelBufferObject;
   class DtQuadProxy;
   class DtQuadRenderer;
   class DtTextureObject;
   class DtTriangleProxy;
   class DtTriangleRenderer;
   class DtPickableWidget;
   class DtPickableQuad;
   class DtPickableLine;
   class DtPickableTriangle;
   class DtPickableDecalProjector;
   class DtDe;
   struct DtObserverRenderData;

   class DtWidgetPicker;

   typedef DtVirtualBaseClassCreator<DtWidgetPicker, DtOverlayResourceProvider&> DtWidgetPickerCreator;

   template <>
   inline const char* creatorTypeName<DtWidgetPicker>(void) { return "DtWidgetPickerCreator"; }

   class DT_DLL_VRVGRAPHICS DtWidgetPicker
   {
      friend DtWidgetPickerCreator;

   public:

      enum MousePickType
      {
         NO_EVENT = 0,
         LEFT_MOUSE_PRESS, 
         LEFT_MOUSE_RELEASE,
         LEFT_MOUSE_DOUBLECLICK,
         MIDDLE_MOUSE_PRESS, 
         MIDDLE_MOUSE_RELEASE,
         MIDDLE_MOUSE_DOUBLECLICK,
         RIGHT_MOUSE_PRESS, 
         RIGHT_MOUSE_RELEASE,
         RIGHT_MOUSE_DOUBLECLICK,
         MOUSE_MOVE,
         MOUSE_WHEEL
      };

      struct MousePickRecord
      {
         MousePickType type;
         int x;
         int y;
         int wheel;

         // Additional hit information for a scene pick.
         // sceneHit - true if a valid scene hit
         // (sceneX, sceneY, sceneZ) - scene hit location
         bool sceneHit = false;
         // The mouse event is passed to all pickers, but there
         // is no need to pick the scene more than once
         bool scenePicked = false;
         double sceneX = 0;
         double sceneY = 0;
         double sceneZ = 0;
      };


      friend class DtPickableWidget;
      friend class DtPickableQuad;
      friend class DtPickableLine;
      friend class DtPickableTriangle;

   public:

      virtual ~DtWidgetPicker();

      DtWidgetPicker() = delete;
      DtWidgetPicker(const DtWidgetPicker& rhs) = delete;
      DtWidgetPicker& operator=(const DtWidgetPicker& rhs) = delete;
   public:
      virtual unsigned int numberOfWidgets() const;

      virtual void releaseResources(bool renderer);

      virtual DtFrameBufferObject* frameBufferObject(void);

      virtual DtPickableQuad* allocatePickableQuad();

      virtual DtPickableTriangle* allocatePickableTriangle();

      virtual DtPickableLine* allocatePickableLine();

      virtual DtPickableDecalProjector* allocatePickableDecalProjector(
         DtDecalProjectorComponentInterface* component);

      virtual void registerPickableDecalProjector(DtPickableDecalProjector* widget);

      virtual void unregisterPickableDecalProjector(DtPickableDecalProjector* widget);

      virtual bool requiresScenePick() const;

      virtual void pick(const MousePickRecord& rec, bool geocentric
         , double cameraPosition[3], const DtObserverRenderData& observerRenderData, double cameraMatrix[16]
         , const int viewport[4]);

      virtual const DtPickableWidget* findWidgetFromLastPick() const;

      virtual bool signalEvents();

      virtual void clearEvents();

      boost::signalslib::signal<void ()> signal_destroyed;

   protected:

      DtWidgetPicker(DtDe& de, DtOverlayResourceProvider& provider);
      
      virtual DtPickableWidget* calculateWidgetFromLastPick();

      virtual void debugRender();

      virtual DtQuadProxy* allocateQuad();

      virtual DtLineSegment* allocateLine();

      virtual DtTriangleProxy* allocateTriangle();

      virtual unsigned int widgetCreated(DtPickableWidget*);

      virtual void widgetToBeDeleted(DtPickableWidget*);
      
      virtual bool allocateResources();

   protected:

      DtOverlayResourceProvider& myProvider;
      DtFrameBufferObject* myFrameBuffer;
      DtPixelBufferObject* myPixelBuffer;
      DtTextureObject* mySampleTexture;
      DtQuadRenderer* myQuadRenderer;
      DtLineRenderer* myLineRenderer;
      DtTriangleRenderer* myTriangleRenderer;
      std::unordered_map<DtPickableDecalProjector*, unsigned int> myPickableDecalProjectors;

      int myDesiredWidth;
      int myDesiredHeight;
      
      bool myPendingEventFlag;
      MousePickRecord myPendingEvent;      

      DtPickableWidget* myMouseFocusWidget;

      using WidgetIdMap = std::unordered_map<unsigned int, DtPickableWidget*>;
      WidgetIdMap myWidgetIds;

      unsigned int myFreeId;
      DtDe& myDe;

      std::vector<unsigned int> myColorBuffer;
   };

}