src/XGUI/XGUI_ModuleConnector.h

   1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D -->
   2
   3 // File:        XGUI_ModuleConnector.h
   4 // Created:     3 June 2014
   5 // Author:      Vitaly Smetannikov
   6
   7 #ifndef XGUI_ModuleConnector_H
   8 #define XGUI_ModuleConnector_H
   9
  10 #include "XGUI.h"
  11 #include <ModuleBase_Definitions.h>
  12 #include <ModuleBase_IWorkshop.h>
  13
  14 class Handle_AIS_InteractiveContext;
  15 class XGUI_Workshop;
  16 class XGUI_Displayer;
  17
  18 /**
  19  * \ingroup GUI
  20  * Implementation of IWorkshop interface which provides access to Workshop services at module level
  21  */
  22 class XGUI_EXPORT XGUI_ModuleConnector : public ModuleBase_IWorkshop
  23 {
  24 Q_OBJECT
  25  public:
  26    /// Constructor
  27    /// \param theWorkshop a workshop
  28   XGUI_ModuleConnector(XGUI_Workshop* theWorkshop);
  29
  30   virtual ~XGUI_ModuleConnector();
  31
  32   //! Returns list of currently selected data objects
  33   virtual ModuleBase_ISelection* selection() const;
  34
  35   /// Activate sub-shapes selection (opens local context if it was not opened)
  36   /// Types has to be dined according to TopAbs_ShapeEnum
  37   virtual void activateSubShapesSelection(const QIntList& theTypes);
  38
  39   /// Activate objects in the module selection modes(opens local context)
  40   virtual void activateModuleSelectionModes();
  41
  42   /// Deactivate sub-shapes selection (closes local context)
  43   virtual void deactivateSubShapesSelection();
  44
  45   //! Returns instance of loaded module
  46   virtual ModuleBase_IModule* module() const;
  47
  48   //! Returns current viewer
  49   virtual ModuleBase_IViewer* viewer() const;
  50
  51   //! Returns property panel
  52   virtual ModuleBase_IPropertyPanel* propertyPanel() const;
  53
  54   //! Returns currently active operation
  55   virtual ModuleBase_Operation* currentOperation() const;
  56
  57   //! Returns true if the operation with id theId can be started
  58   virtual bool canStartOperation(QString theId);
  59
  60   //! Returns started operation by the operation identifier. The operation manager is called.
  61   //! \param theId an operation id
  62   //! \return an operation instance or NULL
  63   virtual ModuleBase_Operation* findStartedOperation(const QString& theId);
  64
  65   //! Returns true if the operation with id theId can be stopped. The operation manager is called.
  66   //! \param theOperation a stopped operation
  67   //! \return boolean result
  68   virtual bool canStopOperation(ModuleBase_Operation* theOperation);
  69
  70   //! Aborts the operation. The operation manager is called.
  71   //! \param theOperation an aborted operation
  72   void abortOperation(ModuleBase_Operation* theOperation);
  73
  74   //! Returns AIS object by data object
  75   virtual AISObjectPtr findPresentation(const ObjectPtr& theObject) const;
  76
  77   //! Returns data object by AIS
  78   virtual ObjectPtr findPresentedObject(const AISObjectPtr& theAIS) const;
  79
  80   //! Select features clearing previous selection.
  81   //! If the list is empty then selection will be cleared
  82   virtual void setSelected(const QList<ModuleBase_ViewerPrs>& theValues);
  83
  84   //! Returns workshop
  85   XGUI_Workshop* workshop() const { return myWorkshop; }
  86
  87 private:
  88   QObjectPtrList activeObjects(const QObjectPtrList& theObjList) const;
  89
  90   /// Reference to workshop
  91   XGUI_Workshop* myWorkshop;
  92 };
  93
  94 #endif