DtCigiViewController.h

Go to the documentation of this file.

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


#pragma once

#include <vrvCigi/vrvCigi.h>
#include <vrvCore/DtUniqueID.h>
#include <vrvCore/DtObserverObject.h>

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

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

namespace makVrv
{
   class DtDe;
   class DtChannelConfiguration;

   class DtCigiDriver;
   class DtCigiConnection;

   class DT_DLL_VRVCIGI DtCigiViewController
   {
   public:

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

      struct DtViewDefinitionAction
      {
         int groupId;
         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;
      };

      struct DtViewControlPosition
      {
         float xOffset;
         float yOffset;
         float zOffset;
         float roll;
         float pitch;
         float yaw;
      };

      struct DtViewControlAction
      {
         DtUniqueID entityId;
         int groupId;
         bool xOffsetEnabled;
         bool yOffsetEnabled;
         bool zOffsetEnabled;
         bool rollEnabled;
         bool pitchEnabled;
         bool yawEnabled;
         DtViewControlPosition position;
      };

      friend class DtCigiViewControllerCreator;

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

      virtual ~DtCigiViewController();

      virtual std::string viewIdKeyword(int viewId);


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


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

   protected:

      DtCigiViewController(DtDe& de, DtCigiConnection& connection);

      virtual void modifyConfiguration(const std::string& displayName,
         const std::string& windowName, const std::string& channelName,
         const DtChannelConfiguration& config);

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

      virtual void attachObserver(int viewId, const DtViewControlAction& action, 
         DtObserverObject::AttachType attachType=DtObserverObject::AttachTypeMimic );

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

      virtual void addViewToGroup(int viewId, int groupId);

      virtual void slot_onViewDefinitionReceived(int viewId, 
         DtCigiViewController::DtViewDefinitionAction action);

      virtual void performSetViewDefinition(int viewId, 
         const DtCigiViewController::DtViewDefinitionAction& action);

      virtual void slot_onViewControlReceived(int viewId, 
         DtCigiViewController::DtViewControlAction action);

      virtual void performSetViewControl(int viewId, 
         const DtCigiViewController::DtViewControlAction& action);

   protected:

      DtDe& myDe;
      DtCigiConnection& myCigiConnection;
      DtSignalConnectionManager myConnections;

      ViewIdToPositionMap myViewIdToPositionMap;
      GroupIdToGroupMap myGroupIdToGroupMap;
   };

   class DT_DLL_VRVCIGI DtCigiViewControllerCreator : public DtVirtualBaseClass
   {
   public:     
      DtCigiViewControllerCreator( DtDe& de );

      virtual ~DtCigiViewControllerCreator();

      static DtCigiViewControllerCreator& instance( DtDe& de );

      virtual DtCigiViewController* create( DtCigiConnection& connection ) const;

   protected:
         DtDe& myDe;
   };
}