src/GeomAPI/GeomAPI_ShapeIterator.h

   1 // Copyright (C) 2014-2021  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 GeomAPI_ShapeIterator_H_
  21 #define GeomAPI_ShapeIterator_H_
  22
  23 #include "GeomAPI.h"
  24 #include "GeomAPI_Shape.h"
  25
  26 /// \class GeomAPI_ShapeIterator
  27 /// \ingroup DataModel
  28 /// \brief Iterates on the underlying shape underlying a given GeomAPI_Shape object,
  29 ///        providing access
  30 ///        to its component sub-shapes. Each component shape is returned as a GeomAPI_Shape with
  31 ///        an orientation, and a compound of the original values and the relative values.
  32 class GeomAPI_ShapeIterator : public GeomAPI_Interface
  33 {
  34 public:
  35   /// Default constructor. Creates an empty iterator, becomes usefull after Init.
  36   GEOMAPI_EXPORT GeomAPI_ShapeIterator();
  37
  38   /// \brief Creates an iterator on theShape sub-shapes.
  39   /// \param[in] theShape shape to iterate.
  40   GEOMAPI_EXPORT GeomAPI_ShapeIterator(const std::shared_ptr<GeomAPI_Shape> theShape);
  41
  42   /// \brief Initializes this iterator with theShape.
  43   /// \param[in] theShape shape to iterate.
  44   GEOMAPI_EXPORT void init(const std::shared_ptr<GeomAPI_Shape> theShape);
  45
  46   /// \return  true if there is another sub-shape in the shape which this iterator is scanning.
  47   GEOMAPI_EXPORT bool more() const;
  48
  49   /// Moves on to the next sub-shape in the shape which this iterator is scanning.
  50   GEOMAPI_EXPORT void next();
  51
  52   /// \return the current sub-shape in the shape which this iterator is scanning.
  53   GEOMAPI_EXPORT std::shared_ptr<GeomAPI_Shape> current();
  54 };
  55
  56 #endif