src/GeomAlgoAPI/GeomAlgoAPI_NExplode.h

   1 // Copyright (C) 2017-2019  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 /// \class GeomAlgoAPI_NExplode
  28 /// \ingroup DataAlgo
  29 /// \brief Sort shapes by their centers of mass, using formula X*999 + Y*99 + Z*0.9.
  30 /// Algorithm is copied from GEOM module, which uses nexplode Draw command from OCCT.
  31 /// Used for getting index of sub0shape in WeakNaming algorithm.
  32 class GeomAlgoAPI_NExplode
  33 {
  34  public:
  35    /// \brief Initializes the sorted list of shapes by the context shape and type of sub-shapes.
  36    GEOMALGOAPI_EXPORT GeomAlgoAPI_NExplode(
  37      const GeomShapePtr theContext, const GeomAPI_Shape::ShapeType theShapeType);
  38
  39    /// Returns an index (started from one) of sub-shape in the sorted list. Returns 0 if not found.
  40    GEOMALGOAPI_EXPORT int index(const GeomShapePtr theSubShape);
  41    /// Returns a shape by an index (started from one). Returns null if not found.
  42    GEOMALGOAPI_EXPORT GeomShapePtr shape(const int theIndex);
  43
  44 protected:
  45   ListOfShape mySorted;
  46 };
  47
  48 #endif