src/Selector/Selector_NExplode.h

   1 // Copyright (C) 2017-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_NExplode_H_
  21 #define Selector_NExplode_H_
  22
  23 #include "Selector.h"
  24
  25 #include <TopoDS_Shape.hxx>
  26
  27 #include <memory>
  28
  29 class GeomAlgoAPI_NExplode;
  30
  31 /// \class Selector_NExplode
  32 /// \ingroup DataModel
  33 /// \brief Sort shapes by their centers of mass, using formula X*999 + Y*99 + Z*0.9.
  34 /// Algorithm is copied from GEOM module, which uses nexplode Draw command from OCCT.
  35 /// Used for getting index of sub0shape in WeakNaming algorithm.
  36 class Selector_NExplode
  37 {
  38  public:
  39    /// \brief Initializes the sorted list of shapes by the shapes list.
  40    SELECTOR_EXPORT Selector_NExplode(const TopoDS_ListOfShape& theShapes,
  41                                      const bool theOldOrder = false);
  42    /// \brief Initializes the sorted list of shapes by the context shape and type of sub-shapes.
  43    SELECTOR_EXPORT Selector_NExplode(const TopoDS_Shape& theShape,
  44                                      const TopAbs_ShapeEnum theType,
  45                                      const bool theOldOrder = false);
  46
  47    /// Returns an index (started from one) of sub-shape in the sorted list. Returns 0 if not found.
  48    SELECTOR_EXPORT int index(const TopoDS_Shape& theSubShape);
  49    /// Returns a shape by an index (started from one). Returns null if not found.
  50    /// Recompute the index if the old order was used. The value will contain the new ordered index.
  51    SELECTOR_EXPORT TopoDS_Shape shape(int& theIndex);
  52
  53 protected:
  54   std::shared_ptr<GeomAlgoAPI_NExplode> mySorted; ///< keep the ordered list of shapes
  55   bool myToBeReordered; ///< the list has to be reordered
  56 };
  57
  58 #endif