src/GeomAPI/GeomAPI_ShapeExplorer.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 GeomAPI_ShapeExplorer_H_
  21 #define GeomAPI_ShapeExplorer_H_
  22
  23 #include <GeomAPI.h>
  24 #include <GeomAPI_Shape.h>
  25
  26 /** \class GeomAPI_ShapeExplorer
  27  *  \ingroup DataModel
  28  *  \brief This class is used to explore subshapes on shape.
  29  */
  30 class GeomAPI_ShapeExplorer : public GeomAPI_Interface
  31 {
  32 public:
  33   /// Default constructor. Creates an empty explorer, becomes usefull after Init.
  34   GEOMAPI_EXPORT
  35   GeomAPI_ShapeExplorer();
  36
  37   /** \brief Constructs an explorer to search on theShape, for shapes of type toFind,
  38    *  that are not part of a shape toAvoid. If the shape toAvoid is equal to GeomAPI_SHape::SHAPE,
  39    *  or if it is the same as, or less complex than the shape toFind it has no effect on the search.
  40    *  \param[in] theShape shape to explore.
  41    *  \param[in] toFind shape type to find.
  42    *  \param[in] toAvoid shape type to avoid.
  43    */
  44   GEOMAPI_EXPORT
  45   GeomAPI_ShapeExplorer(const std::shared_ptr<GeomAPI_Shape>& theShape,
  46                         const GeomAPI_Shape::ShapeType toFind,
  47                         const GeomAPI_Shape::ShapeType toAvoid = GeomAPI_Shape::SHAPE);
  48
  49   /** \brief Resets this explorer. It is initialized to search on theShape, for shapes of type toFind,
  50    *  that are not part of a shape toAvoid. If the shape toAvoid is equal to GeomAPI_SHape::SHAPE,
  51    *  or if it is the same as, or less complex than the shape toFind it has no effect on the search.
  52    *  \param[in] theShape shape to explore.
  53    *  \param[in] toFind shape type to find.
  54    *  \param[in] toAvoid shape type to avoid.
  55    */
  56   GEOMAPI_EXPORT
  57   void init(const std::shared_ptr<GeomAPI_Shape>& theShape,
  58             const GeomAPI_Shape::ShapeType toFind,
  59             const GeomAPI_Shape::ShapeType toAvoid = GeomAPI_Shape::SHAPE);
  60
  61   /// \return true if there are more shapes in the exploration.
  62   GEOMAPI_EXPORT
  63   bool more() const;
  64
  65   /// Moves to the next Shape in the exploration or do nothing
  66   /// if there are no more shapes to explore.
  67   GEOMAPI_EXPORT
  68   void next();
  69
  70   /// \return the current shape in the exploration or empty pointer
  71   /// if this explorer has no more shapes to explore.
  72   GEOMAPI_EXPORT
  73   std::shared_ptr<GeomAPI_Shape> current();
  74
  75   /// Reinitialize the exploration with the original arguments.
  76   GEOMAPI_EXPORT
  77   void reinit();
  78
  79   /// \return the current depth of the exploration. 0 is the shape to explore itself.
  80   GEOMAPI_EXPORT
  81   int depth() const;
  82
  83   /// Clears the content of the explorer. It will return False on more().
  84   GEOMAPI_EXPORT
  85   void clear();
  86
  87 };
  88
  89 #endif