src/FiltersAPI/FiltersAPI_Selection.h

   1 // Copyright (C) 2014-2023  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 email : webmaster.salome@opencascade.com
  18 //
  19
  20 #ifndef FILTERSAPI_SELECTION_H_
  21 #define FILTERSAPI_SELECTION_H_
  22
  23 #include "FiltersAPI.h"
  24 #include "FiltersAPI_Feature.h"
  25
  26 #include <ModelHighAPI_Selection.h>
  27
  28
  29 /**\class FiltersAPI_Selection
  30  * \ingroup CPPHighAPI
  31  * \brief Interface for the selection of filters
  32  */
  33 class FiltersAPI_Selection : public ModelHighAPI_Selection
  34 {
  35 public:
  36   /// Constructor without values
  37   FILTERSAPI_EXPORT
  38   explicit FiltersAPI_Selection(const FiltersPtr& theFeature);
  39
  40   /// Destructor
  41   FILTERSAPI_EXPORT
  42   virtual ~FiltersAPI_Selection();
  43
  44   /// Return filters feature
  45   FILTERSAPI_EXPORT
  46   FiltersFeaturePtr feature() const;
  47
  48   /// Return selected entities
  49   FILTERSAPI_EXPORT
  50   std::list<ModelHighAPI_Selection> select(const std::string theShapeType) const;
  51   FILTERSAPI_EXPORT
  52   std::list<ModelHighAPI_Selection> select(const GeomAPI_Shape::ShapeType theShapeType) const;
  53 };
  54
  55 /// Create list of filters
  56 FILTERSAPI_EXPORT
  57 FiltersAPI_Selection filters(const std::shared_ptr<ModelAPI_Document>& thePart,
  58                              const std::list<FilterAPIPtr>& theFilters);
  59
  60 #endif