src/Selector/Selector_Primitive.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_Primitive_H_
  21 #define Selector_Primitive_H_
  22
  23 #include "Selector_Algo.h"
  24
  25 /**\class Selector_Primitive
  26  * \ingroup DataModel
  27  * \brief Kind of selection algorithm: exact referencing to alone shape in the data structure.
  28  */
  29 class Selector_Primitive: public Selector_Algo
  30 {
  31   TDF_Label myFinal; ///< final label of the where the value is
  32 public:
  33   /// Initializes the selection of this kind
  34   /// \param theLabel the final label with the primitive shape
  35   SELECTOR_EXPORT void select(const TDF_Label theFinalLabel);
  36
  37   /// Stores the name to the label and sub-labels tree
  38   SELECTOR_EXPORT virtual void store() override;
  39
  40   /// Restores the selected shape by the topological naming kept in the data structure
  41   /// Returns true if it can restore structure correctly
  42   SELECTOR_EXPORT virtual bool restore() override;
  43
  44   /// Restores the selected shape by the topological name string.
  45   /// Returns not empty label of the context.
  46   SELECTOR_EXPORT virtual TDF_Label restoreByName(std::wstring theName,
  47     const TopAbs_ShapeEnum theShapeType, Selector_NameGenerator* theNameGenerator) override;
  48
  49   /// Updates the current shape by the stored topological name
  50   SELECTOR_EXPORT virtual bool solve(const TopoDS_Shape& theContext) override;
  51
  52   /// Returns the naming name of the selection
  53   SELECTOR_EXPORT virtual std::wstring name(Selector_NameGenerator* theNameGenerator) override;
  54 private:
  55   /// Initializes selector
  56   Selector_Primitive();
  57
  58   friend class Selector_Algo;
  59 };
  60
  61 #endif