src/ModuleBase/ModuleBase_ISelection.h

   1 // Copyright (C) 2014-2017  CEA/DEN, EDF R&D
   2 //
   3 // This library is free software; you can redistribute it and/or
   4 // modify it under the terms of the GNU Lesser General Public
   5 // License as published by the Free Software Foundation; either
   6 // version 2.1 of the License, or (at your option) any later version.
   7 //
   8 // This library is distributed in the hope that it will be useful,
   9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11 // Lesser General Public License for more details.
  12 //
  13 // You should have received a copy of the GNU Lesser General Public
  14 // License along with this library; if not, write to the Free Software
  15 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  16 //
  17 // See http://www.salome-platform.org/ or
  18 // email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
  19 //
  20
  21 #ifndef ModuleBase_ISelection_H
  22 #define ModuleBase_ISelection_H
  23
  24 #include "ModuleBase.h"
  25 #include "ModuleBase_Definitions.h"
  26
  27 #include <ModelAPI_Result.h>
  28 #include <GeomAPI_Shape.h>
  29 #include <GeomAPI_Vertex.h>
  30
  31 #include <QModelIndexList>
  32 #include <AIS_ListOfInteractive.hxx>
  33 #include <NCollection_List.hxx>
  34 #include <TopoDS_Shape.hxx>
  35
  36 #include <QList>
  37
  38 class ModuleBase_ViewerPrs;
  39 class SelectMgr_EntityOwner;
  40
  41 /// \ingroup GUI
  42 /// A class which provides access to selection.
  43 /// A selection can be obtained as from a viewer as from Object browser in various forms
  44 class ModuleBase_ISelection
  45 {
  46  public:
  47    /// Types of the selection place, where the selection is obtained
  48    enum SelectionPlace { Browser, Viewer, AllControls };
  49
  50   /// Returns a list of viewer selected presentations
  51   /// \return list of presentations
  52   virtual QList<std::shared_ptr<ModuleBase_ViewerPrs>>
  53     getSelected(const SelectionPlace& thePlace = Browser) const = 0;
  54
  55   /// The values are appended to the first parameter list if the first list does not contain
  56   /// an item with the same object
  57   /// \param theValues a list of new values
  58   /// \param theValuesTo a list, that will be changed
  59   static void appendSelected(const QList<std::shared_ptr<ModuleBase_ViewerPrs>> theValues,
  60                              QList<std::shared_ptr<ModuleBase_ViewerPrs>>& theValuesTo);
  61
  62   /// Returns a list of viewer highlited presentations
  63   /// \return list of presentations
  64   virtual QList<std::shared_ptr<ModuleBase_ViewerPrs>> getHighlighted() const = 0;
  65
  66   /// Fills the viewer presentation parameters by the parameters from the owner
  67   /// \param thePrs a container for selection
  68   /// \param theOwner a selection owner
  69   virtual void fillPresentation(std::shared_ptr<ModuleBase_ViewerPrs>& thePrs,
  70                                 const Handle(SelectMgr_EntityOwner)& theOwner) const = 0;
  71
  72   /// Returns list of features currently selected in object browser
  73   virtual QObjectPtrList selectedObjects() const = 0;
  74
  75   /// Returns list of currently selected results
  76   virtual QObjectPtrList selectedPresentations() const = 0;
  77
  78   /// Returns list of currently selected QModelIndexes
  79   virtual QModelIndexList selectedIndexes() const = 0;
  80
  81   /// Return the shape from the viewer presentation.
  82   /// If the shape is equal to the shape of selected object, it returns an empty shape
  83   /// \param thePrs a selected object
  84   /// \return a shape
  85   MODULEBASE_EXPORT ResultPtr getResult(const std::shared_ptr<ModuleBase_ViewerPrs>& thePrs);
  86
  87   /// Return the shape from the viewer presentation.
  88   /// If the shape is equal to the shape of selected object, it returns an empty shape
  89   /// \param thePrs a selected object
  90   /// \return a shape
  91   MODULEBASE_EXPORT GeomShapePtr getShape(const std::shared_ptr<ModuleBase_ViewerPrs>& thePrs);
  92
  93   /// Return the IO from the viewer presentation.
  94   /// \param thePrs a selected object
  95   /// \return an interactive object
  96   virtual MODULEBASE_EXPORT
  97     Handle(AIS_InteractiveObject) getIO(const std::shared_ptr<ModuleBase_ViewerPrs>& thePrs) = 0;
  98
  99   /// Wraps the object list into the viewer prs list
 100   /// \param theObjects a list of objects
 101   /// \return a list of prs, where only object is not empty
 102   static MODULEBASE_EXPORT QList<std::shared_ptr<ModuleBase_ViewerPrs>> getViewerPrs(
 103                                                        const QObjectPtrList& theObjects);
 104
 105   /// Removes selection items where owners have equal vertices. The first
 106   /// owner with the qual vertex stays in the list.
 107   static MODULEBASE_EXPORT void filterSelectionOnEqualPoints
 108                                       (QList<std::shared_ptr<ModuleBase_ViewerPrs>>& theSelected);
 109 protected:
 110   /// Returns list of currently selected QModelIndexes
 111   virtual ObjectPtr getSelectableObject(const Handle(SelectMgr_EntityOwner)& theOwner) const = 0;
 112
 113 private:
 114   /// Find vertex shape build by a Brep owner of the presentation if it exists
 115   /// \param thePrs a viewer presentation
 116   /// \return GeomAPI wrap of vertex
 117   static std::shared_ptr<GeomAPI_Vertex> getPresentationVertex(
 118                                                const std::shared_ptr<ModuleBase_ViewerPrs>& thePrs);
 119 };
 120
 121 #endif