src/XGUI/XGUI_Selection.h

   1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D -->
   2
   3 // File:        XGUI_Selection.h
   4 // Created:     8 July 2014
   5 // Author:      Vitaly SMETANNIKOV
   6
   7 #ifndef XGUI_Selection_H
   8 #define XGUI_Selection_H
   9
  10 #include "XGUI.h"
  11
  12 #include <ModuleBase_ViewerPrs.h>
  13 #include <ModuleBase_Definitions.h>
  14 #include <ModuleBase_ISelection.h>
  15
  16 #include <QModelIndexList>
  17 #include <AIS_ListOfInteractive.hxx>
  18 #include <NCollection_List.hxx>
  19 #include <TopoDS_Shape.hxx>
  20
  21 #include <SelectMgr_IndexedMapOfOwner.hxx>
  22
  23 class XGUI_Workshop;
  24 class Handle_SelectMgr_EntityOwner;
  25
  26 /**
  27 * \ingroup GUI
  28 * Implementation of \ref ModuleBase_ISelection interface.
  29 */
  30 class XGUI_EXPORT XGUI_Selection : public ModuleBase_ISelection
  31 {
  32  public:
  33    /// Constructor
  34    /// \param theWorkshop reference to workshop instance
  35   XGUI_Selection(XGUI_Workshop* theWorkshop);
  36
  37   /// Returns a list of viewer selected presentations
  38   /// \return list of presentations
  39   virtual QList<ModuleBase_ViewerPrs> getSelected(const SelectionPlace& thePlace = Browser) const;
  40
  41   /// Fills the viewer presentation parameters by the parameters from the owner
  42   /// \param thePrs a container for selection
  43   /// \param theOwner a selection owner
  44   virtual void fillPresentation(ModuleBase_ViewerPrs& thePrs,
  45                                 const Handle_SelectMgr_EntityOwner& theOwner) const;
  46
  47   /// Returns a list of viewer highlited presentations
  48   /// \return list of presentations
  49   virtual QList<ModuleBase_ViewerPrs> getHighlighted() const;
  50
  51   /**
  52    * Returns list of currently selected objects in object browser
  53    */
  54   virtual QObjectPtrList selectedObjects() const;
  55
  56   /**
  57    * Returns list of currently selected results
  58    */
  59   virtual QObjectPtrList selectedPresentations() const;
  60
  61   //! Returns list of currently selected QModelIndexes
  62   virtual QModelIndexList selectedIndexes() const;
  63
  64   //! Returns list of currently selected QModelIndexes
  65   ObjectPtr getSelectableObject(const Handle(SelectMgr_EntityOwner)& theOwner);
  66
  67   //! Returns list of currently selected AIS objects
  68   virtual void selectedAISObjects(AIS_ListOfInteractive& theList) const;
  69
  70   //! Return a selectable object by the entity owner. It founds AIS object in the viewer
  71   //! and returns the corresponded object
  72   /// \param theOwner an entity owner
  73   /// \return a found object or NULL
  74   ObjectPtr getSelectableObject(const Handle(SelectMgr_EntityOwner)& theOwner) const;
  75
  76   //! Returns list of currently selected shapes
  77   virtual void selectedShapes(NCollection_List<TopoDS_Shape>& theShapes,
  78     std::list<ObjectPtr>& theOwners) const;
  79
  80   //! Returns list of currently selected owners
  81   /// \return list of owners
  82   void selectedOwners(SelectMgr_IndexedMapOfOwner& theSelectedOwners) const;
  83
  84   //! Returns a list of selection entity owners of the interactive object
  85   /// It depends on the modes, in which the object is activated in the context
  86   /// \param theObject an object
  87   /// \param theOwners a map of entity owners
  88   void entityOwners(const Handle_AIS_InteractiveObject& theObject,
  89                     SelectMgr_IndexedMapOfOwner& theOwners) const;
  90
  91   //! Return the IO from the viewer presentation.
  92   //! \param thePrs a selected object
  93   //! \return an interactive object
  94   virtual Handle(AIS_InteractiveObject) getIO(const ModuleBase_ViewerPrs& thePrs);
  95
  96 protected:
  97   /// Fills the list of presentations by objects selected in the viewer.
  98   /// \param thePresentations an output list of presentation
  99   void getSelectedInViewer(QList<ModuleBase_ViewerPrs>& thePresentations) const;
 100   /// Fills the list of presentations by objects selected in the object browser.
 101   /// ViewerPrs contains only object parameter not empty.
 102   /// If the given list of presentations already has a viewer presentation with the same object
 103   /// as selected in the browser, a new item is not appended to the list of presentations.
 104   /// \param thePresentations an output list of presentation
 105   void getSelectedInBrowser(QList<ModuleBase_ViewerPrs>& thePresentations) const;
 106
 107 private:
 108   XGUI_Workshop* myWorkshop;
 109 };
 110
 111 #endif