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 #include <ModuleBase_ViewerFilters.h>
  14
  15 class Handle_AIS_InteractiveContext;
  16 class XGUI_Workshop;
  17 class XGUI_Displayer;
  18
  19 /**
  20  * \ingroup GUI
  21  * Implementation of IWorkshop interface which provides access to Workshop sevices at module level
  22  */
  23 class XGUI_EXPORT XGUI_ModuleConnector : public ModuleBase_IWorkshop
  24 {
  25 Q_OBJECT
  26  public:
  27    /// Constructor
  28    /// \param theWorkshop a workshop
  29   XGUI_ModuleConnector(XGUI_Workshop* theWorkshop);
  30
  31   virtual ~XGUI_ModuleConnector();
  32
  33   //! Returns list of currently selected data objects
  34   virtual ModuleBase_ISelection* selection() const;
  35
  36   /// Activate sub-shapes selection (opens local context if it was not opened)
  37   /// Types has to be dined according to TopAbs_ShapeEnum
  38   virtual void activateSubShapesSelection(const QIntList& theTypes);
  39
  40   /// Deactivate sub-shapes selection (closes local context)
  41   virtual void deactivateSubShapesSelection();
  42
  43   //! Returns instance of loaded module
  44   virtual ModuleBase_IModule* module() const;
  45
  46   //! Returns current viewer
  47   virtual ModuleBase_IViewer* viewer() const;
  48
  49   //! Returns currently active operation
  50   virtual ModuleBase_Operation* currentOperation() const;
  51
  52   //! Returns true if the operation with id theId can be started
  53   virtual bool canStartOperation(QString theId);
  54
  55   //! Returns AIS opbject by data object
  56   virtual AISObjectPtr findPresentation(const ObjectPtr& theObject) const;
  57
  58   //! Returns data object by AIS
  59   virtual ObjectPtr findPresentedObject(const AISObjectPtr& theAIS) const;
  60
  61   //! Select features clearing previous selection.
  62   //! If the list is empty then selection will be cleared
  63   virtual void setSelected(const QObjectPtrList& theFeatures);
  64
  65   //! Returns workshop
  66   XGUI_Workshop* workshop() const { return myWorkshop; }
  67
  68 private:
  69   /// Reference to workshop
  70   XGUI_Workshop* myWorkshop;
  71
  72   /// A filter which provides selection within a current document or whole PartSet
  73   Handle(ModuleBase_ShapeDocumentFilter) myDocumentShapeFilter;
  74 };
  75
  76 #endif