DtCigiViewManager.h

Go to the documentation of this file.

/*********************************************************************
** Copyright (c) 2025 MaK Technologies, Inc.
** All rights reserved.
*********************************************************************/


#pragma once

#include <vrvCigi/vrvCigi.h>
#include <vrvCore/DtUniqueID.h>
#include <vrvUtil/DtVirtualBaseClass.h>
#include <vrvUtil/DtSignalConnectionManager.h>

#include <string>
#include <map>
#include <set>

class CigiBaseViewCtrl;
class CigiBaseViewDef;
class CigiBaseCompCtrl;

namespace makVrv 
{
   class DtDe;
   class DtObserver;
   class DtChannel;
   class DtChannelConfiguration;
   class DtCigiConnection;

   class DT_DLL_VRVCIGI DtCigiViewManager 
   {
   public:

      enum CIGI_GROUP_ATTACH_TYPE
      {
         CigiAttachTypeTether = 252,
         CigiAttachTypeMimic = 253,
         CigiAttachTypeFollow = 254,
         CigiAttachTypeTrack = 255
      };

      struct DtViewDefinitionAction
      {
         int groupId;
         bool reorder;
         std::string observerMode;
         bool zNearEnabled;
         float zNear;
         bool zFarEnabled;
         float zFar;
         bool leftEnabled;
         float left;
         bool rightEnabled;
         float right;
         bool topEnabled;
         float top;
         bool bottomEnabled;
         float bottom;
         bool mirrorMode;
      };

      struct DtViewControlPosition
      {
         DtViewControlPosition()
            : xOffset(0.0f)
            , yOffset(0.0f)
            , zOffset(0.0f)
            , roll(0.0f)
            , pitch(0.0f)
            , yaw(0.0f)
         {};

         float xOffset;
         float yOffset;
         float zOffset;
         float roll;
         float pitch;
         float yaw;
      };

      struct DtViewControlAction
      {
         DtViewControlAction()
            : entityId(0)
            , groupId(0)
            , xOffsetEnabled(false)
            , yOffsetEnabled(false)
            , zOffsetEnabled(false)
            , rollEnabled(false)
            , pitchEnabled(false)
            , yawEnabled(false)
            , attachEnabled(false)
         {};


         DtUniqueID entityId;
         int groupId;
         bool xOffsetEnabled;
         bool yOffsetEnabled;
         bool zOffsetEnabled;
         bool rollEnabled;
         bool pitchEnabled;
         bool yawEnabled;
         bool attachEnabled;
         DtViewControlPosition position;
      };

      using DtViewGroup = std::set<int>;
      using GroupIdToGroupMap = std::map<int, DtViewGroup>;
      using ViewIdToPositionMap = std::map<int, DtViewControlPosition>;

      friend class DtCigiViewManagerCreator;

      virtual const ViewIdToPositionMap& viewIdToPositionMap() const;
      virtual ViewIdToPositionMap& viewIdToPositionMap();

      virtual const GroupIdToGroupMap& groupIdToGroupMap() const;
      virtual GroupIdToGroupMap& groupIdToGroupMap();

      virtual ~DtCigiViewManager();

      virtual void reset();

      virtual DtViewControlPosition viewControlPosition( int viewId, const DtViewControlAction& action );

      virtual void addViewToGroup( int viewId, int groupId );

      virtual void removeViewFromGroups( int viewId );

      virtual std::string viewIdKeyword( int viewId );

      virtual bool retrieveConfiguration( DtDe& de, int viewId, std::string& displayName,
         std::string& windowName, std::string& channelName, DtChannelConfiguration& config  );

      virtual int maxRenderOrder( DtDe& de, int viewId, std::string& displayName,
         std::string& windowName );

      virtual DtObserver* findObserverFromCigiViewId( DtDe& de, int viewId );

      virtual DtChannel* findChannelFromCigiViewId( DtDe& de, int viewId );

      boost::signalslib::signal<void( int, DtViewDefinitionAction )>
         signal_receivedViewDefinition;

      boost::signalslib::signal<void( int, DtViewControlAction )>
         signal_receivedViewControl;

      virtual void getViewNames( DtDe& de, int viewId, std::string& displayName, std::string& windowName, std::string& channelName );

      DtCigiViewManager( const DtCigiViewManager& ) = delete;
      DtCigiViewManager( DtCigiViewManager&& ) = delete;
      DtCigiViewManager& operator=( const DtCigiViewManager& ) = delete;
      DtCigiViewManager& operator=( DtCigiViewManager&& ) = delete;
   protected:
      DtCigiViewManager(DtCigiConnection& connection);

      virtual void slot_processViewDefinition( CigiBaseViewDef& viewDefinition );

      virtual void slot_viewControlReceived( CigiBaseViewCtrl& viewControl );

   protected:
      DtCigiConnection& myConnection;
      DtSignalConnectionManager myCigiConnectionSignals;

      ViewIdToPositionMap myViewIdToPositionMap;
      GroupIdToGroupMap myGroupIdToGroupMap;
   };

   class DT_DLL_VRVCIGI DtCigiViewManagerCreator : public DtVirtualBaseClass
   {
   public:
      DtCigiViewManagerCreator();

      virtual ~DtCigiViewManagerCreator();

      static DtCigiViewManagerCreator& instance( DtDe& de );

      static DtCigiViewManagerCreator& instance( DtCigiConnection& con );

      virtual DtCigiViewManagerCreator* clone();

      static void copyInstance( DtCigiConnection& con, DtDe& de );

      virtual DtCigiViewManager* create( DtCigiConnection& connection ) const;

   };
}