src/GeomAlgoAPI/GeomAlgoAPI_NExplode.h

   1 // Copyright (C) 2017-2023  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 email : webmaster.salome@opencascade.com
  18 //
  19
  20 #ifndef GeomAlgoAPI_NExplode_H_
  21 #define GeomAlgoAPI_NExplode_H_
  22
  23 #include "GeomAlgoAPI.h"
  24
  25 #include <GeomAPI_Shape.h>
  26
  27 #include <vector>
  28
  29 /// \class GeomAlgoAPI_NExplode
  30 /// \ingroup DataAlgo
  31 /// \brief Sort shapes by their centers of mass, using formula X*999 + Y*99 + Z*0.9.
  32 /// Algorithm is copied from GEOM module, which uses nexplode Draw command from OCCT.
  33 /// Used for getting index of sub0shape in WeakNaming algorithm.
  34 class GeomAlgoAPI_NExplode
  35 {
  36 public:
  37   /// Different orders of shape explosion
  38   enum ShapeOrder {
  39     ORDER_BY_HASH_VALUE,  ///< kept for compatibility
  40     ORDER_BY_MIDDLE_POINT ///< modern approach comparing middle points of shapes
  41   };
  42
  43 public:
  44    /// \brief Initializes the sorted list of shapes by the context shape and type of sub-shapes.
  45    GEOMALGOAPI_EXPORT GeomAlgoAPI_NExplode(const GeomShapePtr theContext,
  46                                            const GeomAPI_Shape::ShapeType theShapeType,
  47                                            const ShapeOrder theOrder = ORDER_BY_MIDDLE_POINT);
  48
  49    /// \brief Initializes the sorted list of shapes.
  50    GEOMALGOAPI_EXPORT GeomAlgoAPI_NExplode(const ListOfShape& theShapes,
  51                                            const ShapeOrder theOrder = ORDER_BY_MIDDLE_POINT);
  52
  53    /// Returns an index (started from one) of sub-shape in the sorted list. Returns 0 if not found.
  54    GEOMALGOAPI_EXPORT int index(const GeomShapePtr theSubShape);
  55    /// Returns a shape by an index (started from one). Returns null if not found.
  56    GEOMALGOAPI_EXPORT GeomShapePtr shape(const int theIndex);
  57
  58    /// Reorder the shapes
  59    GEOMALGOAPI_EXPORT void reorder(const ShapeOrder theNewOrder);
  60
  61 protected:
  62   std::vector<GeomShapePtr> mySorted;
  63 };
  64
  65 #endif