src/FiltersPlugin/FiltersPlugin_OppositeToEdge.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 FILTERSPLUGIN_OPPOSITETOEDGE_H_
  21 #define FILTERSPLUGIN_OPPOSITETOEDGE_H_
  22
  23 #include "FiltersPlugin.h"
  24
  25 #include <GeomAPI_Shape.h>
  26 #include <ModelAPI_Filter.h>
  27
  28 #include <set>
  29
  30 typedef std::set<GeomShapePtr, GeomAPI_Shape::Comparator> SetOfShapes;
  31
  32 /**\class FiltersPlugin_OppositeToEdge
  33 * \ingroup DataModel
  34 * \brief Filter for edges of quadrangular faces opposite to the selected edge
  35 */
  36 class FiltersPlugin_OppositeToEdge : public ModelAPI_Filter
  37 {
  38 public:
  39   FiltersPlugin_OppositeToEdge() : ModelAPI_Filter() {}
  40
  41   virtual const std::string& name() const {
  42     static const std::string kName("Opposite to an edge");
  43     return kName;
  44   }
  45
  46   /// Returns true for any type because it supports all selection types
  47   virtual bool isSupported(GeomAPI_Shape::ShapeType theType) const override;
  48
  49   /// This method should contain the filter logic. It returns true if the given shape
  50   /// is accepted by the filter.
  51   /// \param theShape the given shape
  52   /// \param theArgs arguments of the filter
  53   virtual bool isOk(const GeomShapePtr& theShape, const ResultPtr&,
  54                     const ModelAPI_FiltersArgs& theArgs) const override;
  55
  56   /// Returns XML string which represents GUI of the filter
  57   virtual std::string xmlRepresentation() const override;
  58
  59   /// Initializes arguments of a filter.
  60   virtual void initAttributes(ModelAPI_FiltersArgs& theArguments) override;
  61
  62 private:
  63   /// Original edge selected for filtering
  64   GeomShapePtr myOriginalEdge;
  65   /// Shapes applicable for the filter
  66   SetOfShapes myCachedShapes;
  67 };
  68
  69 #endif