src/FiltersPlugin/FiltersPlugin_FaceSize.h

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