X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FModuleBase%2FModuleBase_ISelection.h;h=0f9c0cb68c9489ef566dba972e8392ba03ab2974;hb=e3483e0c2eaddb88f2e55a72bd81ca0fb67cc4ce;hp=c1b06ca1b71fae47724684d7c339f41e2fdcd158;hpb=0b06415cbaab3da89567c28ea4a7ae6ecf50511b;p=modules%2Fshaper.git diff --git a/src/ModuleBase/ModuleBase_ISelection.h b/src/ModuleBase/ModuleBase_ISelection.h index c1b06ca1b..0f9c0cb68 100644 --- a/src/ModuleBase/ModuleBase_ISelection.h +++ b/src/ModuleBase/ModuleBase_ISelection.h @@ -1,3 +1,5 @@ +// Copyright (C) 2014-20xx CEA/DEN, EDF R&D + // File: ModuleBase_ISelection.h // Created: 2 June 2014 // Author: Vitaly Smetannikov @@ -9,6 +11,9 @@ #include "ModuleBase_Definitions.h" #include "ModuleBase_ViewerPrs.h" +#include +#include + #include #include #include @@ -16,40 +21,103 @@ #include +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 getSelected(int theShapeTypeToSkip = -1) const = 0; + virtual QList 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 theValues, + QList& 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 getHighlighted(int theShapeTypeToSkip = -1) const = 0; + virtual QList 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(ModuleBase_ViewerPrs& thePrs, + const Handle_SelectMgr_EntityOwner& theOwner) const = 0; /** - * Returns list of features currently selected in 3d viewer + * Returns list of features currently selected in object browser */ - virtual QList selectedObjects() const = 0; + virtual QObjectPtrList selectedObjects() const = 0; + + /// Set selected objects list + virtual void setSelectedObjects( const QObjectPtrList& ) const = 0; /** * Returns list of currently selected results */ - virtual QList selectedPresentations() const = 0; + virtual QObjectPtrList selectedPresentations() const = 0; //! Returns list of currently selected QModelIndexes 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& theList, std::list& 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 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 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 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 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& 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 ModuleBase_ViewerPrs thePrs1, + const ModuleBase_ViewerPrs thePrs2); }; #endif