src/Selector/Selector_FilterByNeighbors.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 Selector_FilterByNeighbors_H_
  21 #define Selector_FilterByNeighbors_H_
  22
  23 #include "Selector_AlgoWithSubs.h"
  24
  25 #include <list>
  26
  27 /**\class Selector_FilterByNeighbors
  28  * \ingroup DataModel
  29  * \brief Kind of selection algorithm: selected shape is identified by neighbor faces of
  30  * the same type. Or neighbors of neighbors are considered, etc.
  31  * be named one by one.
  32  */
  33 class Selector_FilterByNeighbors: public Selector_AlgoWithSubs
  34 {
  35   TopAbs_ShapeEnum myShapeType; ///< type of this shape
  36   std::list<int> myNBLevel; ///< list of integers corresponding to subs neighborhood level
  37   TDF_Label myContext; ///< label where the context of filter is stored (for naming name strings)
  38 public:
  39   /// Initializes the selection of this kind
  40   SELECTOR_EXPORT bool select(
  41     const TDF_Label theContextLab, const TopoDS_Shape theContext, const TopoDS_Shape theValue);
  42
  43   /// Stores the name to the label and sub-labels tree
  44   SELECTOR_EXPORT virtual void store() override;
  45
  46   /// Restores the selected shape by the topological naming kept in the data structure
  47   /// Returns true if it can restore structure correctly
  48   SELECTOR_EXPORT virtual bool restore() override;
  49
  50   /// Restores the selected shape by the topological name string.
  51   /// Returns not empty label of the context.
  52   SELECTOR_EXPORT virtual TDF_Label restoreByName(std::wstring theName,
  53     const TopAbs_ShapeEnum theShapeType, Selector_NameGenerator* theNameGenerator) override;
  54
  55   /// Updates the current shape by the stored topological name
  56   SELECTOR_EXPORT virtual bool solve(const TopoDS_Shape& theContext) override;
  57
  58   /// Returns the naming name of the selection
  59   SELECTOR_EXPORT virtual std::wstring name(Selector_NameGenerator* theNameGenerator) override;
  60 private:
  61   /// Initializes selector
  62   Selector_FilterByNeighbors();
  63
  64   friend class Selector_Algo;
  65 };
  66
  67 #endif