src/Selector/Selector_Selector.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 Selector_Selector_H_
  21 #define Selector_Selector_H_
  22
  23 #include "Selector.h"
  24
  25 #include <TDF_Label.hxx>
  26 #include <TopoDS_Shape.hxx>
  27
  28 class Selector_NameGenerator;
  29 class Selector_Algo;
  30
  31 /**\class Selector_Selector
  32  * \ingroup DataModel
  33  * \brief Main object for selection of the sub-shapes in the parametrically updated
  34  * shapes using topological naming mechanism.
  35  */
  36 class Selector_Selector
  37 {
  38   TDF_Label myLab; ///< main label where selector is performed
  39   TDF_Label myBaseDocumentLab; ///< an access-label to the document that may contain initial shapes
  40   Selector_Algo* myAlgo; ///< root algorithm of the selector
  41
  42 public:
  43   /// Initializes selector on the label
  44   SELECTOR_EXPORT Selector_Selector(TDF_Label theLab, TDF_Label theBaseDocLab = TDF_Label());
  45
  46   /// Destructor
  47   SELECTOR_EXPORT ~Selector_Selector();
  48
  49   /// Initializes the selector structure on the label.
  50   /// Stores the name data to restore after modification.
  51   /// \param theContext whole shape that contains the selected sub-shape
  52   /// \param theValue selected subshape
  53   /// \param theGeometricalNaming treats selection with equal surfaces as one
  54   /// \param theUseNeighbors enables searching algorithm by neighbors
  55   /// \param theUseIntersections enables searching algorithm by intersection of higher level shapes
  56   SELECTOR_EXPORT bool select(const TopoDS_Shape theContext, const TopoDS_Shape theValue,
  57     const bool theGeometricalNaming = false);
  58
  59   /// Stores the name to the label and sub-labels tree
  60   SELECTOR_EXPORT bool store(const TopoDS_Shape theContext);
  61
  62   /// Restores the selected shape by the topological naming kept in the data structure
  63   /// Returns true if it can restore structure correctly
  64   SELECTOR_EXPORT bool restore(const TopoDS_Shape theContext);
  65
  66   /// Restores the selected shape by the topological name string.
  67   /// Returns not empty label of the context.
  68   SELECTOR_EXPORT TDF_Label restoreByName(
  69     std::wstring theName, const TopAbs_ShapeEnum theShapeType,
  70     Selector_NameGenerator* theNameGenerator, const bool theGeometricalNaming = false);
  71
  72   /// Returns the current sub-shape value (null if can not resolve)
  73   SELECTOR_EXPORT TopoDS_Shape value();
  74
  75   /// Returns the naming name of the selection
  76   SELECTOR_EXPORT std::wstring name(Selector_NameGenerator* theNameGenerator);
  77
  78   /// Makes the current local selection becomes all sub-shapes with same base geometry.
  79   SELECTOR_EXPORT void combineGeometrical(const TopoDS_Shape theContext);
  80
  81   /// Stores the selected shape in he tree and returns true if shape found correctly
  82   SELECTOR_EXPORT bool solve(const TopoDS_Shape theContext);
  83 };
  84
  85 #endif