src/Selector/Selector_Modify.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_Modify_H_
  21 #define Selector_Modify_H_
  22
  23 #include "Selector_Algo.h"
  24
  25 #include <TNaming_NamedShape.hxx>
  26
  27 #include <list>
  28
  29 /**\class Selector_Modify
  30  * \ingroup DataModel
  31  * \brief Kind of selection algorithm: sub-shape is modification of primitive at some
  32  * final stage.
  33  */
  34 class Selector_Modify: public Selector_Algo
  35 {
  36   TDF_Label myFinal; ///< final label of the primitive or generation, where the value is
  37   TDF_LabelList myBases; ///< initial labels that contain shapes that produce the modification
  38   int myWeakIndex; ///< weak index in case modification produces several shapes
  39   bool myRecomputeWeakIndex; ///< if the index is stored with old (unstable) order, recompute it
  40 public:
  41   /// Initializes the selection of this kind by list of named shapes where the modification results
  42   /// are presented and the selected value.
  43   SELECTOR_EXPORT bool select(NCollection_List<Handle(TNaming_NamedShape)>& theModifList,
  44     const TopoDS_Shape theContext, const TopoDS_Shape theValue);
  45
  46   /// Stores the name to the label and sub-labels tree
  47   SELECTOR_EXPORT virtual void store() override;
  48
  49   /// Restores the selected shape by the topological naming kept in the data structure
  50   /// Returns true if it can restore structure correctly
  51   SELECTOR_EXPORT virtual bool restore() override;
  52
  53   /// Restores the selected shape by the topological name string.
  54   /// Returns not empty label of the context.
  55   SELECTOR_EXPORT virtual TDF_Label restoreByName(std::wstring theName,
  56     const TopAbs_ShapeEnum theShapeType, Selector_NameGenerator* theNameGenerator) override;
  57
  58   /// Updates the current shape by the stored topological name
  59   SELECTOR_EXPORT virtual bool solve(const TopoDS_Shape& theContext) override;
  60
  61   /// Returns the naming name of the selection
  62   SELECTOR_EXPORT virtual std::wstring name(Selector_NameGenerator* theNameGenerator) override;
  63
  64 private:
  65   /// Initializes selector
  66   Selector_Modify();
  67   /// Searches the final shapes presented in all results from bases basing on modification fields
  68   void findModificationResult(TopoDS_ListOfShape& theCommon);
  69
  70   friend class Selector_Algo;
  71 };
  72
  73 #endif