+// Copyright (C) 2014-20xx CEA/DEN, EDF R&D
+
// File: ModuleBase_ISelection.h
// Created: 2 June 2014
// Author: Vitaly Smetannikov
#include "ModuleBase.h"
#include "ModuleBase_Definitions.h"
-#include "ModuleBase_ViewerPrs.h"
+
+#include <ModelAPI_Result.h>
+#include <GeomAPI_Shape.h>
#include <QModelIndexList>
#include <AIS_ListOfInteractive.hxx>
#include <QList>
+class ModuleBase_ViewerPrs;
+class Handle_SelectMgr_EntityOwner;
+
+/**
+* \ingroup GUI
+* A class which provides access to selection.
+* A selection can be obtained as from a viewer as from Object browser in various forms
+*/
class ModuleBase_ISelection
{
public:
+ /// Types of the selection place, where the selection is obtained
+ enum SelectionPlace { Browser, Viewer, AllControls };
/// Returns a list of viewer selected presentations
- /// \param theShapeTypeToSkip the shapes with this type will be skipped during the result list build
/// \return list of presentations
- virtual QList<ModuleBase_ViewerPrs> getSelected(int theShapeTypeToSkip = -1) const = 0;
+ virtual QList<std::shared_ptr<ModuleBase_ViewerPrs>> getSelected(const SelectionPlace& thePlace = Browser) const = 0;
+
+ /// The values are appended to the first parameter list if the first list does not contain an item
+ /// with the same object
+ /// \param theValues a list of new values
+ /// \param theValuesTo a list, that will be changed
+ static void appendSelected(const QList<std::shared_ptr<ModuleBase_ViewerPrs>> theValues,
+ QList<std::shared_ptr<ModuleBase_ViewerPrs>>& theValuesTo);
/// Returns a list of viewer highlited presentations
- /// \param theShapeTypeToSkip the shapes with this type will be skipped during the result list build
/// \return list of presentations
- virtual QList<ModuleBase_ViewerPrs> getHighlighted(int theShapeTypeToSkip = -1) const = 0;
+ virtual QList<std::shared_ptr<ModuleBase_ViewerPrs>> getHighlighted() const = 0;
+
+ /// Fills the viewer presentation parameters by the parameters from the owner
+ /// \param thePrs a container for selection
+ /// \param theOwner a selection owner
+ virtual void fillPresentation(std::shared_ptr<ModuleBase_ViewerPrs>& thePrs,
+ const Handle_SelectMgr_EntityOwner& theOwner) const = 0;
/**
* Returns list of features currently selected in object browser
*/
virtual QObjectPtrList selectedObjects() const = 0;
+ /// Set selected objects list
+ virtual void setSelectedObjects( const QObjectPtrList& ) const = 0;
+
/**
* Returns list of currently selected results
*/
virtual QModelIndexList selectedIndexes() const = 0;
//! Returns list of currently selected AIS objects
+ //! \param theList returning list of selected AIS objects
virtual void selectedAISObjects(AIS_ListOfInteractive& theList) const = 0;
- //! Returns list of currently selected shapes
+ //! Returns list of currently selected QModelIndexes
+ virtual ObjectPtr getSelectableObject(const Handle_SelectMgr_EntityOwner& theOwner) const = 0;
+
+ //! Returns list of currently selected shapes and their owners (objects).
+ //! Both lists are synchronized
+ //! \param theList returning list of selected AIS objects
+ //! \param theOwners list of objects
virtual void selectedShapes(NCollection_List<TopoDS_Shape>& theList,
std::list<ObjectPtr>& theOwners) const = 0;
+ //! Return the shape from the viewer presentation.
+ //! If the shape is equal to the shape of selected object, it returns an empty shape
+ //! \param thePrs a selected object
+ //! \return a shape
+ MODULEBASE_EXPORT ResultPtr getResult(const std::shared_ptr<ModuleBase_ViewerPrs>& thePrs);
+
+ //! Return the shape from the viewer presentation.
+ //! If the shape is equal to the shape of selected object, it returns an empty shape
+ //! \param thePrs a selected object
+ //! \return a shape
+ MODULEBASE_EXPORT GeomShapePtr getShape(const std::shared_ptr<ModuleBase_ViewerPrs>& thePrs);
+
+ //! Return the IO from the viewer presentation.
+ //! \param thePrs a selected object
+ //! \return an interactive object
+ virtual MODULEBASE_EXPORT Handle(AIS_InteractiveObject) getIO(const std::shared_ptr<ModuleBase_ViewerPrs>& thePrs) = 0;
+
+ //! Wraps the object list into the viewer prs list
+ //! \param theObjects a list of objects
+ //! \return a list of prs, where only object is not empty
+ static MODULEBASE_EXPORT QList<std::shared_ptr<ModuleBase_ViewerPrs>> getViewerPrs(
+ const QObjectPtrList& theObjects);
+
+ /// Removes selection items where owners have equal vertices. The first
+ /// owner with the qual vertex stays in the list.
+ static MODULEBASE_EXPORT void filterSelectionOnEqualPoints
+ (QList<std::shared_ptr<ModuleBase_ViewerPrs>>& theSelected);
+private:
+ /// Returns true if the presentations have an owner with a vertex and these vertices are equal.
+ /// \param thePrs1 the first viewer selected presentation
+ /// \param thePrs2 the second viewer selected presentation
+ static bool isEqualVertices(const std::shared_ptr<ModuleBase_ViewerPrs> thePrs1,
+ const std::shared_ptr<ModuleBase_ViewerPrs> thePrs2);
};
#endif
