1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
3 // File: ModuleBase_ISelection.h
4 // Created: 2 June 2014
5 // Author: Vitaly Smetannikov
7 #ifndef ModuleBase_ISelection_H
8 #define ModuleBase_ISelection_H
10 #include "ModuleBase.h"
11 #include "ModuleBase_Definitions.h"
12 #include "ModuleBase_ViewerPrs.h"
14 #include <QModelIndexList>
15 #include <AIS_ListOfInteractive.hxx>
16 #include <NCollection_List.hxx>
17 #include <TopoDS_Shape.hxx>
21 class Handle_SelectMgr_EntityOwner;
25 * A class which provides access to selection.
26 * A selection can be obtained as from a viewer as from Object browser in various forms
28 class ModuleBase_ISelection
32 /// Returns a list of viewer selected presentations
33 /// \return list of presentations
34 virtual QList<ModuleBase_ViewerPrs> getSelected() const = 0;
36 /// Returns a list of viewer highlited presentations
37 /// \return list of presentations
38 virtual QList<ModuleBase_ViewerPrs> getHighlighted() const = 0;
40 /// Fills the viewer presentation parameters by the parameters from the owner
41 /// \param thePrs a container for selection
42 /// \param theOwner a selection owner
43 virtual void fillPresentation(ModuleBase_ViewerPrs& thePrs,
44 const Handle_SelectMgr_EntityOwner& theOwner) const = 0;
47 * Returns list of features currently selected in object browser
49 virtual QObjectPtrList selectedObjects() const = 0;
52 * Returns list of currently selected results
54 virtual QObjectPtrList selectedPresentations() const = 0;
56 //! Returns list of currently selected QModelIndexes
57 virtual QModelIndexList selectedIndexes() const = 0;
59 //! Returns list of currently selected AIS objects
60 //! \param theList returning list of selected AIS objects
61 virtual void selectedAISObjects(AIS_ListOfInteractive& theList) const = 0;
63 //! Returns list of currently selected QModelIndexes
64 virtual ObjectPtr getSelectableObject(const Handle_SelectMgr_EntityOwner& theOwner) const = 0;
66 //! Returns list of currently selected shapes and their owners (objects).
67 //! Both lists are synchronized
68 //! \param theList returning list of selected AIS objects
69 //! \param theOwners list of objects
70 virtual void selectedShapes(NCollection_List<TopoDS_Shape>& theList,
71 std::list<ObjectPtr>& theOwners) const = 0;
73 //! Wraps the object list into the viewer prs list
74 //! \param theObjects a list of objects
75 //! \return a list of prs, where only object is not empty
76 static MODULEBASE_EXPORT QList<ModuleBase_ViewerPrs> getViewerPrs(
77 const QObjectPtrList& theObjects);