src/FiltersPlugin/FiltersPlugin_OnShapeName.h

   1 // Copyright (C) 2014-2024  CEA, EDF
   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 FILTERSPLUGIN_ONSHAPENAME_H_
  21 #define FILTERSPLUGIN_ONSHAPENAME_H_
  22
  23 #include "FiltersPlugin.h"
  24
  25 #include <ModelAPI_Filter.h>
  26
  27 /**\class FiltersPlugin_OnPlaneSide
  28 * \ingroup DataModel
  29 * \brief Filter for objects which lying on the side of selected plane
  30 */
  31 class FiltersPlugin_OnShapeName : public ModelAPI_Filter
  32 {
  33 public:
  34     FiltersPlugin_OnShapeName() : ModelAPI_Filter() {}
  35
  36     virtual const std::string& name() const
  37     {
  38         static const std::string kName("On shape name");
  39         return kName;
  40     }
  41
  42     /// Returns true for face type
  43     virtual bool isSupported(GeomAPI_Shape::ShapeType theType) const override;
  44
  45     /// This method should contain the filter logic. It returns true if the given shape
  46     /// is accepted by the filter.
  47     /// \param theShape the given shape
  48     /// \param theArgs arguments of the filter
  49     virtual bool isOk(const GeomShapePtr& theShape,const ResultPtr& theResult,
  50                       const ModelAPI_FiltersArgs& theArgs) const override;
  51
  52     /// Returns XML string which represents GUI of the filter
  53     virtual std::string xmlRepresentation() const override;
  54
  55     /// Initializes arguments of a filter.
  56     virtual void initAttributes(ModelAPI_FiltersArgs& theArguments) override;
  57 };
  58
  59 #endif