ModuleBase_ISelection.h

// Copyright (C) 2014-2025  CEA, EDF
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
//
// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
//
 
#ifndef ModuleBase_ISelection_H
#define ModuleBase_ISelection_H
 
#include "ModuleBase.h"
#include "ModuleBase_Definitions.h"
 
#include <ModelAPI_Result.h>
#include <GeomAPI_Shape.h>
#include <GeomAPI_Vertex.h>
 
#include <QModelIndexList>
#include <AIS_ListOfInteractive.hxx>
#include <NCollection_List.hxx>
#include <TopoDS_Shape.hxx>
 
#include <QList>
 
class ModuleBase_ViewerPrs;
class SelectMgr_EntityOwner;
 
class MODULEBASE_EXPORT ModuleBase_ISelection
{
public:
  enum SelectionPlace { Browser, Viewer, ConstraintsBrowser, AllControls };
 
  virtual ~ModuleBase_ISelection() {}
 
  virtual QList<std::shared_ptr<ModuleBase_ViewerPrs>>
    getSelected(const SelectionPlace& thePlace = Browser) const = 0;
 
  static void appendSelected(const QList<std::shared_ptr<ModuleBase_ViewerPrs>> theValues,
                             QList<std::shared_ptr<ModuleBase_ViewerPrs>>& theValuesTo);
 
  virtual QList<std::shared_ptr<ModuleBase_ViewerPrs>> getHighlighted() const = 0;
 
  virtual void fillPresentation(std::shared_ptr<ModuleBase_ViewerPrs>& thePrs,
                                const Handle(SelectMgr_EntityOwner)& theOwner) const = 0;
 
  virtual QObjectPtrList selectedObjects() const = 0;
 
  virtual QObjectPtrList selectedPresentations() const = 0;
 
  virtual QMap<ResultPtr, QList<GeomShapePtr>> selectedObjectsAndSubObjects() const = 0;
 
  virtual QModelIndexList selectedIndexes() const = 0;
 
  ResultPtr getResult(const std::shared_ptr<ModuleBase_ViewerPrs>& thePrs);
 
  GeomShapePtr getShape(const std::shared_ptr<ModuleBase_ViewerPrs>& thePrs);
 
  virtual Handle(AIS_InteractiveObject)
    getIO(const std::shared_ptr<ModuleBase_ViewerPrs>& thePrs) = 0;
 
  static QList<std::shared_ptr<ModuleBase_ViewerPrs>> getViewerPrs(
                                                       const QObjectPtrList& theObjects);
 
  static void filterSelectionOnEqualPoints
                                      (QList<std::shared_ptr<ModuleBase_ViewerPrs>>& theSelected);
protected:
  virtual ObjectPtr getSelectableObject(const Handle(SelectMgr_EntityOwner)& theOwner) const = 0;
 
private:
  static std::shared_ptr<GeomAPI_Vertex> getPresentationVertex(
                                               const std::shared_ptr<ModuleBase_ViewerPrs>& thePrs);
};
 
#endif