src/Selector/Selector_FilterByNeighbors.h

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